次の方法で共有


az cosmosdb

Note

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

Azure Cosmos DB データベース アカウントを管理します。

コマンド

名前 説明 Status
az cosmosdb copy

コンテナー コピー ジョブを管理します。

拡張機能 プレビュー
az cosmosdb copy cancel

コンテナー コピー ジョブを取り消します。

拡張機能 プレビュー
az cosmosdb copy complete

オンライン コンテナー コピー ジョブを完了します。

拡張機能 プレビュー
az cosmosdb copy create

コンテナー コピー ジョブを作成します。

拡張機能 プレビュー
az cosmosdb copy list

コンテナー コピー ジョブを取得します。

拡張機能 プレビュー
az cosmosdb copy pause

コンテナー コピー ジョブを一時停止します。

拡張機能 プレビュー
az cosmosdb copy resume

コンテナー コピー ジョブを再開します。

拡張機能 プレビュー
az cosmosdb copy show

コンテナー コピー ジョブを取得します。

拡張機能 プレビュー
az cosmosdb create

新しい Azure Cosmos DB データベース アカウントを作成します。

拡張機能 プレビュー
az cosmosdb dts

cosmosdb を使用してデータ転送ジョブを管理します。

拡張機能 プレビューと非推奨
az cosmosdb dts cancel

データ転送ジョブを取り消します。

拡張機能 プレビューと非推奨
az cosmosdb dts copy

データ転送コピー ジョブを作成します。

拡張機能 プレビューと非推奨
az cosmosdb dts list

データ転送ジョブの一覧を取得します。

拡張機能 プレビューと非推奨
az cosmosdb dts pause

データ転送ジョブを一時停止します。

拡張機能 プレビューと非推奨
az cosmosdb dts resume

データ転送ジョブを再開します。

拡張機能 プレビューと非推奨
az cosmosdb dts show

データ転送ジョブを取得します。

拡張機能 プレビューと非推奨
az cosmosdb gremlin

Azure Cosmos DB アカウントの Gremlin リソースを管理します。

拡張機能 GA
az cosmosdb gremlin database

Azure Cosmos DB の Gremlin データベースを管理します。

拡張機能 GA
az cosmosdb gremlin database restore

削除された gremlin データベースを同じアカウント内に復元します。

拡張機能 プレビュー
az cosmosdb gremlin graph

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

拡張機能 GA
az cosmosdb gremlin graph restore

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

拡張機能 プレビュー
az cosmosdb gremlin restorable-database

Azure Cosmos DB アカウントで復元可能なさまざまなバージョンの gremlin データベースを管理します。

拡張機能 プレビュー
az cosmosdb gremlin restorable-database list

特定の復元可能なアカウントで作成、変更、削除されたすべての gremlin データベースのすべてのバージョンを一覧表示します。

拡張機能 プレビュー
az cosmosdb gremlin restorable-graph

Azure Cosmos DB アカウントのデータベースで復元可能なさまざまなバージョンの gremlin グラフを管理します。

拡張機能 プレビュー
az cosmosdb gremlin restorable-graph list

特定のデータベースと復元可能なアカウントで作成、変更、削除されたすべての gremlin グラフのすべてのバージョンを一覧表示します。

拡張機能 プレビュー
az cosmosdb gremlin restorable-resource

特定のタイムスタンプとリージョンで、特定のアカウントで復元できるデータベースとそのグラフを管理します。

拡張機能 プレビュー
az cosmosdb gremlin restorable-resource list

特定のタイムスタンプとリージョンで特定のアカウントに復元できるすべてのデータベースとそのグラフを一覧表示します。

拡張機能 プレビュー
az cosmosdb gremlin retrieve-latest-backup-time

特定のリージョンの特定の gremlin グラフの最新の復元可能なタイムスタンプを取得します。

拡張機能 プレビュー
az cosmosdb list

Azure Cosmos DB データベース アカウントを一覧表示します。

