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.
properties	object	Customer subscription properties.
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.
properties	object	Customer subscription properties.
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroup, registrationName, customerSubscriptionName		Returns the specified product.
list	select	subscriptionId, resourceGroup, registrationName		Returns a list of products.
create	insert	subscriptionId, resourceGroup, registrationName, customerSubscriptionName		Creates a new customer subscription under a registration.
delete	delete	subscriptionId, resourceGroup, registrationName, customerSubscriptionName		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
customerSubscriptionName	string	Name of the product.
registrationName	string	Name of the Azure Stack registration.
resourceGroup	string	Name of the resource group.
subscriptionId	string	Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Returns the specified product.

SELECT
id,
name,
etag,
properties,
type
FROM azure_stack.azure_stack.customer_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
AND registrationName = '{{ registrationName }}' -- required
AND customerSubscriptionName = '{{ customerSubscriptionName }}' -- required
;

list

Returns a list of products.

SELECT
id,
name,
etag,
properties,
type
FROM azure_stack.azure_stack.customer_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
AND registrationName = '{{ registrationName }}' -- required
;

INSERT examples

create

Creates a new customer subscription under a registration.

INSERT INTO azure_stack.azure_stack.customer_subscriptions (
data__properties,
data__etag,
subscriptionId,
resourceGroup,
registrationName,
customerSubscriptionName
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ registrationName }}',
'{{ customerSubscriptionName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: customer_subscriptions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the customer_subscriptions resource.
    - name: resourceGroup
      value: string
      description: Required parameter for the customer_subscriptions resource.
    - name: registrationName
      value: string
      description: Required parameter for the customer_subscriptions resource.
    - name: customerSubscriptionName
      value: string
      description: Required parameter for the customer_subscriptions resource.
    - name: properties
      value: object
      description: |
        Customer subscription properties.
    - name: etag
      value: string
      description: |
        The entity tag used for optimistic concurrency when modifying the resource.

DELETE examples

delete

Deletes a customer subscription under a registration.

DELETE FROM azure_stack.azure_stack.customer_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND registrationName = '{{ registrationName }}' --required
AND customerSubscriptionName = '{{ customerSubscriptionName }}' --required
;