az cosmosdb mongocluster

Note

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

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

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 mongocluster create

プレビュー

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

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

az cosmosdb mongocluster create --administrator-login
                                --administrator-login-password
                                --cluster-name
                                --location
                                --resource-group
                                --server-version
                                --shard-node-count
                                --shard-node-disk-size-gb
                                --shard-node-ha {false, true}
                                --shard-node-tier
                                [--tags]

例

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

az cosmosdb mongocluster create \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--location MyLocation \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128 \
--shard-node-count 2

必須のパラメーター

--administrator-login -a

クラスターの作成時に構成する初期管理者ユーザー。

--administrator-login-password -p

クラスターの作成時に構成する初期管理者パスワード。

--cluster-name -c

Cosmos DB Mongo クラスターの名前。

--location -l

クラスターの Azure の場所。

--resource-group -g

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

--server-version

Mongo クラスターのサーバー バージョン。

規定値: 5.0

--shard-node-count

mongo クラスターのノード数。

規定値: 1

--shard-node-disk-size-gb -d

mongo クラスターのノード ディスク サイズ。

--shard-node-ha

有効にした場合、クラスターには HA があります。

指定可能な値: false, true

--shard-node-tier

Mongo クラスターのノード層。

省略可能のパラメーター

--tags

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

グローバル パラメーター

--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 mongocluster delete

プレビュー

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

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

az cosmosdb mongocluster delete --cluster-name
                                --resource-group
                                [--yes]

例

Mongo クラスター リソースを削除します。 クラスターが存在しない場合は、NoContent 応答が返されます。

az cosmosdb mongocluster delete --cluster-name MyCluster --resource-group MyResourceGroup

必須のパラメーター

--cluster-name -c

Cosmos DB Mongo クラスターの名前。

--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 mongocluster list

プレビュー

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

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

az cosmosdb mongocluster list [--resource-group]

例

リソース グループ内の Mongo クラスター リソースの一覧を一覧表示します。

az cosmosdb mongocluster list --resource-group MyResourceGroup

サブスクリプション内の Mongo クラスター リソースの一覧を一覧表示します。

az cosmosdb mongocluster list

省略可能のパラメーター

--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 mongocluster show

プレビュー

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

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

az cosmosdb mongocluster show --cluster-name
                              --resource-group

例

Mongo クラスター リソースを取得します。 ProvisioningState は、このクラスターの状態を通知します。 クラスターが存在しない場合は、NotFound 応答が返されます。

az cosmosdb mongocluster show --cluster-name MyCluster --resource-group MyResourceGroup

必須のパラメーター

--cluster-name -c

Cosmos DB Mongo クラスターの名前。

--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 mongocluster update

プレビュー

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

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

az cosmosdb mongocluster update --cluster-name
                                --resource-group
                                [--administrator-login]
                                [--administrator-login-password]
                                [--server-version]
                                [--shard-node-disk-size-gb]
                                [--shard-node-ha {false, true}]
                                [--shard-node-tier]
                                [--tags]

例

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

az cosmosdb mongocluster update \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128

必須のパラメーター

--cluster-name -c

Cosmos DB Mongo クラスターの名前。

--resource-group -g

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

省略可能のパラメーター

--administrator-login -a

クラスターの作成時に構成する初期管理者ユーザー。

--administrator-login-password -p

クラスターの作成時に構成する初期管理者パスワード。

--server-version

Mongo クラスターのサーバー バージョン。

--shard-node-disk-size-gb -d

mongo クラスターのノード ディスク サイズ。

--shard-node-ha

有効にした場合、クラスターには HA があります。

指定可能な値: false, true

--shard-node-tier

Mongo クラスターのノード層。

--tags

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

グローバル パラメーター

--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 を使います。