你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az cosmosdb mongocluster

注意

此参考是 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 获取完整的调试日志。