az documentdb mongocluster replica

Note

このリファレンスは、Azure CLI (バージョン 2.75.0 以降) の documentdb 拡張機能の一部です。 拡張機能は、 az documentdb mongocluster レプリカ コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

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

レプリカを管理します。

コマンド

Name 説明 型 状態
az documentdb mongocluster replica create

既存の Mongo クラスターの読み取りレプリカを作成します。

Extension Preview
az documentdb mongocluster replica list

mongo クラスターのすべてのレプリカを一覧表示します。

Extension Preview
az documentdb mongocluster replica promote

レプリカ Mongo クラスターをプライマリ ロールに昇格させます。

Extension Preview

az documentdb mongocluster replica create

プレビュー

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

既存の Mongo クラスターの読み取りレプリカを作成します。

ソース クラスターでは、"GeoReplicas" プレビュー機能が有効になっている必要があります。 レプリカは新しい mongo クラスターとしてプロビジョニングされ、その構成 (コンピューティング、ストレージ、シャーディング) をソース クラスターから継承します。 ソースと同じリージョン内のレプリカがリージョン内 AsyncReplicaとして作成されます。異なるリージョン内のレプリカは、リージョン間の GeoAsyncReplicaとして作成されます。

az documentdb mongocluster replica create --cluster-name --name
                                          --resource-group
                                          --source-cluster
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--location]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

例

クラスターのレプリカを作成します。

az documentdb mongocluster replica create -n MyReplica -g MyResourceGroup --location centralus --source-cluster MySourceCluster

必須パラメーター

--cluster-name --name -n

mongo クラスターの名前。

--resource-group -g

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

--source-cluster

レプリケート元のソース (プライマリ) Mongo クラスターの名前またはリソース ID。 名前を指定すると、現在のサブスクリプションとリソース グループが想定されます。 別のリソース グループまたはサブスクリプション内のソースの完全な ARM ID を指定します。

プロパティ 値
パラメーター グループ: Replica Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

プロパティ 値
パラメーター グループ: Resource Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: 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 documentdb mongocluster replica list

プレビュー

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

mongo クラスターのすべてのレプリカを一覧表示します。

az documentdb mongocluster replica list --resource-group
                                        --source-cluster
                                        [--max-items]
                                        [--next-token]

例

クラスターのレプリカを一覧表示します。

az documentdb mongocluster replica list --source-cluster MyCluster -g MyResourceGroup

必須パラメーター

--resource-group -g

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

--source-cluster

ソース mongo クラスターの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ 値
パラメーター グループ: Pagination Arguments
--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ 値
パラメーター グループ: Pagination Arguments
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: 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 documentdb mongocluster replica promote

プレビュー

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

レプリカ Mongo クラスターをプライマリ ロールに昇格させます。

az documentdb mongocluster replica promote --promote-option {Forced, Planned}
                                           --source-cluster
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--ids]
                                           [--mode {Switchover}]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

例

レプリカをプライマリに昇格します。

az documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced

必須パラメーター

--promote-option

操作に適用する昇格オプション。

プロパティ 値
パラメーター グループ: Body Arguments
指定可能な値: Forced, Planned
--source-cluster

このレプリカの予想されるソース (プライマリ) クラスターの名前またはリソース ID。 昇格は、レプリカの実際のソース クラスターと一致する場合にのみ続行されます。それ以外の場合、操作は失敗します。

プロパティ 値
パラメーター グループ: Replica Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--ids

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--mode

昇格操作に適用するモード。 値は省略可能で、既定値は 'Switchover' です。

プロパティ 値
パラメーター グループ: Body Arguments
指定可能な値: Switchover
--name -n

昇格するレプリカの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--yes -y

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

プロパティ 値
規定値: False
グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

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

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

--verbose

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

プロパティ 値
規定値: False