az cosmosdb gremlin graph

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。 Learn more about extensions.

Azure Cosmos DB の Gremlin グラフを管理します。

コマンド

名前	説明	型	状態
az cosmosdb gremlin graph create	Azure Cosmos DB Gremlin データベースの下に Gremlin グラフを作成します。	Core	GA
az cosmosdb gremlin graph delete	Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフを削除します。	Core	GA
az cosmosdb gremlin graph exists	Azure Cosmos DB Gremlin グラフが存在するかどうかを確認します。	Core	GA
az cosmosdb gremlin graph list	Azure Cosmos DB Gremlin データベースの下に Gremlin グラフを一覧表示します。	Core	GA
az cosmosdb gremlin graph restore	削除された gremlin グラフを同じアカウント内に復元します。	Core	GA
az cosmosdb gremlin graph restore (cosmosdb-preview 拡張機能)	削除された gremlin グラフを同じアカウント内に復元します。	Extension	Preview
az cosmosdb gremlin graph show	Azure Cosmos DB Gremlin データベースの下に Gremlin グラフの詳細を表示します。	Core	GA
az cosmosdb gremlin graph throughput	Azure Cosmos DB アカウントで Gremlin グラフのスループットを管理します。	Core	GA
az cosmosdb gremlin graph throughput migrate	自動スケーリングと手動プロビジョニングの間で Gremlin Graph のスループットを移行します。	Core	GA
az cosmosdb gremlin graph throughput show	Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフのスループットを取得します。	Core	GA
az cosmosdb gremlin graph throughput update	Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフのスループットを更新します。	Core	GA
az cosmosdb gremlin graph update	Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフを更新します。	Core	GA

az cosmosdb gremlin graph create

編集

Azure Cosmos DB Gremlin データベースの下に Gremlin グラフを作成します。

az cosmosdb gremlin graph create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--conflict-resolution-policy]
                                 [--idx]
                                 [--max-throughput]
                                 [--throughput]
                                 [--ttl]

例

Azure Cosmos DB Gremlin グラフを作成します。

az cosmosdb gremlin graph create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyGraph --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--name -n

Graph name.

--partition-key-path -p

パーティションキーのパス (例: '/address/zipcode')。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analytical-storage-ttl

分析ストレージが有効になっている場合の分析 TTL。

--conflict-resolution-policy -c

競合解決ポリシーでは、文字列またはファイルとして入力できます(例: --conflict-resolution-policy @policy-file.json、--conflict-resolution-policy "{"mode": "lastWriterWins"、"conflictResolutionPath": "/path"})。

--idx

インデックス作成ポリシーでは、文字列またはファイルとして入力できます。例: --idx @policy-file.json または --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/\"_etag\"/?"}]}"。

プロパティ	値
規定値:	{ "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }

--max-throughput

最大スループットリソースは、(RU/秒) にスケーリングできます。リソースが自動スケーリングが有効な場合に提供されます。最小値は 4000 (RU/秒) にすることができます。

--throughput

Gremlin グラフのスループット (RU/秒)。既定値は 400 です。グラフに専用スループットが必要でない限り、データベースに共有スループットがある場合は、このパラメーターを省略します。

--ttl

Default TTL. 値が見つからないか、"-1" に設定されている場合、項目は期限切れになりません。値が "n" に設定されている場合、アイテムは最終変更時刻の後に "n" 秒後に期限切れになります。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph delete

編集

Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフを削除します。

az cosmosdb gremlin graph delete --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--yes]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph exists

編集

Azure Cosmos DB Gremlin グラフが存在するかどうかを確認します。

az cosmosdb gremlin graph exists --account-name
                                 --database-name
                                 --name
                                 --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph list

編集

Azure Cosmos DB Gremlin データベースの下に Gremlin グラフを一覧表示します。

az cosmosdb gremlin graph list --account-name
                               --database-name
                               --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph restore

編集

削除された gremlin グラフを同じアカウント内に復元します。

az cosmosdb gremlin graph restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--disable-ttl]
                                  [--restore-timestamp]

例

削除された gremlin グラフを同じアカウント内に復元します。

az cosmosdb gremlin graph restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_graph_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

CosmosDB Gremlin データベース名の名前。

--name -n

CosmosDB Gremlin グラフ名の名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl

TTL を無効にして復元するフラグ。

使用法: --disable-ttl True 既定値: false。

--restore-timestamp -t

グラフを復元する必要があるタイムスタンプ。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph restore (cosmosdb-preview 拡張機能)

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

削除された gremlin グラフを同じアカウント内に復元します。

az cosmosdb gremlin graph restore --account-name
                                  --database-name
                                  --name
                                  --resource-group
                                  [--disable-ttl {false, true}]
                                  [--restore-timestamp]

例

削除された gremlin グラフを同じアカウント内に復元します。

az cosmosdb gremlin graph restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_graph_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

CosmosDB Gremlin データベース名の名前。

--name -n

CosmosDB Gremlin グラフ名の名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl

プレビュー

ttl を無効にして復元を有効または無効にします。

プロパティ	値
指定可能な値:	false, true

--restore-timestamp -t

グラフを復元する必要があるタイムスタンプ。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph show

編集

Azure Cosmos DB Gremlin データベースの下に Gremlin グラフの詳細を表示します。

az cosmosdb gremlin graph show --account-name
                               --database-name
                               --name
                               --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az cosmosdb gremlin graph update

編集

Azure Cosmos DB Gremlin データベースの下にある Gremlin グラフを更新します。

az cosmosdb gremlin graph update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--idx]
                                 [--ttl]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analytical-storage-ttl

分析ストレージが有効になっている場合の分析 TTL。

--idx

--ttl

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az cosmosdb gremlin graph

コマンド

az cosmosdb gremlin graph create

例

必須のパラメーター

省略可能のパラメーター

az cosmosdb gremlin graph delete

必須のパラメーター

省略可能のパラメーター

az cosmosdb gremlin graph exists

必須のパラメーター

az cosmosdb gremlin graph list

必須のパラメーター

az cosmosdb gremlin graph restore

例

必須のパラメーター

省略可能のパラメーター

az cosmosdb gremlin graph restore (cosmosdb-preview 拡張機能)

例

必須のパラメーター

省略可能のパラメーター

az cosmosdb gremlin graph show

必須のパラメーター

az cosmosdb gremlin graph update

必須のパラメーター

省略可能のパラメーター

フィードバック