拡張機能 GA
az cosmosdb mongocluster

Mongo クラスター。

拡張機能 プレビュー
az cosmosdb mongocluster create

Mongo クラスターを作成します。

拡張機能 プレビュー
az cosmosdb mongocluster delete

Mongo クラスター リソースを削除します。

拡張機能 プレビュー
az cosmosdb mongocluster firewall

Mongo クラスターファイアウォール。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule

Mongo クラスターのファイアウォール規則。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule create

Mongo クラスターのファイアウォール規則を作成します。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule delete

Mongo クラスターのファイアウォール規則を削除します。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule list

Mongo クラスターのファイアウォール規則を一覧表示します。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule show

Mongo クラスターのファイアウォール規則を取得します。

拡張機能 プレビュー
az cosmosdb mongocluster firewall rule update

Mongo クラスターのファイアウォール規則を作成します。

拡張機能 プレビュー
az cosmosdb mongocluster list

Mongo クラスター リソースを一覧表示します。

拡張機能 プレビュー
az cosmosdb mongocluster show

Mongo クラスター リソースを取得します。

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

Mongo クラスターを更新します。

拡張機能 プレビュー
az cosmosdb mongodb

Azure Cosmos DB アカウントの MongoDB リソースを管理します。

拡張機能 GA
az cosmosdb mongodb collection

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

拡張機能 GA
az cosmosdb mongodb collection merge

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

拡張機能 プレビュー
az cosmosdb mongodb collection redistribute-partition-throughput

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

拡張機能 プレビュー
az cosmosdb mongodb collection restore

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

拡張機能 プレビュー
az cosmosdb mongodb collection retrieve-partition-throughput

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

拡張機能 プレビュー
az cosmosdb mongodb database

Azure Cosmos DB の MongoDB データベースを管理します。

拡張機能 GA
az cosmosdb mongodb database merge

mongodb データベースのパーティションをマージします。

拡張機能 プレビュー
az cosmosdb mongodb database restore

削除された mongodb データベースを同じアカウント内に復元します。

拡張機能 プレビュー
az cosmosdb mongodb restorable-collection

Azure Cosmos DB アカウントのデータベースで復元できるさまざまなバージョンの mongodb コレクションを管理します。

拡張機能 プレビュー
az cosmosdb mongodb restorable-collection list

指定されたデータベースと復元可能なアカウントで作成、変更、削除されたすべての mongodb コレクションのすべてのバージョンを一覧表示します。

拡張機能 プレビュー
az cosmosdb mongodb role

Azure Cosmos DB Mongo ロール リソースを管理します。

拡張機能 GA
az cosmosdb mongodb role definition

Azure Cosmos DB Mongo ロールの定義を管理します。

拡張機能 GA
az cosmosdb mongodb role definition create

Azure Cosmos DB アカウントの下に Mongo DB ロール定義を作成します。

拡張機能 GA
az cosmosdb mongodb role definition delete

Azure Cosmos DB アカウントで CosmosDb MongoDb ロール定義を削除します。

拡張機能 GA
az cosmosdb mongodb role definition exists

Azure Cosmos DB MongoDb ロール定義が存在するかどうかを確認します。

拡張機能 GA
az cosmosdb mongodb role definition list

Azure Cosmos DB アカウントのすべての MongoDb ロール定義を一覧表示します。

拡張機能 GA
az cosmosdb mongodb role definition show

Azure Cosmos DB アカウントの MongoDb ロール定義のプロパティを表示します。

拡張機能 GA
az cosmosdb mongodb role definition update

Azure Cosmos DB アカウントで MongoDb ロール定義を更新します。

拡張機能 GA
az cosmosdb mongodb user

Azure Cosmos DB Mongo ユーザー リソースを管理します。

拡張機能 GA
az cosmosdb mongodb user definition

Azure Cosmos DB Mongo ユーザー定義を管理します。

拡張機能 GA
az cosmosdb mongodb user definition create

