customer_subscriptions

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

Overview

Name	customer_subscriptions
Type	Resource
Id	azure_stack.azure_stack.customer_subscriptions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tenantId	string	Tenant Id.
type	string	Type of Resource.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tenantId	string	Tenant Id.
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group, registration_name, customer_subscription_name, subscription_id		Returns the specified product.
list	select	resource_group, registration_name, subscription_id		Returns a list of products.
create	insert	resource_group, registration_name, customer_subscription_name, subscription_id		Creates a new customer subscription under a registration.
delete	delete	resource_group, registration_name, customer_subscription_name, subscription_id		Deletes a customer subscription under a registration.

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
customer_subscription_name	string	Name of the product. Required.
registration_name	string	Name of the Azure Stack registration. Required.
resource_group	string	Name of the resource group. Required.
subscription_id	string

SELECT examples

get

Returns the specified product.

SELECT
id,
name,
etag,
systemData,
tenantId,
type
FROM azure_stack.azure_stack.customer_subscriptions
WHERE resource_group = '{{ resource_group }}' -- required
AND registration_name = '{{ registration_name }}' -- required
AND customer_subscription_name = '{{ customer_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of products.

SELECT
id,
name,
etag,
systemData,
tenantId,
type
FROM azure_stack.azure_stack.customer_subscriptions
WHERE resource_group = '{{ resource_group }}' -- required
AND registration_name = '{{ registration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new customer subscription under a registration.

INSERT INTO azure_stack.azure_stack.customer_subscriptions (
etag,
properties,
resource_group,
registration_name,
customer_subscription_name,
subscription_id
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ resource_group }}',
'{{ registration_name }}',
'{{ customer_subscription_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: customer_subscriptions
props:
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the customer_subscriptions resource.
  - name: registration_name
    value: "{{ registration_name }}"
    description: Required parameter for the customer_subscriptions resource.
  - name: customer_subscription_name
    value: "{{ customer_subscription_name }}"
    description: Required parameter for the customer_subscriptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the customer_subscriptions resource.
  - name: etag
    value: "{{ etag }}"
    description: |
      The entity tag used for optimistic concurrency when modifying the resource.
  - name: properties
    value:
      tenantId: "{{ tenantId }}"

DELETE examples

delete

Deletes a customer subscription under a registration.

DELETE FROM azure_stack.azure_stack.customer_subscriptions
WHERE resource_group = '{{ resource_group }}' --required
AND registration_name = '{{ registration_name }}' --required
AND customer_subscription_name = '{{ customer_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;