subscriptions_aliases

Creates, updates, deletes, gets or lists a subscriptions_aliases resource.

Overview

Name	subscriptions_aliases
Type	Resource
Id	azure.billing.subscriptions_aliases

Fields

The following fields are returned by SELECT queries:

get

A billing subscription alias.

Name	Datatype	Description
properties	object	The properties of a(n) BillingSubscriptionAlias
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list_by_billing_account

The list of billing subscription aliases.

Name	Datatype	Description
properties	object	The properties of a(n) BillingSubscriptionAlias
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billingAccountName, aliasName		Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
list_by_billing_account	select	billingAccountName	includeDeleted, filter, orderBy, top, skip, count, search	Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.
create_or_update	insert	billingAccountName, aliasName		Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.

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	The ID that uniquely identifies a subscription alias.
billingAccountName	string	The ID that uniquely identifies a billing account.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
includeDeleted	boolean	Can be used to get deleted billing subscriptions.
orderBy	string	The orderby query option allows clients to request resources in a particular order.
search	string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
skip	integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	integer (int64)	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

SELECT examples

get

Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.

SELECT
properties,
tags
FROM azure.billing.subscriptions_aliases
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND aliasName = '{{ aliasName }}' -- required
;

list_by_billing_account

Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.

SELECT
properties,
tags
FROM azure.billing.subscriptions_aliases
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

INSERT examples

create_or_update

Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.

INSERT INTO azure.billing.subscriptions_aliases (
data__tags,
data__properties,
billingAccountName,
aliasName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ billingAccountName }}',
'{{ aliasName }}'
RETURNING
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: subscriptions_aliases
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the subscriptions_aliases resource.
    - name: aliasName
      value: string
      description: Required parameter for the subscriptions_aliases resource.
    - name: tags
      value: object
      description: |
        Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
    - name: properties
      value: object
      description: |
        The properties of a(n) BillingSubscriptionAlias