Azure Cosmos DB アカウントで Mongo DB ユーザー定義を作成します。

拡張機能 GA
az cosmosdb mongodb user definition delete

Azure Cosmos DB アカウントで CosmosDb MongoDb ユーザー定義を削除します。

拡張機能 GA
az cosmosdb mongodb user definition exists

Azure Cosmos DB MongoDb ユーザー定義が存在するかどうかを確認します。

拡張機能 GA
az cosmosdb mongodb user definition list

Azure Cosmos DB アカウントのすべての MongoDb ユーザー定義を一覧表示します。

拡張機能 GA
az cosmosdb mongodb user definition show

Azure Cosmos DB アカウントの MongoDb ユーザー定義のプロパティを表示します。

拡張機能 GA
az cosmosdb mongodb user definition update

Azure Cosmos DB アカウントで MongoDb ユーザー定義を更新します。

拡張機能 GA
az cosmosdb restorable-database-account

復元可能な Azure Cosmos DB アカウントを管理します。

拡張機能 GA
az cosmosdb restorable-database-account list

復元できるすべてのデータベース アカウントを一覧表示します。

拡張機能 GA
az cosmosdb restorable-database-account show

復元できるデータベース アカウントの詳細を表示します。

拡張機能 GA
az cosmosdb restore

既存のデータベース アカウントから復元して、新しい Azure Cosmos DB データベース アカウントを作成します。

拡張機能 プレビュー
az cosmosdb service

サービスに対して操作を実行するコマンド。

拡張機能 プレビュー
az cosmosdb service create

cosmosdb サービス リソースを作成します。

拡張機能 プレビュー
az cosmosdb service delete

指定された cosmosdb サービス リソースを削除します。

拡張機能 プレビュー
az cosmosdb service list

アカウントのすべての cosmosdb サービス リソースを一覧表示します。

拡張機能 プレビュー
az cosmosdb service show

アカウントで cosmosdb サービス リソースを取得します。

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

cosmosdb サービス リソースを更新します。

拡張機能 プレビュー
az cosmosdb show

Azure Cosmos DB データベース アカウントの詳細を取得します。

拡張機能 GA
az cosmosdb sql

Azure Cosmos DB アカウントの SQL リソースを管理します。

拡張機能 GA
az cosmosdb sql container

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

拡張機能 GA
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 database

Azure Cosmos DB の SQL データベースを管理します。

拡張機能 GA
az cosmosdb sql database merge

SQL データベースのパーティションをマージします。

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

削除された SQL データベースを同じアカウント内に復元します。

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

Azure Cosmos DB アカウントのデータベースで復元可能なさまざまなバージョンの SQL コンテナーを管理します。

拡張機能 プレビュー
az cosmosdb sql restorable-container list

特定のデータベースと復元可能なアカウントで作成、変更、削除されたすべての SQL コンテナーのすべてのバージョンを一覧表示します。

拡張機能 プレビュー
az cosmosdb table

Azure Cosmos DB アカウントの Table リソースを管理します。

拡張機能 GA
az cosmosdb table restorable-resource

特定のタイムスタンプとリージョンで、特定のアカウントで復元できるテーブルを管理します。

拡張機能 プレビュー
az cosmosdb table restorable-resource list

特定のタイムスタンプとリージョンで、特定のアカウントで復元できるすべてのテーブルを一覧表示します。

拡張機能 プレビュー
az cosmosdb table restorable-table

Azure Cosmos DB アカウントで復元可能なさまざまなバージョンのテーブルを管理します。

拡張機能 プレビュー
az cosmosdb table restorable-table list

特定の復元可能なアカウントで作成、変更、削除されたすべてのテーブルのすべてのバージョンを一覧表示します。

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

同じアカウント内の削除されたテーブルを復元します。

拡張機能 プレビュー
az cosmosdb table retrieve-latest-backup-time

