Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. subscription
  5. getAlias
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.subscription.getAlias

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get Alias Subscription. Azure REST API version: 2021-10-01.

Other available API versions: 2020-09-01, 2024-08-01-preview.

Using getAlias

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlias(args: GetAliasArgs, opts?: InvokeOptions): Promise<GetAliasResult>
function getAliasOutput(args: GetAliasOutputArgs, opts?: InvokeOptions): Output<GetAliasResult>
Copy
def get_alias(alias_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAliasResult
def get_alias_output(alias_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAliasResult]
Copy
func LookupAlias(ctx *Context, args *LookupAliasArgs, opts ...InvokeOption) (*LookupAliasResult, error)
func LookupAliasOutput(ctx *Context, args *LookupAliasOutputArgs, opts ...InvokeOption) LookupAliasResultOutput
Copy

> Note: This function is named LookupAlias in the Go SDK.

public static class GetAlias 
{
    public static Task<GetAliasResult> InvokeAsync(GetAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetAliasResult> Invoke(GetAliasInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)
public static Output<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:subscription:getAlias
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AliasName
This property is required.
Changes to this property will trigger replacement.
string
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.
AliasName
This property is required.
Changes to this property will trigger replacement.
string
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.
aliasName
This property is required.
Changes to this property will trigger replacement.
String
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.
aliasName
This property is required.
Changes to this property will trigger replacement.
string
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.
alias_name
This property is required.
Changes to this property will trigger replacement.
str
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.
aliasName
This property is required.
Changes to this property will trigger replacement.
String
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.

getAlias Result

The following output properties are available:

Id string
Fully qualified ID for the alias resource.
Name string
Alias ID.
Properties Pulumi.AzureNative.Subscription.Outputs.SubscriptionAliasResponsePropertiesResponse
Subscription Alias response properties.
SystemData Pulumi.AzureNative.Subscription.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type, Microsoft.Subscription/aliases.
Id string
Fully qualified ID for the alias resource.
Name string
Alias ID.
Properties SubscriptionAliasResponsePropertiesResponse
Subscription Alias response properties.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type, Microsoft.Subscription/aliases.
id String
Fully qualified ID for the alias resource.
name String
Alias ID.
properties SubscriptionAliasResponsePropertiesResponse
Subscription Alias response properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Resource type, Microsoft.Subscription/aliases.
id string
Fully qualified ID for the alias resource.
name string
Alias ID.
properties SubscriptionAliasResponsePropertiesResponse
Subscription Alias response properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Resource type, Microsoft.Subscription/aliases.
id str
Fully qualified ID for the alias resource.
name str
Alias ID.
properties SubscriptionAliasResponsePropertiesResponse
Subscription Alias response properties.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Resource type, Microsoft.Subscription/aliases.
id String
Fully qualified ID for the alias resource.
name String
Alias ID.
properties Property Map
Subscription Alias response properties.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Resource type, Microsoft.Subscription/aliases.

Supporting Types

SubscriptionAliasResponsePropertiesResponse

AcceptOwnershipState This property is required. string
The accept ownership state of the resource.
AcceptOwnershipUrl This property is required. string
Url to accept ownership of the subscription.
SubscriptionId This property is required. string
Newly created subscription Id.
BillingScope string
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
CreatedTime string
Created Time
DisplayName string
The display name of the subscription.
ManagementGroupId string
The Management Group Id.
ProvisioningState string
The provisioning state of the resource.
ResellerId string
Reseller Id
SubscriptionOwnerId string
Owner Id of the subscription
Tags Dictionary<string, string>
Tags for the subscription
Workload string
The workload type of the subscription. It can be either Production or DevTest.
AcceptOwnershipState This property is required. string
The accept ownership state of the resource.
AcceptOwnershipUrl This property is required. string
Url to accept ownership of the subscription.
SubscriptionId This property is required. string
Newly created subscription Id.
BillingScope string
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
CreatedTime string
Created Time
DisplayName string
The display name of the subscription.
ManagementGroupId string
The Management Group Id.
ProvisioningState string
The provisioning state of the resource.
ResellerId string
Reseller Id
SubscriptionOwnerId string
Owner Id of the subscription
Tags map[string]string
Tags for the subscription
Workload string
The workload type of the subscription. It can be either Production or DevTest.
acceptOwnershipState This property is required. String
The accept ownership state of the resource.
acceptOwnershipUrl This property is required. String
Url to accept ownership of the subscription.
subscriptionId This property is required. String
Newly created subscription Id.
billingScope String
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime String
Created Time
displayName String
The display name of the subscription.
managementGroupId String
The Management Group Id.
provisioningState String
The provisioning state of the resource.
resellerId String
Reseller Id
subscriptionOwnerId String
Owner Id of the subscription
tags Map<String,String>
Tags for the subscription
workload String
The workload type of the subscription. It can be either Production or DevTest.
acceptOwnershipState This property is required. string
The accept ownership state of the resource.
acceptOwnershipUrl This property is required. string
Url to accept ownership of the subscription.
subscriptionId This property is required. string
Newly created subscription Id.
billingScope string
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime string
Created Time
displayName string
The display name of the subscription.
managementGroupId string
The Management Group Id.
provisioningState string
The provisioning state of the resource.
resellerId string
Reseller Id
subscriptionOwnerId string
Owner Id of the subscription
tags {[key: string]: string}
Tags for the subscription
workload string
The workload type of the subscription. It can be either Production or DevTest.
accept_ownership_state This property is required. str
The accept ownership state of the resource.
accept_ownership_url This property is required. str
Url to accept ownership of the subscription.
subscription_id This property is required. str
Newly created subscription Id.
billing_scope str
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
created_time str
Created Time
display_name str
The display name of the subscription.
management_group_id str
The Management Group Id.
provisioning_state str
The provisioning state of the resource.
reseller_id str
Reseller Id
subscription_owner_id str
Owner Id of the subscription
tags Mapping[str, str]
Tags for the subscription
workload str
The workload type of the subscription. It can be either Production or DevTest.
acceptOwnershipState This property is required. String
The accept ownership state of the resource.
acceptOwnershipUrl This property is required. String
Url to accept ownership of the subscription.
subscriptionId This property is required. String
Newly created subscription Id.
billingScope String
Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime String
Created Time
displayName String
The display name of the subscription.
managementGroupId String
The Management Group Id.
provisioningState String
The provisioning state of the resource.
resellerId String
Reseller Id
subscriptionOwnerId String
Owner Id of the subscription
tags Map<String>
Tags for the subscription
workload String
The workload type of the subscription. It can be either Production or DevTest.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native