activations

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

Overview

Name	activations
Type	Resource
Id	azure_stack.azure_bridge_admin.activations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Properties of the resource.
tags	object	List of key value pairs.
type	string	Type of resource.

list

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Properties of the resource.
tags	object	List of key value pairs.
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, resourceGroupName, activationName		Returns activation name.
list	select	subscriptionId, resourceGroupName		Returns the list of activations.
create_or_update	insert	subscriptionId, resourceGroupName, activationName		Create a new activation.
delete	delete	subscriptionId, resourceGroupName, activationName		Delete an activation.

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
activationName	string	Name of the activation.
resourceGroupName	string	The resource group the resource is located under.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.

SELECT examples

get

Returns activation name.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.azure_bridge_admin.activations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND activationName = '{{ activationName }}' -- required
;

list

Returns the list of activations.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.azure_bridge_admin.activations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Create a new activation.

INSERT INTO azure_stack.azure_bridge_admin.activations (
data__displayName,
data__azureRegistrationResourceIdentifier,
data__provisioningState,
data__expiration,
data__marketplaceSyndicationEnabled,
data__usageReportingEnabled,
subscriptionId,
resourceGroupName,
activationName
)
SELECT 
'{{ displayName }}',
'{{ azureRegistrationResourceIdentifier }}',
'{{ provisioningState }}',
'{{ expiration }}',
{{ marketplaceSyndicationEnabled }},
{{ usageReportingEnabled }},
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ activationName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: activations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the activations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the activations resource.
    - name: activationName
      value: string
      description: Required parameter for the activations resource.
    - name: displayName
      value: string
      description: |
        Name displayed for the product.
    - name: azureRegistrationResourceIdentifier
      value: string
      description: |
        Azure registration resource identifier.
    - name: provisioningState
      value: string
      description: |
        Provisioning state of the resource.
      valid_values: ['Stopped', 'Starting', 'Running', 'Stopping', 'Succeeded', 'Downloading']
    - name: expiration
      value: string
      description: |
        The activation expiration.
    - name: marketplaceSyndicationEnabled
      value: boolean
      description: |
        Value indicating whether the marketplace syndication feature is enabled.
    - name: usageReportingEnabled
      value: boolean
      description: |
        Value indicating whether the usage reporting feature is enabled.

DELETE examples

delete

Delete an activation.

DELETE FROM azure_stack.azure_bridge_admin.activations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND activationName = '{{ activationName }}' --required
;