特定のリージョン内の特定のテーブルの最新の復元可能なタイムスタンプを取得します。

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

Azure Cosmos DB データベース アカウントを更新します。

拡張機能 GA

az cosmosdb create

プレビュー

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

新しい Azure Cosmos DB データベース アカウントを作成します。

az cosmosdb create --name
                   --resource-group
                   [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--assign-identity]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--databases-to-restore]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--default-priority-level {High, Low}]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-free-tier {false, true}]
                   [--enable-materialized-views {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-pbe {false, true}]
                   [--enable-prpp-autoscale {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--gremlin-databases-to-restore]
                   [--ip-range-filter]
                   [--is-restore-request {false, true}]
                   [--key-uri]
                   [--kind {GlobalDocumentDB, MongoDB, Parse}]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--restore-source]
                   [--restore-timestamp]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--tables-to-restore]
                   [--tags]
                   [--virtual-network-rules]

DB データベース アカウント。 (自動生成)

az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

2 つのリージョンを持つ新しい Azure Cosmos DB データベース アカウントを作成します。 英国南部はゾーン冗長です。

az cosmosdb create -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName

特定の場所にある既存のアカウントから復元して、新しい Azure Cosmos DB データベース アカウントを作成する

az cosmosdb create -n restoredaccount -g mygroup --is-restore-request true --restore-source /subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d056a4f8-044a-436f-80c8-cd3edbc94c68 --restore-timestamp 2020-07-13T16:03:41+0000 --locations regionName=westus failoverPriority=0 isZoneRedundant=False

具体化されたビューと cassandra 機能が有効になっている新しい Azure Cosmos DB データベース アカウントを作成します。

az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --enable-materialized-views true --capabilities EnableCassandra CassandraEnableMaterializedViews

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--analytical-storage-schema-type --as-schema

分析ストレージのスキーマの種類。

承認された値: FullFidelity, WellDefined
--assign-identity

システム割り当て ID またはユーザー割り当て ID をスペースで区切って割り当てます。 システム割り当て ID を参照するには、'[system]' を使用します。

--backup-interval

バックアップが実行される頻度 (分単位) (定期モード バックアップがあるアカウントのみ)。

--backup-policy-type

作成するアカウントのバックアップ ポリシーの種類。

承認された値: Continuous, Periodic
--backup-redundancy

バックアップ ストレージ アカウントの冗長性の種類。

承認された値: Geo, Local, Zone
--backup-retention

各バックアップが保持される時間 (時間単位)。

--capabilities

Cosmos DB データベース アカウントにカスタム機能を設定します。

--continuous-tier

継続的バックアップのレベル。

承認された値: Continuous30Days, Continuous7Days
--databases-to-restore
プレビュー

復元するデータベースとそのコレクション名を追加します。

使用法: --databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]。

--default-consistency-level

Cosmos DB データベース アカウントの既定の整合性レベル。

承認された値: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong
--default-identity

CMK 関連機能でキー コンテナーにアクセスするためのプライマリ ID。 たとえば、'FirstPartyIdentity'、'SystemAssignedIdentity' などです。

--default-priority-level
プレビュー

要求の既定の優先度レベル (指定されていない場合)。

承認された値: High, Low
--disable-key-based-metadata-write-access

アカウント キーを使用して、メタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にします。

承認された値: false, true
--enable-analytical-storage

アカウントでログ ストレージを有効にするフラグ。

承認された値: false, true
--enable-automatic-failover

障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。

承認された値: false, true
--enable-burst-capacity
プレビュー

アカウントでバースト容量を有効にするフラグ。

承認された値: false, true
--enable-free-tier
プレビュー

有効にした場合、アカウントは Free レベルです。

承認された値: false, true
--enable-materialized-views --enable-mv
プレビュー

アカウントで MaterializedViews を有効にするフラグ。

承認された値: false, true
--enable-multiple-write-locations

複数の書き込み場所を有効にします。

承認された値: false, true
--enable-partition-merge

