az cosmosdb mongodb collection

Note

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

Azure Cosmos DB の MongoDB コレクションを管理します。

コマンド

名前	説明	型	Status
az cosmosdb mongodb collection create	Azure Cosmos DB MongoDB データベースの下に MongoDB コレクションを作成します。	コア	GA
az cosmosdb mongodb collection delete	Azure Cosmos DB MongoDB データベースの MongoDB コレクションを削除します。	コア	GA
az cosmosdb mongodb collection exists	Azure Cosmos DB MongoDB コレクションが存在するかどうかを確認します。	コア	GA
az cosmosdb mongodb collection list	Azure Cosmos DB MongoDB データベースの MongoDB コレクションを一覧表示します。	コア	GA
az cosmosdb mongodb collection merge	mongodb コレクションのパーティションをマージします。	拡張機能	プレビュー
az cosmosdb mongodb collection redistribute-partition-throughput	mongodb コレクションのパーティション スループットを再配布します。	拡張機能	プレビュー
az cosmosdb mongodb collection restore	削除された mongodb コレクションを同じアカウント内に復元します。	コア	GA
az cosmosdb mongodb collection restore (cosmosdb-preview 拡張機能)	削除された mongodb コレクションを同じアカウント内に復元します。	拡張機能	プレビュー
az cosmosdb mongodb collection retrieve-partition-throughput	mongodb コレクションのパーティション スループットを取得します。	拡張機能	プレビュー
az cosmosdb mongodb collection show	Azure Cosmos DB MongoDB データベースの MongoDB コレクションの詳細を表示します。	コア	GA
az cosmosdb mongodb collection throughput	Azure Cosmos DB アカウントで MongoDB コレクションのスループットを管理します。	コア	GA
az cosmosdb mongodb collection throughput migrate	自動スケーリングと手動プロビジョニングの間で MongoDB コレクションのスループットを移行します。	コア	GA
az cosmosdb mongodb collection throughput show	Azure Cosmos DB MongoDB データベースの MongoDB コレクションのスループットを取得します。	コア	GA
az cosmosdb mongodb collection throughput update	Azure Cosmos DB MongoDB データベースの MongoDB コレクションのスループットを更新します。	コア	GA
az cosmosdb mongodb collection update	Azure Cosmos DB MongoDB データベースの MongoDB コレクションを更新します。	コア	GA

az cosmosdb mongodb collection create

Azure Cosmos DB MongoDB データベースの下に MongoDB コレクションを作成します。

az cosmosdb mongodb collection create --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]
                                      [--max-throughput]
                                      [--shard]
                                      [--throughput]

例

Azure Cosmos DB MongoDB コレクションを作成します。

az cosmosdb mongodb collection create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyCollection --shard "ShardingKey" --idx @indexes-file.json --throughput "500"

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

省略可能のパラメーター

--analytical-storage-ttl

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

--idx

インデックスは、文字列またはファイルとして入力できます。 例: --idx または --idx @indexes-file.json "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}""

--max-throughput

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

--shard

シャーディング キー パス。

--throughput

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

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection delete

Azure Cosmos DB MongoDB データベースの MongoDB コレクションを削除します。

az cosmosdb mongodb collection delete --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--yes]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

省略可能のパラメーター

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection exists

Azure Cosmos DB MongoDB コレクションが存在するかどうかを確認します。

az cosmosdb mongodb collection exists --account-name
                                      --database-name
                                      --name
                                      --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection list

Azure Cosmos DB MongoDB データベースの MongoDB コレクションを一覧表示します。

az cosmosdb mongodb collection list --account-name
                                    --database-name
                                    --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--resource-group -g

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

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection merge

プレビュー

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

mongodb コレクションのパーティションをマージします。

az cosmosdb mongodb collection merge --account-name
                                     --database-name
                                     --name
                                     --resource-group

例

コレクション my-mongodb-collection のパーティションをマージする

