Share via

az cloud-service os-family

  • Experimental

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 os-family command. Learn more about extensions.

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

Manage cloud service os family.

Commands

Name Description Type Status
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-family list

Experimental

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

List all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service.

az cloud-service os-family list --location
                                [--max-items]
                                [--next-token]

Examples

List os-family

az cloud-service os-family list -l eastus

Required Parameters

--location -l

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

Optional Parameters

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

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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.

--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 os-family show

Experimental

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

Show guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service.

az cloud-service os-family show [--ids]
                                [--location]
                                [--name --os-family-name]
                                [--subscription]

Examples

Show os family

az cloud-service os-family show -n os-family -l eastus

Optional Parameters

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

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

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

Property Value
Parameter group: Resource Id Arguments
--name --os-family-name -n

Name of the OS family.

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