az standby-vm-pool
Note
This reference is part of the standbypool extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az standby-vm-pool command. Learn more about extensions.
Standby Virtual Machine Pool Operations.
Commands
Name | Description | Type | Status |
---|---|---|---|
az standby-vm-pool create |
Create a standby virtual machine pool. |
Extension | GA |
az standby-vm-pool delete |
Delete a standby virtual machine pool. |
Extension | GA |
az standby-vm-pool list |
List standby virtual machine pools by subscription or by resource group. |
Extension | GA |
az standby-vm-pool show |
Get a standby virtual machine pool. |
Extension | GA |
az standby-vm-pool update |
Update a standby virtual machine pool. |
Extension | GA |
az standby-vm-pool vm |
Virtual machine in standby virtual machine pool. |
Extension | GA |
az standby-vm-pool vm list |
List virtual machines in standby virtual machine pool. |
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 standby virtual machine pool.
az standby-vm-pool create --name
--resource-group
[--location]
[--max-ready-capacity]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
[--vm-state {Deallocated, Running}]
[--vmss-id]
Examples
Create standby virtual machine pool
az standby-vm-pool create --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --max-ready-capacity 20 --vm-state Running --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss
Create with subscription and resource group set with context
az standby-vm-pool create --name mypool --max-ready-capacity 20 --vm-state Running --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss
Required Parameters
Name of the standby virtual machine pool.
Name of resource group.
Optional Parameters
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Specifies maximum number of virtual machines in the standby virtual machine pool.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Specifies the desired state of virtual machines in the pool.
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az standby-vm-pool delete
Delete a standby virtual machine pool.
az standby-vm-pool delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete standby virtual machine pool
az standby-vm-pool delete --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool
Optional Parameters
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.
Name of the standby virtual machine pool.
Do not wait for the long-running operation to finish.
Name of resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az standby-vm-pool list
List standby virtual machine pools by subscription or by resource group.
az standby-vm-pool list [--max-items]
[--next-token]
[--resource-group]
Examples
List by subscription id
az standby-vm-pool list -- subscription 461fa159-654a-415f-853a-40b801021944
List by resource group
az standby-vm-pool list --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az standby-vm-pool show
Get a standby virtual machine pool.
az standby-vm-pool show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get standby virtual machine pool
az standby-vm-pool show --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool
Optional Parameters
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.
Name of the standby virtual machine pool.
Name of resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az standby-vm-pool update
Update a standby virtual machine pool.
az standby-vm-pool update [--ids]
[--max-ready-capacity]
[--name]
[--resource-group]
[--subscription]
[--tags]
[--vm-state {Deallocated, Running}]
[--vmss-id]
Examples
Update max ready capacity
az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --max-ready-capacity 3
Update virtual machine state
az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --vm-state Deallocate
Update attached virtual machine scale set
az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/testvmss
Optional Parameters
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.
Specifies maximum number of virtual machines in the standby virtual machine pool.
Name of the standby virtual machine pool.
Name of resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Specifies the desired state of virtual machines in the pool.
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of the standby virtual machine pool.
Name of resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.