az cloud-service
Note
This reference is part of the cloud-service extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az cloud-service command. Learn more about extensions.
This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage cloud service.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az cloud-service create |
Create a cloud service (extended support). Please note some properties can be set only during cloud service creation. |
Extension | Experimental |
| az cloud-service delete |
Delete a cloud service. |
Extension | Experimental |
| az cloud-service delete-instance |
Delete role instances in a cloud service. |
Extension | Experimental |
| az cloud-service list |
Get a list of all cloud services under a resource group. |
Extension | Experimental |
| az cloud-service list-all |
Get a list of all cloud services in the subscription, regardless of the associated resource group. |
Extension | Experimental |
| az cloud-service os-family |
Manage cloud service os family. |
Extension | Experimental |
| az cloud-service os-family list |
List all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service. |
Extension | Experimental |
| az cloud-service os-family show |
Show guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. |
Extension | Experimental |
| az cloud-service os-version |
Manage cloud service os version. |
Extension | Experimental |
| az cloud-service os-version list |
List all guest operating system versions available to be specified in the XML service configuration (.cscfg) for a cloud service. |
Extension | Experimental |
| az cloud-service os-version show |
Show guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. |
Extension | Experimental |
| az cloud-service power-off |
Power off the cloud service. Note that resources are still attached and you are getting charged for the resources. |
Extension | Experimental |
| az cloud-service rebuild |
Rebuild Role Instances. Reinstall the operating system on instances of web roles or worker roles and initialize the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances. |
Extension | Experimental |
| az cloud-service reimage |
Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. |
Extension | Experimental |
| az cloud-service restart |
Restart one or more role instances in a cloud service. |
Extension | Experimental |
| az cloud-service role |
Manage cloud service role with cloud service. |
Extension | Experimental |
| az cloud-service role-instance |
Manage role instance. |
Extension | Experimental |
| az cloud-service role-instance delete |
Delete a role instance from a cloud service. |
Extension | Experimental |
| az cloud-service role-instance list |
Get the list of all role instances in a cloud service. |
Extension | Experimental |
| az cloud-service role-instance rebuild |
The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance. |
Extension | Experimental |
| az cloud-service role-instance reimage |
The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. |
Extension | Experimental |
| az cloud-service role-instance restart |
The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. |
Extension | Experimental |
| az cloud-service role-instance show |
Get a role instance from a cloud service. |
Extension | Experimental |
| az cloud-service role-instance show-instance-view |
Retrieve information about the run-time state of a role instance in a cloud service. |
Extension | Experimental |
| az cloud-service role-instance show-remote-desktop-file |
Get a remote desktop file for a role instance in a cloud service. |
Extension | Experimental |
| az cloud-service role list |
Get a list of all roles in a cloud service. |
Extension | Experimental |
| az cloud-service role show |
Get a role from a cloud service. |
Extension | Experimental |
| az cloud-service show |
Display information about a cloud service. |
Extension | Experimental |
| az cloud-service show-instance-view |
Get the status of a cloud service. |
Extension | Experimental |
| az cloud-service start |
Start the cloud service. |
Extension | Experimental |
| az cloud-service update |
Update a cloud service. |
Extension | Experimental |
| az cloud-service update-domain |
Manage cloud service update domain with cloud service. |
Extension | Experimental |
| az cloud-service update-domain list-update-domain |
Get a list of all update domains in a cloud service. |
Extension | Experimental |
| az cloud-service update-domain show-update-domain |
Get the specified update domain of a cloud service. |
Extension | Experimental |
| az cloud-service update-domain walk-update-domain |
Update the role instances in the specified update domain. |
Extension | Experimental |
| az cloud-service wait |
Place the CLI in a waiting state until a condition of the cloud-service is met. |
Extension | Experimental |
az cloud-service create
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a cloud service (extended support). Please note some properties can be set only during cloud service creation.
az cloud-service create --cloud-service-name
--resource-group
[--configuration]
[--configuration-url]
[--extensions]
[--id]
[--lb]
[--location]
[--no-wait]
[--package-url]
[--roles]
[--secrets]
[--start-cloud-service {false, true}]
[--tags]
[--upgrade-mode {Auto, Manual, Simultaneous}]Examples
Create a cloud service with 2 roles, 2 load balancers (one has a public IP and another has a private IP), secrets and extensions.
az cloud-service create -g ResourceGroup -n CloudService --roles ContosoFrontend:Standard_D1_v2:1:Standard ContosoBackend:Standard_D1_v2:1:Standard --package-url PackageURL --configuration Config --load-balancer-configurations MyLoadBalancer:MyFe:PublicIP:: MyLoadBalancer2:MyFe2::SubnetIDd:PrivateIPID --secrets Vault0:Cert0:Cert1 Vault1:Cert2:Cert3:Cert4 --extensions "@extensions.json"Required Parameters
Name of the cloud service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Specify the XML service configuration (.cscfg) for the cloud service. Expected value: xml-string/@xml-file.
Specify a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
List of extensions for the cloud service. Expected value: json-string/@json-file. Example: [{"properties": {"type": "RDP", "autoUpgradeMinorVersion": false, "protectedSettings": "settings","publisher": "Microsoft.Windows.Azure.Extensions", "settings": "settings", "typeHandlerVersion": "1.2.1"}, "name": "RDPExtension"}].
Resource Id.
The list of load balancer configurations separated by space for the cloud service. The public IP is a mandatory field. Format: LBName:FrontendIPConfiguration:PublicIPAddress:Subnet:PrivateIP.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Do not wait for the long-running operation to finish.
Specify a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
List of roles separated by space for the cloud service. Format: RoleName:SkuName:SkuCapacity:SkuTier.
Specify certificates separated by space that should be installed onto the role instances. Format: KeyVaultName:CertificateUrl:CertificateUrl2:...:CertificateUrlN.
Indicate whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are Auto, Manual, Simultaneous. If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.
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 cloud-service delete
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a cloud service.
az cloud-service delete [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]Optional Parameters
Name of the cloud service.
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.
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.
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 cloud-service delete-instance
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete role instances in a cloud service.
az cloud-service delete-instance [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--role-instances]
[--subscription]
[--yes]Optional Parameters
Name of the cloud service.
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.
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>.
List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.
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 cloud-service list
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a list of all cloud services under a resource group.
az cloud-service list --resource-groupRequired Parameters
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 cloud-service list-all
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a list of all cloud services in the subscription, regardless of the associated resource group.
az cloud-service list-allGlobal 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 cloud-service power-off
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.
az cloud-service power-off [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]Optional Parameters
Name of the cloud service.
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.
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 cloud-service rebuild
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Rebuild Role Instances. Reinstall the operating system on instances of web roles or worker roles and initialize the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances.
az cloud-service rebuild [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--role-instances]
[--subscription]Optional Parameters
Name of the cloud service.
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.
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>.
List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.
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 cloud-service reimage
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
az cloud-service reimage [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--role-instances]
[--subscription]Optional Parameters
Name of the cloud service.
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.
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>.
List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.
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 cloud-service restart
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Restart one or more role instances in a cloud service.
az cloud-service restart [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--role-instances]
[--subscription]Optional Parameters
Name of the cloud service.
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.
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>.
List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.
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 cloud-service show
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Display information about a cloud service.
az cloud-service show [--cloud-service-name]
[--ids]
[--resource-group]
[--subscription]Optional Parameters
Name of the cloud service.
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 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 cloud-service show-instance-view
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the status of a cloud service.
az cloud-service show-instance-view [--cloud-service-name]
[--ids]
[--resource-group]
[--subscription]Optional Parameters
Name of the cloud service.
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 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 cloud-service start
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Start the cloud service.
az cloud-service start [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]Optional Parameters
Name of the cloud service.
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.
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 cloud-service update
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a cloud service.
az cloud-service update [--cloud-service-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]
[--tags]Optional Parameters
Name of the cloud service.
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.
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.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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 cloud-service wait
Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition of the cloud-service is met.
az cloud-service wait [--cloud-service-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Name of the cloud service.
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 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.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for