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.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
location	string	Location of the resource.
properties	object	Registration 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.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
location	string	Location of the resource.
properties	object	Registration 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.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
location	string	Location of the resource.
properties	object	Registration 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	subscriptionId, resourceGroup, registrationName		Returns the properties of an Azure Stack registration.
list	select	subscriptionId, resourceGroup		Returns a list of all registrations.
list_by_subscription	select	subscriptionId		Returns a list of all registrations under current subscription.
create_or_update	insert	subscriptionId, resourceGroup, registrationName, data__properties, data__location		Create or update an Azure Stack registration.
update	update	subscriptionId, resourceGroup, registrationName, data__properties, data__location		Patch an Azure Stack registration.
delete	delete	subscriptionId, resourceGroup, registrationName		Delete the requested Azure Stack registration.
enable_remote_management	exec	subscriptionId, resourceGroup, registrationName		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
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 properties of an Azure Stack registration.

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

list

Returns a list of all registrations.

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

list_by_subscription

Returns a list of all registrations under current subscription.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure_stack.azure_stack.registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an Azure Stack registration.

INSERT INTO azure_stack.azure_stack.registrations (
data__properties,
data__location,
subscriptionId,
resourceGroup,
registrationName
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ registrationName }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: registrations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the registrations resource.
    - name: resourceGroup
      value: string
      description: Required parameter for the registrations resource.
    - name: registrationName
      value: string
      description: Required parameter for the registrations resource.
    - name: properties
      value: object
      description: |
        Properties of the Azure Stack registration resource
    - name: location
      value: string
      description: |
        Location of the resource.
      valid_values: ['global']

UPDATE examples

update

Patch an Azure Stack registration.

UPDATE azure_stack.azure_stack.registrations
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND registrationName = '{{ registrationName }}' --required
AND data__properties = '{{ properties }}' --required
AND data__location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Delete the requested Azure Stack registration.

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

Lifecycle Methods

enable_remote_management

Enables remote management for device under the Azure Stack registration.

EXEC azure_stack.azure_stack.registrations.enable_remote_management 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroup='{{ resourceGroup }}' --required, 
@registrationName='{{ registrationName }}' --required
;