アカウントでパーティションのマージを有効にするフラグ。

承認された値: false, true
--enable-pbe --enable-priority-based-execution
プレビュー

アカウントでの優先順位に基づく実行を有効にするフラグ。

承認された値: false, true
--enable-prpp-autoscale
プレビュー

PerRegionPerPartitionAutoscale を有効または無効にします。

承認された値: false, true
--enable-virtual-network

Cosmos DB データベース アカウントで仮想ネットワークを有効にします。

承認された値: false, true
--gremlin-databases-to-restore
プレビュー

復元する gremlin データベースとそのグラフ名を追加します。

使用法: --gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--ip-range-filter

ファイアウォールのサポート。 特定のデータベース アカウントのクライアント IP の許可リストとして追加する一連の IP アドレスまたは IP アドレス範囲を CIDR 形式で指定する必要があります。 IP アドレス/範囲はコンマで区切る必要があり、スペースを含めることはできません。

--is-restore-request -r
プレビュー

既存または削除されたアカウントから復元します。

承認された値: false, true
--key-uri

キー コンテナーの URI。

--kind

作成する Cosmos DB データベース アカウントの種類。

承認された値: GlobalDocumentDB, MongoDB, Parse
既定値: GlobalDocumentDB
--locations

Cosmos DB データベース アカウントに場所を追加します。

使用法: --locations KEY=VALUE [KEY=VALUE ...]必須キー: regionName、failoverPriority 省略可能なキー: isZoneRedundant Default: 指定したリソース グループの場所にある単一リージョン アカウント。 フェールオーバーの優先順位の値は、書き込みリージョンでは 0、読み取りリージョンでは 0 より大きい値です。 フェールオーバーの優先度の値は、一意であり、リージョンの合計数より小さい必要があります。 複数の引数を使用して、複数の場所を --locations 指定できます。

--max-interval

有界整合性制約の一貫性と併用すると、この値は許容される古さの期間を秒単位で示します。 この値の許容範囲は、1 ~ 100 です。

既定値: 5
--max-staleness-prefix

有界整合性制約の一貫性と併用すると、この値は許容される古い要求の数を示します。 この値に使用できる範囲は 1 ~ 2,147,483,647 です。

既定値: 100
--network-acl-bypass

ネットワーク ACL バイパスを有効または無効にするフラグ。

承認された値: AzureServices, None
--network-acl-bypass-resource-ids -i

ネットワーク ACL バイパスを許可するリソース ID の一覧。

--public-network-access -p

サーバーのパブリック ネットワーク アクセスを有効、無効、または SecuredByPerimeter に設定します。

承認された値: DISABLED, ENABLED, SECUREDBYPERIMETER
--restore-source
プレビュー

アカウントを復元する必要があるソース アカウントの restorable-database-account ID。 --is-restore-request が true に設定されている場合は必須です。

--restore-timestamp
プレビュー

アカウントを復元する必要があるタイムスタンプ。 --is-restore-request が true に設定されている場合は必須です。

--server-version

MongoDB アカウントに対してのみ有効です。

承認された値: 3.2, 3.6, 4.0, 4.2
--tables-to-restore
プレビュー

復元するテーブル名を追加します。

使用法: --tables-to-restore tables=table1 [table2 ...]。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--virtual-network-rules

ACL は仮想ネットワーク用です。

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

Azure Cosmos DB データベース アカウントを一覧表示します。

az cosmosdb list [--resource-group]

省略可能のパラメーター

--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 restore

プレビュー

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

既存のデータベース アカウントから復元して、新しい Azure Cosmos DB データベース アカウントを作成します。

az cosmosdb restore --account-name
                    --location
                    --resource-group
                    --restore-timestamp
                    --target-database-account-name
                    [--assign-identity]
                    [--databases-to-restore]
                    [--default-identity]
                    [--disable-ttl {false, true}]
                    [--gremlin-databases-to-restore]
                    [--public-network-access {DISABLED, ENABLED}]
                    [--source-backup-location]
                    [--tables-to-restore]

