Share via

az cloud-service role-instance

  • Experimental
  • Reference

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 role-instance command. Learn more about extensions.

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage role instance.

Commands

Name Description Type Status
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-instance delete

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a role instance from a cloud service.

az cloud-service role-instance delete [--cloud-service-name]
                                      [--ids]
                                      [--no-wait]
                                      [--resource-group]
                                      [--role-instance-name]
                                      [--subscription]
                                      [--yes]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--no-wait

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

Default value: False
--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance list

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the list of all role instances in a cloud service.

az cloud-service role-instance list --cloud-service-name
                                    --resource-group

Required Parameters

--cloud-service-name

Cloud service name.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance rebuild

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

az cloud-service role-instance rebuild [--cloud-service-name]
                                       [--ids]
                                       [--no-wait]
                                       [--resource-group]
                                       [--role-instance-name]
                                       [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--no-wait

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

Default value: False
--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance reimage

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

az cloud-service role-instance reimage [--cloud-service-name]
                                       [--ids]
                                       [--no-wait]
                                       [--resource-group]
                                       [--role-instance-name]
                                       [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--no-wait

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

Default value: False
--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance restart

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.

az cloud-service role-instance restart [--cloud-service-name]
                                       [--ids]
                                       [--no-wait]
                                       [--resource-group]
                                       [--role-instance-name]
                                       [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--no-wait

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

Default value: False
--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance show

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a role instance from a cloud service.

az cloud-service role-instance show [--cloud-service-name]
                                    [--ids]
                                    [--resource-group]
                                    [--role-instance-name]
                                    [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance show-instance-view

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieve information about the run-time state of a role instance in a cloud service.

az cloud-service role-instance show-instance-view [--cloud-service-name]
                                                  [--ids]
                                                  [--resource-group]
                                                  [--role-instance-name]
                                                  [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cloud-service role-instance show-remote-desktop-file

Experimental

Command group 'cloud-service' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a remote desktop file for a role instance in a cloud service.

az cloud-service role-instance show-remote-desktop-file [--cloud-service-name]
                                                        [--ids]
                                                        [--resource-group]
                                                        [--role-instance-name]
                                                        [--subscription]

Optional Parameters

--cloud-service-name

Cloud service name.

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

--resource-group -g

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

--role-instance-name

Name of the role instance.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.