Share via

az account alias

  • Reference

Note

This reference is part of the account extension for the Azure CLI (version 2.38.0 or higher). The extension will automatically install the first time you run an az account alias command. Learn more about extensions.

Manage subscription alias.

Commands

Name Description Type Status
az account alias create

Create Alias Subscription.

 Extension GA
az account alias delete

Delete Alias.

 Extension GA
az account alias list

List Alias Subscriptions.

 Extension GA
az account alias show

Get Alias Subscription.

 Extension GA
az account alias wait

Place the CLI in a waiting state until a condition of the account alias is met.

 Extension GA

az account alias create

Create Alias Subscription.

az account alias create --name
                        [--billing-scope]
                        [--display-name]
                        [--no-wait]
                        [--reseller-id]
                        [--subscription-id]
                        [--workload {DevTest, Production}]

Examples

CreateAlias

az account alias create --name "aliasForNewSub" --billing-scope "/providers/Microsoft.Billing/billingAccounts/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31/billingProfiles/PE2Q-NOIT-BG7-TGB/invoiceSections/MTT4-OBS7-PJA-TGB" --display-name "Contoso MCA subscription" --workload "Production"

Required Parameters

--name -n

Alias Name.

Optional Parameters

--billing-scope

Billing scope. It determines whether the subscription is Field-Led, Partner-Led or LegacyEA.

--display-name

The friendly name of the subscription.

--no-wait

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

Default value: False
--reseller-id

Reseller ID, basically MPN Id.

--subscription-id

This parameter can be used to create alias for existing subscription ID.

--workload

The workload type of the subscription. It can be either Production or DevTest.

Accepted values: DevTest, Production
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 account alias delete

Delete Alias.

az account alias delete --name

Examples

DeleteAlias

az account alias delete --name "aliasForNewSub"

Required Parameters

--name -n

Alias 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 account alias list

List Alias Subscriptions.

az account alias list

Examples

List Alias Subscriptions

az account alias list
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 account alias show

Get Alias Subscription.

az account alias show --name

Examples

GetAlias

az account alias show --name "aliasForNewSub"

Required Parameters

--name -n

Alias 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 account alias wait

Place the CLI in a waiting state until a condition of the account alias is met.

az account alias wait --name
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--timeout]
                      [--updated]

Examples

Pause executing next line of CLI script until the account alias is successfully created.

az account alias wait --name "aliasForNewSub" --created

Required Parameters

--name -n

Alias Name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.