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

Experimental

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 --name
                        --resource-group
                        [--configuration]
                        [--configuration-url]
                        [--extensions]
                        [--id]
                        [--lb --load-balancer-configurations]
                        [--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

--cloud-service-name --name -n

Name of the cloud service.

--resource-group -g

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

Optional Parameters

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

--configuration

Specify the XML service configuration (.cscfg) for the cloud service. Expected value: xml-string/@xml-file.

--configuration-url

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.

--extensions

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"}].

Property	Value
Parameter group:	Extension Profile Arguments

--id

Resource Id.

Property	Value
Parameter group:	Network Profile Swappable Cloud Service Arguments

--lb --load-balancer-configurations

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.

Property	Value
Parameter group:	Network Profile Arguments

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property	Value
Default value:	False

--package-url

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.

--roles

List of roles separated by space for the cloud service. Format: RoleName:SkuName:SkuCapacity:SkuTier.

Property	Value
Parameter group:	Role Profile Arguments

--secrets

Specify certificates separated by space that should be installed onto the role instances. Format: KeyVaultName:CertificateUrl:CertificateUrl2:...:CertificateUrlN.

Property	Value
Parameter group:	Os Profile Arguments

--start-cloud-service

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.

Property	Value
Accepted values:	false, true

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--upgrade-mode

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.

Property	Value
Accepted values:	Auto, Manual, Simultaneous

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 cloud-service delete

Experimental

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 --name]
                        [--ids]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

--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 cloud-service delete-instance

Experimental

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 --name]
                                 [--ids]
                                 [--no-wait]
                                 [--resource-group]
                                 [--role-instances]
                                 [--subscription]
                                 [--yes]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

--role-instances

List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.

--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 cloud-service list

Experimental

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-group

Required Parameters

--resource-group -g

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

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 cloud-service list-all

Experimental

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-all

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 cloud-service power-off

Experimental

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 --name]
                           [--ids]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

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 cloud-service rebuild

Experimental

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 --name]
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--role-instances]
                         [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

--role-instances

List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.

--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 cloud-service reimage

Experimental

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 --name]
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--role-instances]
                         [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

--role-instances

List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.

--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 cloud-service restart

Experimental

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 --name]
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--role-instances]
                         [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

--role-instances

List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.

--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 cloud-service show

Experimental

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 --name]
                      [--ids]
                      [--resource-group]
                      [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--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

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 cloud-service show-instance-view

Experimental

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 --name]
                                    [--ids]
                                    [--resource-group]
                                    [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--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

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 cloud-service start

Experimental

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 --name]
                       [--ids]
                       [--no-wait]
                       [--resource-group]
                       [--subscription]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

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 cloud-service update

Experimental

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 --name]
                        [--ids]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--tags]

Optional Parameters

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

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--no-wait

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

Property	Value
Default value:	False

--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

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 cloud-service wait

Experimental

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 --name]
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--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.

--cloud-service-name --name -n

Name of the cloud service.

Property	Value
Parameter group:	Resource Id Arguments

--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

--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

--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