既存のデータベース アカウントから復元して、新しい Azure Cosmos DB データベース アカウントを作成します。

az cosmosdb restore --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 -g MyResourceGroup --location westus

選択したデータベースとコレクションのみを既存のデータベース アカウントから復元して、新しい Azure Cosmos DB Sql または MongoDB データベース アカウントを作成します。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --databases-to-restore name=MyDB1 collections=collection1 collection2 --databases-to-restore name=MyDB2 collections=collection3 collection4

選択したデータベースまたはグラフのみを既存のデータベース アカウントから復元して、新しい Azure Cosmos DB Gremlin データベース アカウントを作成します。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --gremlin-databases-to-restore name=graphdb1 graphs=graph1 graph2

選択したテーブルのみを既存のデータベース アカウントから復元して、新しい Azure Cosmos DB テーブル データベース アカウントを作成します。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --tables-to-restore table1,table2

必須のパラメーター

--account-name -a

復元のソース Cosmos DB データベース アカウントの名前。

--location -l

これは、復元されたアカウントの書き込みリージョンです。 これは、source_backup_locationが指定されていない場合にバックアップが配置されるソース アカウントの場所でもあります。

--resource-group -g

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

--restore-timestamp -t

アカウントを復元する必要があるタイムスタンプ。

--target-database-account-name -n

復元後の新しいターゲット Cosmos DB データベース アカウントの名前。

省略可能のパラメーター

--assign-identity

システム割り当て ID またはユーザー割り当て ID をスペースで区切って割り当てます。 システム割り当て ID を参照するには、'[system]' を使用します。

--databases-to-restore

復元するデータベースとそのコレクション名を追加します。

使用法: --databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]複数の引数を使用して、複数のデータベースを --databases-to-restore 指定できます。

--default-identity

CMK 関連機能でキー コンテナーにアクセスするためのプライマリ ID。 たとえば、'FirstPartyIdentity'、'SystemAssignedIdentity' などです。

--disable-ttl
プレビュー

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

承認された値: false, true
--gremlin-databases-to-restore
プレビュー

復元する gremlin データベースとそのグラフ名を追加します。

使用法: --gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--public-network-access -p

サーバーのパブリック ネットワーク アクセスを [有効] または [無効] に設定します。

承認された値: DISABLED, ENABLED
--source-backup-location
プレビュー

これは、バックアップが配置されているソース アカウントの場所です。 ソースとターゲットが異なる場所にある場合は、この値を指定します。

--tables-to-restore
プレビュー

復元するテーブル名を追加します。

使用法: --tables-to-restore table1 [table2 ...]。

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

Azure Cosmos DB データベース アカウントの詳細を取得します。

az cosmosdb show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

Azure Cosmos DB データベース アカウントの詳細を取得します。 (自動生成)

az cosmosdb show --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

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

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_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 update

Azure Cosmos DB データベース アカウントを更新します。

az cosmosdb update [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--default-priority-level {High, Low}]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-materialized-views {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-pbe {false, true}]
                   [--enable-prpp-autoscale {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--ids]
                   [--ip-range-filter]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--name]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--resource-group]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--subscription]
                   [--tags]
                   [--virtual-network-rules]

Azure Cosmos DB データベース アカウントを更新します。 (自動生成)

az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

具体化されたビューを有効にするために、Azure Cosmos DB データベース アカウントを更新します。

az cosmosdb update --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --enable-materialized-views true

省略可能のパラメーター

--analytical-storage-schema-type --as-schema

分析ストレージのスキーマの種類。

承認された値: FullFidelity, WellDefined
--backup-interval

バックアップが実行される頻度 (分単位) (定期モード バックアップがあるアカウントのみ)。

--backup-policy-type

作成するアカウントのバックアップ ポリシーの種類。

