次の方法で共有

az cosmosdb sql container

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.17.1 以降) の cosmosdb-preview 拡張機能の一部です。 拡張機能は、az cosmosdb sql container コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure Cosmos DB の SQL コンテナーを管理します。

コマンド

名前 説明 型 Status
az cosmosdb sql container create

Azure Cosmos DB SQL データベースの下に SQL コンテナーを作成します。

 拡張機能 GA
az cosmosdb sql container merge

SQL コンテナーのパーティションをマージします。

 拡張機能 プレビュー
az cosmosdb sql container redistribute-partition-throughput

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

 拡張機能 プレビュー
az cosmosdb sql container restore

削除された SQL コンテナーを同じアカウント内に復元します。

 拡張機能 プレビュー
az cosmosdb sql container retrieve-partition-throughput

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

 拡張機能 プレビュー
az cosmosdb sql container update

Azure Cosmos DB SQL データベースの下にある SQL コンテナーを更新します。

 拡張機能 GA

az cosmosdb sql container create

Azure Cosmos DB SQL データベースの下に SQL コンテナーを作成します。

az cosmosdb sql container create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--cep]
                                 [--conflict-resolution-policy]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--max-throughput]
                                 [--partition-key-version]
                                 [--throughput]
                                 [--ttl]
                                 [--unique-key-policy]

例

Azure Cosmos DB SQL コンテナーを作成します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コンテナー名。

--partition-key-path -p

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

--resource-group -g

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

省略可能のパラメーター

--analytical-storage-ttl -t

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

--cep

クライアント暗号化ポリシーは、文字列またはファイルとして入力できます。たとえば、--cep または --cep @policy-file.json "{ "includedPaths": [{"path": "/path1","clientEncryptionKeyId": "key1","encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256","encryptionType": "Deterministic"}],"policyFormatVersion": 2}" です。

--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\"/?" } ] }
--materialized-view-definition -m

具体化されたビュー定義。文字列またはファイルとして入力できます。たとえば、--materialized-view-definition @materializedview-definition-file.json または --materialized-view-definition -m '{ "sourceCollectionId": "MySourceCollectionName", "definition": "Standard Edition LECT * FROM root r"}'。

--max-throughput

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

--partition-key-version

パーティション キーのバージョン。

--throughput

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

--ttl

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

--unique-key-policy -u

一意のキー ポリシー。文字列またはファイルとして入力できます。たとえば、--unique-key-policy や --unique-key-policy @policy-file.json "{ "uniqueKeys": [{"paths": ["/path/to/key1"]}、{"paths": ["/path/to/key2"]}} "

グローバル パラメーター
--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 sql container merge

プレビュー

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

SQL コンテナーのパーティションをマージします。

az cosmosdb sql container merge --account-name
                                --database-name
                                --name
                                --resource-group

例

コンテナー my-container のパーティションをマージする

az cosmosdb sql container merge -g my-resource-group -a my-account -d my-db --name my-container

必須のパラメーター

--account-name -a

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

--database-name -d

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

--name -n

CosmosDB コレクションの名前。

--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 sql container redistribute-partition-throughput

プレビュー

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

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

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

例

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

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

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

az cosmosdb sql container 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 sql container restore

プレビュー

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

削除された SQL コンテナーを同じアカウント内に復元します。

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

例

削除された SQL コンテナーを同じアカウント内に復元します。

az cosmosdb sql container restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_container_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 sql container retrieve-partition-throughput

プレビュー

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

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

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

例

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

az cosmosdb sql container 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 sql container 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 sql container update

Azure Cosmos DB SQL データベースの下にある SQL コンテナーを更新します。

az cosmosdb sql container update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--analytical-storage-ttl]
                                 [--idx]
                                 [--materialized-view-definition]
                                 [--ttl]

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--database-name -d

データベース名。

--name -n

コンテナー名。

--resource-group -g

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

省略可能のパラメーター

--analytical-storage-ttl -t

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

--idx

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

--materialized-view-definition -m

具体化されたビュー定義。文字列またはファイルとして入力できます。たとえば、--materialized-view-definition @materializedview-definition-file.json または --materialized-view-definition -m '{ "sourceCollectionId": "MySourceCollectionName", "definition": "Standard Edition LECT * FROM root r"}'。

--ttl

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

グローバル パラメーター
--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 を使います。