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

az vmware private-cloud

参考

注释

此参考是 Azure CLI（版本 2.67.0 或更高版本）的 vmware 扩展的一部分。该扩展将在首次运行 az vmware 私有云 命令时自动安装。了解更多关于扩展的相关信息。

用于管理私有云的命令。

命令

名称	说明	类型	Status
az vmware private-cloud create	创建私有云。	扩展	GA
az vmware private-cloud delete	删除私有云。	扩展	GA
az vmware private-cloud disable-cmk-encryption	从私有云禁用客户管理的密钥加密。	扩展	GA
az vmware private-cloud enable-cmk-encryption	启用客户管理的密钥加密到私有云。	扩展	GA
az vmware private-cloud identity	私有云中托管标识的命令。	扩展	GA
az vmware private-cloud identity-source	管理私有云的 vCenter 单一登录标识源。	扩展	GA
az vmware private-cloud identity-source create	创建 vCenter 单一登录私有云的标识源。	扩展	GA
az vmware private-cloud identity-source delete	删除私有云的 vCenter 单一登录标识源。	扩展	GA
az vmware private-cloud identity-source list	列出私有云的 vCenter 单一登录标识源。	扩展	GA
az vmware private-cloud identity-source show	显示私有云的 vCenter 单一登录标识源。	扩展	GA
az vmware private-cloud identity-source update	更新私有云的 vCenter 单一登录标识源。	扩展	GA
az vmware private-cloud identity-source wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA
az vmware private-cloud identity assign	在私有云中分配托管标识。	扩展	GA
az vmware private-cloud identity remove	删除私有云中的托管标识。	扩展	GA
az vmware private-cloud identity show	在私有云中显示托管标识。	扩展	GA
az vmware private-cloud list	列出私有云。	扩展	GA
az vmware private-cloud list-admin-credentials	列出私有云的管理员凭据。	扩展	GA
az vmware private-cloud rotate-nsxt-password	轮换 NSX-T 管理器密码。	扩展	GA
az vmware private-cloud rotate-vcenter-password	轮换 vCenter 密码。	扩展	GA
az vmware private-cloud show	获取私有云。	扩展	GA
az vmware private-cloud update	更新私有云。	扩展	GA
az vmware private-cloud wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az vmware private-cloud create

创建私有云。

az vmware private-cloud create --name --private-cloud-name
                               --resource-group
                               --sku
                               [--accept-eula --yes]
                               [--cluster-size]
                               [--ext-nw-blocks --extended-network-blocks]
                               [--internet {Disabled, Enabled}]
                               [--___location]
                               [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                               [--network-block]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--nsxt-password]
                               [--secondary-zone]
                               [--strategy {DualZone, SingleZone}]
                               [--tags]
                               [--vcenter-password]
                               [--virtual-network-id]
                               [--zone]

必需参数

--name --private-cloud-name -n

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--sku

SKU 的名称。例如 P3。它通常是字母+数字代码。

可选参数

--accept-eula --yes -y

在没有提示的情况下接受最终用户许可协议。

默认值: False

--cluster-size

默认管理群集的主机数。最小值为 3，最大值为 16。

--ext-nw-blocks --extended-network-blocks

其他网络数组与 networkBlock 无关。网络必须在订阅、本地和此 privateCloud networkBlock 属性中跨 VNet 唯一且不重叠。确保 CIDR 格式符合（A.B.C.D/X）。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--internet

已启用或禁用与 Internet 的连接。

接受的值: Disabled, Enabled

默认值: Disabled

--___location -l

未指定资源所在的地理位置，将使用资源组的位置。

--mi-system-assigned

启用系统分配的标识。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--network-block

地址块在订阅和本地的 VNet 中应是唯一的。确保 CIDR 格式符合 A.B.C.D/X，其中 A、B、C、D 介于 0 和 255 之间，X 介于 0 和 22 之间。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--nsxt-password

（可选）在创建私有云时设置 NSX-T 管理器密码（如果值为空时，系统会从 tty 中询问该值）。

--secondary-zone

私有云的辅助可用性区域。

--strategy

私有云的可用性策略。

接受的值: DualZone, SingleZone

--tags

资源标记支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--vcenter-password

