Edit

Share via


Get-AzSubscriptionAlias

Get Alias Subscription.

Syntax

List (Default)

Get-AzSubscriptionAlias
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzSubscriptionAlias
    -AliasName <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzSubscriptionAlias
    -InputObject <ISubscriptionIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get Alias Subscription.

Examples

Example 1: List Alias Subscription.

Get-AzSubscriptionAlias
AliasName          SubscriptionId                       ProvisioningState
---------          --------------                       -----------------
test-subscription  XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Succeeded
test-subscription2 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Succeeded

List Alias Subscription.

Example 2: Get Alias Subscription.

Get-AzSubscriptionAlias -AliasName test-subscription
AliasName         SubscriptionId                       ProvisioningState
---------         --------------                       -----------------
test-subscription XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Succeeded

Get Alias Subscription.

Parameters

-AliasName

AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn't have any other lifecycle need beyond the request for subscription creation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:ISubscriptionIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

ISubscriptionIdentity

Outputs

ISubscriptionAliasListResult

ISubscriptionAliasResponse