PowerShell script to list or get Azure Cosmos DB for Gremlin databases and graphs
APPLIES TO: Gremlin
This PowerShell script lists or gets specific Azure Cosmos DB accounts, API for Gremlin databases, and API for Gremlin graphs.
Note
We recommend that you use the Azure Az PowerShell module to interact with Azure. See Install Azure PowerShell to get started. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.
Prerequisites
This sample requires Azure PowerShell Az 5.4.0 or later. Run
Get-Module -ListAvailable Az
to see which versions are installed. If you need to install, see Install Azure PowerShell module.Run Connect-AzAccount -Environment AzureChinaCloud to sign in to Azure.
Sample script
In this script:
- Get-AzCosmosDBAccount lists all or gets a specific Azure Cosmos DB account in an Azure resource group.
- Get-AzCosmosDBGremlinDatabase lists all or gets a specific API for Gremlin database in an Azure Cosmos DB account.
- Get-AzCosmosDBGremlinGraph lists all or gets a specific API for Gremlin graph in a API for Gremlin database.
# Reference: Az.CosmosDB | https://learn.microsoft.com/powershell/module/az.cosmosdb
# --------------------------------------------------
# Purpose
# List and get operations for accounts, databases, and graphs
# --------------------------------------------------
# Variables - ***** SUBSTITUTE YOUR VALUES *****
$resourceGroupName = "myResourceGroup" # Resource Group must already exist
$accountName = "myaccount" # Must be all lower case
$databaseName = "myDatabase"
$graphName = "myGraph"
# --------------------------------------------------
Write-Host "List all accounts in a resource group"
Get-AzCosmosDBAccount -ResourceGroupName $resourceGroupName
Write-Host "Get an account in a resource group"
Get-AzCosmosDBAccount -ResourceGroupName $resourceGroupName `
-Name $accountName
Write-Host "List all databases in an account"
Get-AzCosmosDBGremlinDatabase -ResourceGroupName $resourceGroupName `
-AccountName $accountName
Write-Host "Get a database in an account"
Get-AzCosmosDBGremlinDatabase -ResourceGroupName $resourceGroupName `
-AccountName $accountName -Name $databaseName
Write-Host "List all graphs in a database"
Get-AzCosmosDBGremlinGraph -ResourceGroupName $resourceGroupName `
-AccountName $accountName -DatabaseName $databaseName
Write-Host "Get a graph in a database"
Get-AzCosmosDBGremlinGraph -ResourceGroupName $resourceGroupName `
-AccountName $accountName -DatabaseName $databaseName `
-Name $graphName
Delete Azure resource group
If you want to delete your Azure Cosmos DB account, you can use the Remove-AzResourceGroup PowerShell command to remove its resource group. This command removes the Azure resource group and all the resources in it, including Azure Cosmos DB accounts and their containers and databases.
Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"
Next steps
For more information on the Azure PowerShell, see Azure PowerShell documentation.