aliases

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

Overview

Name	aliases
Type	Resource
Id	azure.subscription.aliases

Fields

The following fields are returned by SELECT queries:

get

Subscription details.

Name	Datatype	Description
id	string	Fully qualified ID for the alias resource.
name	string	Alias ID.
properties	object	Subscription Alias response properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type, Microsoft.Subscription/aliases.

list

Subscription details.

Name	Datatype	Description
id	string	Fully qualified ID for the alias resource.
name	string	Alias ID.
properties	object	Subscription Alias response properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type, Microsoft.Subscription/aliases.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	aliasName		Get Alias Subscription.
list	select			List Alias Subscription.
create	insert	aliasName		Create Alias Subscription.
delete	delete	aliasName		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
aliasName	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.

SELECT examples

get

Get Alias Subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.subscription.aliases
WHERE aliasName = '{{ aliasName }}' -- required
;

list

List Alias Subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.subscription.aliases
;

INSERT examples

create

Create Alias Subscription.

INSERT INTO azure.subscription.aliases (
data__properties,
aliasName
)
SELECT 
'{{ properties }}',
'{{ aliasName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: aliases
  props:
    - name: aliasName
      value: string
      description: Required parameter for the aliases resource.
    - name: properties
      value: object
      description: |
        Put alias request properties.

DELETE examples

delete

Delete Alias.

DELETE FROM azure.subscription.aliases
WHERE aliasName = '{{ aliasName }}' --required
;