Azure Cosmos DB の Gremlin API データベースとグラフを一覧表示または取得する PowerShell スクリプト

適用対象: Gremlin API

この PowerShell スクリプトでは、Azure Cosmos DB アカウント、Gremlin API データベース、Gremlin API グラフを一覧表示したり、特定の Azure Cosmos DB アカウント、Gremlin API データベース、Gremlin API グラフを取得したりします。

注意

Azure を操作するには、Azure Az PowerShell モジュールをお勧めします。 作業を開始するには、Azure PowerShell のインストールに関する記事を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。

前提条件

  • このサンプルには、Azure PowerShell Az 5.4.0 以降が必要です。 Get-Module -ListAvailable Az を実行して、インストールされているバージョンを確認します。 インストールする必要がある場合は、Azure PowerShell モジュールのインストールに関するページを参照してください。

  • Connect-AzAccount を実行して Azure にサインインします。

サンプル スクリプト

このスクリプトでは次の操作が実行されます。

  • Get-AzCosmosDBAccount: Azure リソース グループ内のすべての Azure Cosmos DB アカウントを一覧表示するか、特定の Azure Cosmos DB アカウントを取得します。
  • Get-AzCosmosDBGremlinDatabase: Azure Cosmos DB アカウント内のすべての Gremlin API データベースを一覧表示するか、特定の Gremlin API データベースを取得します。
  • Get-AzCosmosDBGremlinGraph: Gremlin API データベース内のすべての Gremlin API グラフを一覧表示するか、特定の Gremlin API グラフを取得します。
# Reference: Az.CosmosDB | https://docs.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

Azure リソース グループを削除する

Azure Cosmos DB アカウントを削除する場合は、Remove-AzResourceGroup PowerShell コマンドを使用して、そのリソース グループを削除できます。 このコマンドでは、Azure リソース グループとそれに含まれているすべてのリソース (Azure Cosmos DB アカウントとそのコンテナーおよびデータベースを含む) が削除されます。

Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"

次のステップ

Azure PowerShell の詳細については、Azure PowerShell のドキュメントを参照してください。