alias

Creates, updates, deletes, gets or lists an alias resource.

Overview

Name	alias
Type	Resource
Id	azure.subscription.alias

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
acceptOwnershipState	string	The accept ownership state of the resource. Known values are: "Pending", "Completed", and "Expired". (Pending, Completed, Expired)
acceptOwnershipUrl	string	Url to accept ownership of the subscription.
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. Known values are: "Accepted", "Succeeded", and "Failed". (Accepted, Succeeded, Failed)
resellerId	string	Reseller Id.
subscriptionId	string	Newly created subscription Id.
subscriptionOwnerId	string	Owner Id of the subscription.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags for the subscription.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workload	string	The workload type of the subscription. It can be either Production or DevTest. Known values are: "Production" and "DevTest". (Production, DevTest)

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
acceptOwnershipState	string	The accept ownership state of the resource. Known values are: "Pending", "Completed", and "Expired". (Pending, Completed, Expired)
acceptOwnershipUrl	string	Url to accept ownership of the subscription.
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. Known values are: "Accepted", "Succeeded", and "Failed". (Accepted, Succeeded, Failed)
resellerId	string	Reseller Id.
subscriptionId	string	Newly created subscription Id.
subscriptionOwnerId	string	Owner Id of the subscription.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags for the subscription.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workload	string	The workload type of the subscription. It can be either Production or DevTest. Known values are: "Production" and "DevTest". (Production, DevTest)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	alias_name		Get Alias Subscription.
list	select			List Alias Subscription.
create	insert	alias_name		Create Alias Subscription.
delete	delete	alias_name		Delete Alias.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alias_name	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. Required.

SELECT examples

get

Get Alias Subscription.

SELECT
id,
name,
acceptOwnershipState,
acceptOwnershipUrl,
billingScope,
createdTime,
displayName,
managementGroupId,
provisioningState,
resellerId,
subscriptionId,
subscriptionOwnerId,
systemData,
tags,
type,
workload
FROM azure.subscription.alias
WHERE alias_name = '{{ alias_name }}' -- required
;

list

List Alias Subscription.

SELECT
id,
name,
acceptOwnershipState,
acceptOwnershipUrl,
billingScope,
createdTime,
displayName,
managementGroupId,
provisioningState,
resellerId,
subscriptionId,
subscriptionOwnerId,
systemData,
tags,
type,
workload
FROM azure.subscription.alias
;

INSERT examples

create

Create Alias Subscription.

INSERT INTO azure.subscription.alias (
properties,
alias_name
)
SELECT 
'{{ properties }}',
'{{ alias_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: alias
props:
  - name: alias_name
    value: "{{ alias_name }}"
    description: Required parameter for the alias resource.
  - name: properties
    description: |
      Put alias request properties.
    value:
      displayName: "{{ displayName }}"
      workload: "{{ workload }}"
      billingScope: "{{ billingScope }}"
      subscriptionId: "{{ subscriptionId }}"
      resellerId: "{{ resellerId }}"
      additionalProperties:
        managementGroupId: "{{ managementGroupId }}"
        subscriptionTenantId: "{{ subscriptionTenantId }}"
        subscriptionOwnerId: "{{ subscriptionOwnerId }}"
        tags: "{{ tags }}"

DELETE examples

delete

Delete Alias.

DELETE FROM azure.subscription.alias
WHERE alias_name = '{{ alias_name }}' --required
;