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

az standby-container-group-pool

Note

This reference is part of the standbypool extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az standby-container-group-pool command. Learn more about extensions.

管理备用容器组池。

命令

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

创建 StandbyContainerGroupPoolResource。

Extension GA
az standby-container-group-pool delete

删除 StandbyContainerGroupPoolResource。

Extension GA
az standby-container-group-pool list

按资源组的订阅 ID 列出 StandbyContainerGroupPoolResource 资源。

Extension GA
az standby-container-group-pool show

获取 StandbyContainerGroupPoolResource。

Extension GA
az standby-container-group-pool status

获取 StandbyContainerGroupPoolRuntimeViewResource。

Extension GA
az standby-container-group-pool update

更新 StandbyContainerGroupPoolResource。

Extension GA
az standby-container-group-pool wait

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

Extension GA

az standby-container-group-pool create

创建 StandbyContainerGroupPoolResource。

az standby-container-group-pool create --name
                                       --resource-group
                                       [--container-profile-id]
                                       [--location]
                                       [--max-ready-capacity]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--profile-revision]
                                       [--refill-policy {always}]
                                       [--subnet-ids]
                                       [--tags]
                                       [--zones]

示例

StandbyContainerGroupPools_CreateOrUpdate

az standby-container-group-pool create --resource-group rgstandbypool --name pool --max-ready-capacity 688 --refill-policy always --container-profile-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.ContainerInstance/containerGroupProfiles/cgProfile --profile-revision 1 --subnet-ids "[{id:/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Network/virtualNetworks/cgSubnet/subnets/cgSubnet}]" --zones "[1,2,3]" --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.

--container-profile-id

指定备用容器组的容器组配置文件 ID。

属性
Parameter group: ContainerGroupProfile Arguments
--location -l

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

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

指定备用池中备用容器组的最大数目。

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

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

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

指定容器组配置文件的修订。

属性
Parameter group: ContainerGroupProfile Arguments
--refill-policy

指定池的重新填充策略。

属性
Parameter group: ElasticityProfile Arguments
接受的值: always
--subnet-ids

指定容器组的子网 ID。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: ContainerGroupProperties Arguments
--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: Resource Arguments
--zones

指定备用容器组池的区域。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: Properties Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

Output format.

属性
默认值: 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-container-group-pool delete

删除 StandbyContainerGroupPoolResource。

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

示例

StandbyContainerGroupPools_Delete

az standby-container-group-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

Output format.

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az standby-container-group-pool list

按资源组的订阅 ID 列出 StandbyContainerGroupPoolResource 资源。

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

示例

StandbyContainerGroupPools_ListBySubscription

az standby-container-group-pool list --subscription 00000000-0000-0000-0000-000000000009 --resource-group resourceGroup

可选参数

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

Output format.

属性
默认值: 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-container-group-pool show

获取 StandbyContainerGroupPoolResource。

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

示例

StandbyContainerGroupPools_Get

az standby-container-group-pool show --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
--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

Output format.

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az standby-container-group-pool status

获取 StandbyContainerGroupPoolRuntimeViewResource。

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

示例

StandbyContainerGroupPoolRuntimeViews_Status

az standby-container-group-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

Output format.

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az standby-container-group-pool update

更新 StandbyContainerGroupPoolResource。

az standby-container-group-pool update [--container-profile-id]
                                       [--ids]
                                       [--max-ready-capacity]
                                       [--name]
                                       [--profile-revision]
                                       [--refill-policy {always}]
                                       [--resource-group]
                                       [--subnet-ids]
                                       [--subscription]
                                       [--tags]
                                       [--zones]

示例

StandbyPoolContainerGroup_Update

az standby-container-group-pool update --resource-group rgstandbypool --name pool --max-ready-capacity 688 --refill-policy always --container-profile-id /subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.ContainerInstance/containerGroupProfiles/cgProfile --profile-revision 1 --subnet-ids "[{id:/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Network/virtualNetworks/cgSubnet/subnets/cgSubnet}]" --zones "[1,2,3]" --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.

--container-profile-id

指定备用容器组的容器组配置文件 ID。

属性
Parameter group: ContainerGroupProfile Arguments
--ids

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

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

指定备用池中备用容器组的最大数目。

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

备用容器组池的名称。

属性
Parameter group: Resource Id Arguments
--profile-revision

指定容器组配置文件的修订。

属性
Parameter group: ContainerGroupProfile Arguments
--refill-policy

指定池的重新填充策略。

属性
Parameter group: ElasticityProfile Arguments
接受的值: always
--resource-group -g

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

属性
Parameter group: Resource Id Arguments
--subnet-ids

指定容器组的子网 ID。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: ContainerGroupProperties Arguments
--subscription

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

属性
Parameter group: Resource Id Arguments
--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: Properties Arguments
--zones

指定备用容器组池的区域。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
Parameter group: Properties Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

Output format.

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az standby-container-group-pool wait

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

az standby-container-group-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

Output format.

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False