Share via

az standby-vm-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-vm-pool command. Learn more about extensions.

Manage Standby Virtual Machine Pool.

Commands

Name Description Type Status
az standby-vm-pool create

Create a StandbyVirtualMachinePoolResource.

 Extension GA
az standby-vm-pool delete

Delete a StandbyVirtualMachinePoolResource.

 Extension GA
az standby-vm-pool list

List StandbyVirtualMachinePoolResource resources by subscription ID by resource group name.

 Extension GA
az standby-vm-pool show

Get a StandbyVirtualMachinePoolResource.

 Extension GA
az standby-vm-pool status

Get a StandbyVirtualMachinePoolRuntimeViewResource.

 Extension GA
az standby-vm-pool update

Update a StandbyVirtualMachinePoolResource.

 Extension GA
az standby-vm-pool wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az standby-vm-pool create

Create a 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]

Examples

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

Required Parameters

--name -n

Name of the standby virtual machine pool.

--resource-group -g

The resource group.

Optional Parameters

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

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--max-ready-capacity

Specifies the maximum number of virtual machines in the standby virtual machine pool.

Property Value
Parameter group: ElasticityProfile Arguments
--min-ready-capacity

Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity.

Property Value
Parameter group: ElasticityProfile Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--vm-state

Specifies the desired state of virtual machines in the pool.

Property Value
Parameter group: Properties Arguments
Accepted values: Deallocated, Hibernated, Running
--vmss-id

Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool delete

Delete a StandbyVirtualMachinePoolResource.

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

Examples

StandbyVirtualMachinePools_Delete

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the standby virtual machine pool.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

The resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool list

List StandbyVirtualMachinePoolResource resources by subscription ID by resource group name.

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

Examples

StandbyVirtualMachinePools_ListBySubscription

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--resource-group -g

The resource group.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool show

Get a StandbyVirtualMachinePoolResource.

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

Examples

StandbyVirtualMachinePools_Get

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the standby virtual machine pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

The resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool status

Get a StandbyVirtualMachinePoolRuntimeViewResource.

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

Examples

StandbyVirtualMachinePoolRuntimeViews_Status

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the standby virtual machine pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

The resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--version

The unique identifier for the runtime view. The input string should be the word 'latest', which will get the latest runtime view of the pool, otherwise the request will fail with NotFound exception.

Property Value
Parameter group: Resource Id Arguments
Default value: latest
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool update

Update a 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]

Examples

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--max-ready-capacity

Specifies the maximum number of virtual machines in the standby virtual machine pool.

Property Value
Parameter group: ElasticityProfile Arguments
--min-ready-capacity

Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity.

Property Value
Parameter group: ElasticityProfile Arguments
--name -n

Name of the standby virtual machine pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--vm-state

Specifies the desired state of virtual machines in the pool.

Property Value
Parameter group: Properties Arguments
Accepted values: Deallocated, Hibernated, Running
--vmss-id

Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az standby-vm-pool wait

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

Name of the standby virtual machine pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

The resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False