az cosmosdb mongodb collection merge -g my-resource-group -a my-account -d my-db --name my-mongodb-collection

必須のパラメーター

--account-name -a

CosmosDB データベース アカウントの名前。

--database-name -d

mongoDB データベースの名前。

--name -n

mongoDB コレクションの名前。

--resource-group -g

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

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection redistribute-partition-throughput

プレビュー

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

mongodb コレクションのパーティション スループットを再配布します。

az cosmosdb mongodb collection redistribute-partition-throughput --account-name
                                                                 --database-name
                                                                 --name
                                                                 --resource-group
                                                                 [--evenly-distribute {false, true}]
                                                                 [--source-partition-info]
                                                                 [--target-partition-info]

例

mongodb コレクションのパーティション スループットをすべての物理パーティションに均等に分散する

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --evenly-distribute

mongodb コレクションのパーティション スループットをソース パーティションからターゲット パーティションに再配布します

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --target-partition-info 8=1200 6=1200' --source-partition-info 9'

必須のパラメーター

--account-name -a

CosmosDB データベース アカウントの名前。

--database-name -d

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

--name -n

CosmosDB コレクションの名前。

--resource-group -g

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

省略可能のパラメーター

--evenly-distribute

すべての物理パーティション間でスループットを均等に分散するように切り替えます。

承認された値: false, true

既定値: False

--source-partition-info

スペース区切りソース物理パーティション ID (例: 1 2)。

既定値: []

--target-partition-info

目的のターゲット物理パーティションのスループットに関する情報 (例: '0=1200 1=1200')。

既定値: []

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection restore

削除された mongodb コレクションを同じアカウント内に復元します。

az cosmosdb mongodb collection restore --account-name
                                       --database-name
                                       --name
                                       --resource-group
                                       [--restore-timestamp]

例

削除された mongodb コレクションを同じアカウント内に復元します。

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

省略可能のパラメーター

--restore-timestamp -t

コレクションを復元する必要があるタイムスタンプ。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection restore (cosmosdb-preview 拡張機能)

プレビュー

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

削除された mongodb コレクションを同じアカウント内に復元します。

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

例

削除された mongodb コレクションを同じアカウント内に復元します。

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

省略可能のパラメーター

--disable-ttl

プレビュー

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

承認された値: false, true

--restore-timestamp -t

コレクションを復元する必要があるタイムスタンプ。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection retrieve-partition-throughput

プレビュー

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

mongodb コレクションのパーティション スループットを取得します。

az cosmosdb mongodb collection retrieve-partition-throughput --account-name
                                                             --database-name
                                                             --name
                                                             --resource-group
                                                             [--all-partitions {false, true}]
                                                             [--physical-partition-ids]

例

特定の物理パーティションのコンテナー container_nameのスループットを取得する

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --physical-partition-ids 8 9

すべての物理パーティションのコンテナー container_nameのスループットを取得する

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --all-partitions

必須のパラメーター

--account-name -a

CosmosDB データベース アカウントの名前。

--database-name -d

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

--name -n

CosmosDB コンテナーの名前。

--resource-group -g

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

省略可能のパラメーター

--all-partitions

すべての物理パーティションのスループットを取得するように切り替えます。

承認された値: false, true

既定値: False

--physical-partition-ids -p

物理パーティション ID のスペース区切りリスト。

既定値: []

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection show

Azure Cosmos DB MongoDB データベースの MongoDB コレクションの詳細を表示します。

az cosmosdb mongodb collection show --account-name
                                    --database-name
                                    --name
                                    --resource-group

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb mongodb collection update

Azure Cosmos DB MongoDB データベースの MongoDB コレクションを更新します。

az cosmosdb mongodb collection update --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コレクション名。

--resource-group -g

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

省略可能のパラメーター

--analytical-storage-ttl

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

--idx

インデックスは、文字列またはファイルとして入力できます。 例: --idx または --idx @indexes-file.json "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}""

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。