registrations

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

Overview

Name	registrations
Type	Resource
Id	azure_stack.azure_stack.registrations

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.
billingModel	string	Specifies the billing mode for the Azure Stack registration.
cloudId	string	The identifier of the registered Azure Stack.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
location	string	Location of the resource. Required. "global"
objectId	string	The object identifier associated with the Azure Stack connecting to Azure.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
type	string	Type of Resource.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
billingModel	string	Specifies the billing mode for the Azure Stack registration.
cloudId	string	The identifier of the registered Azure Stack.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
location	string	Location of the resource. Required. "global"
objectId	string	The object identifier associated with the Azure Stack connecting to Azure.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
type	string	Type of Resource.

list_by_subscription

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
billingModel	string	Specifies the billing mode for the Azure Stack registration.
cloudId	string	The identifier of the registered Azure Stack.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
kind	string	The kind of the resource.
location	string	Location of the resource. Required. "global"
objectId	string	The object identifier associated with the Azure Stack connecting to Azure.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Custom tags for the resource.
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, subscription_id		Returns the properties of an Azure Stack registration.
list	select	resource_group, subscription_id		Returns a list of all registrations.
list_by_subscription	select	subscription_id		Returns a list of all registrations under current subscription.
create_or_update	insert	resource_group, registration_name, subscription_id, location, properties		Create or update an Azure Stack registration.
update	update	resource_group, registration_name, subscription_id, location, properties		Patch an Azure Stack registration.
create_or_update	replace	resource_group, registration_name, subscription_id, location, properties		Create or update an Azure Stack registration.
delete	delete	resource_group, registration_name, subscription_id		Delete the requested Azure Stack registration.
get_activation_key	exec	resource_group, registration_name, subscription_id		Returns Azure Stack Activation Key.
enable_remote_management	exec	resource_group, registration_name, subscription_id		Enables remote management for device under the Azure Stack 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
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 properties of an Azure Stack registration.

SELECT
id,
name,
billingModel,
cloudId,
etag,
kind,
location,
objectId,
systemData,
tags,
type
FROM azure_stack.azure_stack.registrations
WHERE resource_group = '{{ resource_group }}' -- required
AND registration_name = '{{ registration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of all registrations.

SELECT
id,
name,
billingModel,
cloudId,
etag,
kind,
location,
objectId,
systemData,
tags,
type
FROM azure_stack.azure_stack.registrations
WHERE resource_group = '{{ resource_group }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns a list of all registrations under current subscription.

SELECT
id,
name,
billingModel,
cloudId,
etag,
kind,
location,
objectId,
systemData,
tags,
type
FROM azure_stack.azure_stack.registrations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an Azure Stack registration.

INSERT INTO azure_stack.azure_stack.registrations (
location,
properties,
resource_group,
registration_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group }}',
'{{ registration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: registrations
props:
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the registrations resource.
  - name: registration_name
    value: "{{ registration_name }}"
    description: Required parameter for the registrations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the registrations resource.
  - name: location
    value: "{{ location }}"
    description: |
      Location of the resource. Required. "global"
  - name: properties
    value:
      registrationToken: "{{ registrationToken }}"

UPDATE examples

update

Patch an Azure Stack registration.

UPDATE azure_stack.azure_stack.registrations
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND registration_name = '{{ registration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an Azure Stack registration.

REPLACE azure_stack.azure_stack.registrations
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND registration_name = '{{ registration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the requested Azure Stack registration.

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

Lifecycle Methods

get_activation_key

Returns Azure Stack Activation Key.

EXEC azure_stack.azure_stack.registrations.get_activation_key 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_remote_management

Enables remote management for device under the Azure Stack registration.

EXEC azure_stack.azure_stack.registrations.enable_remote_management 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;