通过

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

az standby-vm-pool

Note

此参考是 Azure CLI（版本 2.70.0 或更高版本） 的备用池 扩展的一部分。 该扩展将在首次运行 az standby-vm-pool 命令时自动安装。 了解更多关于扩展的信息。

管理备用虚拟机池。

命令

名称 说明 类型 Status
az standby-vm-pool create

创建 StandbyVirtualMachinePoolResource。

 Extension GA
az standby-vm-pool delete

删除 StandbyVirtualMachinePoolResource。

 Extension GA
az standby-vm-pool list

按资源组名称按订阅 ID 列出 StandbyVirtualMachinePoolResource 资源。

 Extension GA
az standby-vm-pool show

获取 StandbyVirtualMachinePoolResource。

 Extension GA
az standby-vm-pool status

获取 StandbyVirtualMachinePoolRuntimeViewResource。

 Extension GA
az standby-vm-pool update

更新 StandbyVirtualMachinePoolResource。

 Extension GA
az standby-vm-pool wait

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

 Extension GA

az standby-vm-pool create

创建 StandbyVirtualMachinePoolResource。

az standby-vm-pool create --name
                          --resource-group
                          [--location]
                          [--max-ready-capacity]
                          [--min-ready-capacity]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--tags]
                          [--vm-state {Deallocated, Hibernated, Running}]
                          [--vmss-id]

示例

StandbyVirtualMachinePools_CreateOrUpdate

az standby-vm-pool create --resource-group rgstandbypool --name pool --max-ready-capacity 304 --min-ready-capacity 300 --vm-state Running --vmss-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss --tags "{}" --location West US --subscription 00000000-0000-0000-0000-000000000009

必需参数

--name -n

备用虚拟机池的名称。

--resource-group -g

资源组。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

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

属性 值
Parameter group: Resource Arguments
--max-ready-capacity

指定备用虚拟机池中虚拟机的最大数目。

属性 值
Parameter group: ElasticityProfile Arguments
--min-ready-capacity

指定备用虚拟机池中所需的最小虚拟机数。 MinReadyCapacity 不能超过 MaxReadyCapacity。

属性 值
Parameter group: ElasticityProfile Arguments
--no-wait

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

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

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

属性 值
Parameter group: Resource Arguments
--vm-state

指定池中虚拟机的所需状态。

属性 值
Parameter group: Properties Arguments
接受的值: Deallocated, Hibernated, Running
--vmss-id

指定池附加到的虚拟机规模集的完全限定资源 ID。

属性 值
Parameter group: Properties 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 standby-vm-pool delete

删除 StandbyVirtualMachinePoolResource。

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

示例

StandbyVirtualMachinePools_Delete

az standby-vm-pool delete --resource-group rgstandbypool --name pool --subscription 00000000-0000-0000-0000-000000000009

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

备用虚拟机池的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

资源组。

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: 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

az standby-vm-pool list

按资源组名称按订阅 ID 列出 StandbyVirtualMachinePoolResource 资源。

az standby-vm-pool list [--max-items]
                        [--next-token]
                        [--resource-group]

示例

StandbyVirtualMachinePools_ListBySubscription

az standby-vm-pool list --subscription 00000000-0000-0000-0000-000000000009 --resource-group myRG

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

属性 值
Parameter group: Pagination Arguments
--next-token

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

属性 值
Parameter group: Pagination Arguments
--resource-group -g

资源组。

全局参数
--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 standby-vm-pool show

获取 StandbyVirtualMachinePoolResource。

az standby-vm-pool show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

示例

StandbyVirtualMachinePools_Get

az standby-vm-pool show --resource-group rgstandbypool --name pool

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

备用虚拟机池的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

资源组。

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
全局参数
--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

az standby-vm-pool status

获取 StandbyVirtualMachinePoolRuntimeViewResource。

az standby-vm-pool status [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--version]

示例

StandbyVirtualMachinePoolRuntimeViews_Status

az standby-vm-pool status --resource-group rgstandbypool --name pool --version latest --subscription 00000000-0000-0000-0000-000000000009

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--name -n

备用虚拟机池的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

资源组。

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--version

运行时视图的唯一标识符。 输入字符串应为“latest”一词，它将获取池的最新运行时视图，否则请求将失败并出现 NotFound 异常。

属性 值
Parameter group: Resource Id Arguments
默认值: latest
全局参数
--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

az standby-vm-pool update

更新 StandbyVirtualMachinePoolResource。

az standby-vm-pool update [--ids]
                          [--max-ready-capacity]
                          [--min-ready-capacity]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--tags]
                          [--vm-state {Deallocated, Hibernated, Running}]
                          [--vmss-id]

示例

StandbyVirtualMachinePool_Update

az standby-vm-pool update --resource-group rgstandbypool --name pool --max-ready-capacity 304 --min-ready-capacity 300 --vm-state Running --vmss-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss --tags "{}" --location West US --subscription 00000000-0000-0000-0000-000000000009

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性 值
Parameter group: Resource Id Arguments
--max-ready-capacity

指定备用虚拟机池中虚拟机的最大数目。

属性 值
Parameter group: ElasticityProfile Arguments
--min-ready-capacity

指定备用虚拟机池中所需的最小虚拟机数。 MinReadyCapacity 不能超过 MaxReadyCapacity。

属性 值
Parameter group: ElasticityProfile Arguments
--name -n

备用虚拟机池的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--tags

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

属性 值
Parameter group: Properties Arguments
--vm-state

指定池中虚拟机的所需状态。

属性 值
Parameter group: Properties Arguments
接受的值: Deallocated, Hibernated, Running
--vmss-id

指定池附加到的虚拟机规模集的完全限定资源 ID。

属性 值
Parameter group: Properties Arguments
全局参数
--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

az standby-vm-pool wait

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

az standby-vm-pool wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

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

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

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

属性 值
Parameter group: Resource Id Arguments
--interval

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--name -n

备用虚拟机池的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

资源组。

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--timeout

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
Parameter group: Wait Condition Arguments
默认值: 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