（可选）在创建私有云时设置 vCenter 管理员密码（如果值为空）从 tty 中询问。

--virtual-network-id

虚拟网络的 Azure 资源 ID。

--zone

私有云的主要可用性区域。

全局参数

--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 vmware private-cloud delete

删除私有云。

az vmware private-cloud delete [--ids]
                               [--name --private-cloud-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]
                               [--yes]

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--name --private-cloud-name -n

私有云的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--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 vmware private-cloud disable-cmk-encryption

从私有云禁用客户管理的密钥加密。

az vmware private-cloud disable-cmk-encryption --private-cloud
                                               --resource-group
                                               [--yes]

必需参数

--private-cloud -c

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--yes

在不确认的情况下删除。

默认值: 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 vmware private-cloud enable-cmk-encryption

启用客户管理的密钥加密到私有云。

az vmware private-cloud enable-cmk-encryption --private-cloud
                                              --resource-group
                                              [--enc-kv-key-name]
                                              [--enc-kv-key-version]
                                              [--enc-kv-url]

必需参数

--private-cloud -c

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--enc-kv-key-name

加密密钥保管库密钥的名称。

--enc-kv-key-version

加密密钥保管库密钥的版本。

--enc-kv-url

加密密钥保管库的 URL。

全局参数

--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 vmware private-cloud list

列出私有云。

az vmware private-cloud list [--max-items]
                             [--next-token]
                             [--resource-group]

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--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 vmware private-cloud list-admin-credentials

列出私有云的管理员凭据。

az vmware private-cloud list-admin-credentials [--ids]
                                               [--private-cloud]
                                               [--resource-group]
                                               [--subscription]

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--private-cloud -c

私有云的名称。

--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 vmware private-cloud rotate-nsxt-password

轮换 NSX-T 管理器密码。

az vmware private-cloud rotate-nsxt-password [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--private-cloud]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

示例

轮换 NSX-T 密码

az rotate-nsxt-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--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 vmware private-cloud rotate-vcenter-password

轮换 vCenter 密码。

az vmware private-cloud rotate-vcenter-password [--ids]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--private-cloud]
                                                [--resource-group]
                                                [--subscription]
                                                [--yes]

示例

轮换 vCenter 密码。

az vmware private-cloud rotate-vcenter-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--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 vmware private-cloud show

获取私有云。

az vmware private-cloud show [--ids]
                             [--name --private-cloud-name]
                             [--resource-group]
                             [--subscription]

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--name --private-cloud-name -n

私有云的名称。

--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 vmware private-cloud update

更新私有云。

az vmware private-cloud update [--add]
                               [--cluster-size]
                               [--dns-zone-type {Private, Public}]
                               [--ext-nw-blocks --extended-network-blocks]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--hosts]
                               [--ids]
                               [--internet {Disabled, Enabled}]
                               [--name --private-cloud-name]
                               [--network-block]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--nsxt-password]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--tags]
                               [--vcenter-password]
                               [--vsan-datastore-name]

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

--cluster-size

默认管理群集的主机数。最小值为 3，最大值为 16。

--dns-zone-type

要使用的 DNS 区域的类型。

接受的值: Private, Public

--ext-nw-blocks --extended-network-blocks

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--hosts

主机支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--internet

已启用或禁用与 Internet 的连接。

接受的值: Disabled, Enabled

--name --private-cloud-name -n

私有云的名称。

--network-block

地址块在订阅和本地的 VNet 中应是唯一的。确保 CIDR 格式符合 A.B.C.D/X，其中 A、B、C、D 介于 0 和 255 之间，X 介于 0 和 22 之间。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--nsxt-password

（可选）在创建私有云时设置 NSX-T 管理器密码（如果值为空时，系统会从 tty 中询问该值）。

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

资源标记支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--vcenter-password

（可选）在创建私有云时设置 vCenter 管理员密码（如果值为空）从 tty 中询问。

--vsan-datastore-name

与群集关联的 vsan 数据存储的名称。

全局参数

--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 vmware private-cloud wait

将 CLI 置于等待状态，直到满足条件。

az vmware private-cloud wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name --private-cloud-name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name --private-cloud-name -n

私有云的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 获取完整的调试日志。