az large-instance
Note
This reference is part of the azurelargeinstance extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az large-instance command. Learn more about extensions.
Handle Operations for Compute Azure Large Instances.
Commands
Name | Description | Type | Status |
---|---|---|---|
az large-instance list |
Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance. |
Extension | GA |
az large-instance restart |
The operation to restart an Azure Large Instance (only for compute instances). |
Extension | GA |
az large-instance show |
Get an Azure Large Instance for the specified subscription, resource group,. |
Extension | GA |
az large-instance shutdown |
The operation to shutdown an Azure Large Instance (only for compute instances). |
Extension | GA |
az large-instance start |
The operation to start an Azure Large Instance (only for compute instances). |
Extension | GA |
az large-instance update |
Update the Tags field of an Azure Large Instance for the specified. |
Extension | GA |
az large-instance list
Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance.
az large-instance list [--max-items]
[--next-token]
[--resource-group]
Examples
To list Azure Large Instances in a subscription
az large-instance list --subscription $SUBSCRIPTION_ID
To list Azure Large Instances in a specific subscription and resource group
az large-instance list --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP
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. You can configure the default group using az configure --defaults group=<name>
.
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 large-instance restart
The operation to restart an Azure Large Instance (only for compute instances).
az large-instance restart [--force-state {active, inactive}]
[--ids]
[--instance-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
To restart an Azure Large Instance
az large-instance restart --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --instance-name $INSTANCE_NAME
Optional Parameters
Whether to force restart by shutting all processes.
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 AzureLargeInstance.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 large-instance show
Get an Azure Large Instance for the specified subscription, resource group,.
And instance name.
az large-instance show [--ids]
[--instance-name]
[--resource-group]
[--subscription]
Examples
To show details about an Azure Large Instance
az large-instance show --subscription $SUBSCRIPTION_ID --instance-name $INSTANCE_NAME --resource-group $RESOURCE_GROUP
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 AzureLargeInstance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 large-instance shutdown
The operation to shutdown an Azure Large Instance (only for compute instances).
az large-instance shutdown [--ids]
[--instance-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
To shutdown an Azure Large Instance
az large-instance shutdown --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --instance-name $INSTANCE_NAME
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 AzureLargeInstance.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 large-instance start
The operation to start an Azure Large Instance (only for compute instances).
az large-instance start [--ids]
[--instance-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
To start an Azure Large Instance
az large-instance start --subscription $SUBSCRIPTION_ID --resource-group $RESOURCE_GROUP --instance-name $INSTANCE_NAME
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 AzureLargeInstance.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 large-instance update
Update the Tags field of an Azure Large Instance for the specified.
Subscription, resource group, and instance name.
az large-instance update [--ids]
[--instance-name]
[--resource-group]
[--subscription]
[--tags]
Examples
To add an Azure Large Instance tag
az large-instance update --instance-name=$INSTANCE_NAME --resource-group=$RESOURCE_GROUP --tags newKey=value
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 AzureLargeInstance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
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.