承認された値: Continuous, Periodic
--backup-redundancy

バックアップ ストレージ アカウントの冗長性の種類。

承認された値: Geo, Local, Zone
--backup-retention

各バックアップが保持される時間 (時間単位)。

--capabilities

Cosmos DB データベース アカウントにカスタム機能を設定します。

--continuous-tier

継続的バックアップのレベル。

承認された値: Continuous30Days, Continuous7Days
--default-consistency-level

Cosmos DB データベース アカウントの既定の整合性レベル。

承認された値: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong
--default-identity

CMK 関連機能でキー コンテナーにアクセスするためのプライマリ ID。 たとえば、'FirstPartyIdentity'、'SystemAssignedIdentity' などです。

--default-priority-level
プレビュー

要求の既定の優先度レベル (指定されていない場合)。

承認された値: High, Low
--disable-key-based-metadata-write-access

アカウント キーを使用して、メタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にします。

承認された値: false, true
--enable-analytical-storage

アカウントでログ ストレージを有効にするフラグ。

承認された値: false, true
--enable-automatic-failover

障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。

承認された値: false, true
--enable-burst-capacity
プレビュー

アカウントでバースト容量を有効にするフラグ。

承認された値: false, true
--enable-materialized-views --enable-mv
プレビュー

アカウントで MaterializedViews を有効にするフラグ。

承認された値: false, true
--enable-multiple-write-locations

複数の書き込み場所を有効にします。

承認された値: false, true
--enable-partition-merge

アカウントでパーティションのマージを有効にするフラグ。

承認された値: false, true
--enable-pbe --enable-priority-based-execution
プレビュー

アカウントでの優先順位に基づく実行を有効にするフラグ。

承認された値: false, true
--enable-prpp-autoscale
プレビュー

PerRegionPerPartitionAutoscale を有効または無効にします。

承認された値: false, true
--enable-virtual-network

Cosmos DB データベース アカウントで仮想ネットワークを有効にします。

承認された値: false, true
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--ip-range-filter

ファイアウォールのサポート。 特定のデータベース アカウントのクライアント IP の許可リストとして追加する一連の IP アドレスまたは IP アドレス範囲を CIDR 形式で指定する必要があります。 IP アドレス/範囲はコンマで区切る必要があり、スペースを含めることはできません。

--locations

Cosmos DB データベース アカウントに場所を追加します。

使用法: --locations KEY=VALUE [KEY=VALUE ...]必須キー: regionName、failoverPriority 省略可能なキー: isZoneRedundant Default: 指定したリソース グループの場所にある単一リージョン アカウント。 フェールオーバーの優先順位の値は、書き込みリージョンでは 0、読み取りリージョンでは 0 より大きい値です。 フェールオーバーの優先度の値は、一意であり、リージョンの合計数より小さい必要があります。 複数の引数を使用して、複数の場所を --locations 指定できます。

--max-interval

有界整合性制約の一貫性と併用すると、この値は許容される古さの期間を秒単位で示します。 この値の許容範囲は、1 ~ 100 です。

--max-staleness-prefix

有界整合性制約の一貫性と併用すると、この値は許容される古い要求の数を示します。 この値に使用できる範囲は 1 ~ 2,147,483,647 です。

--name -n

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

--network-acl-bypass

ネットワーク ACL バイパスを有効または無効にするフラグ。

承認された値: AzureServices, None
--network-acl-bypass-resource-ids -i

ネットワーク ACL バイパスを許可するリソース ID の一覧。

--public-network-access -p

サーバーのパブリック ネットワーク アクセスを有効、無効、または SecuredByPerimeter に設定します。

承認された値: DISABLED, ENABLED, SECUREDBYPERIMETER
--resource-group -g

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

--server-version

MongoDB アカウントに対してのみ有効です。

承認された値: 3.2, 3.6, 4.0, 4.2
--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--virtual-network-rules

ACL は仮想ネットワーク用です。

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