Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az account alias

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
 [--acquire-policy-token]
 [--billing-scope]
 [--change-reference]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--billing-scope

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--display-name

The friendly name of the subscription.

--no-wait

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

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

Property Value
Accepted values: DevTest, Production

az account alias delete

Delete Alias.

az account alias delete --name
 [--acquire-policy-token]
 [--change-reference]

Examples

DeleteAlias

az account alias delete --name "aliasForNewSub"

Required Parameters

--name -n

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

az account alias list

List Alias Subscriptions.

az account alias list

Examples

List Alias Subscriptions

az account alias list

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.

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
 [--acquire-policy-token]
 [--change-reference]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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

Feedback

Was this page helpful?