registration_definitions

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

Overview

Name	registration_definitions
Type	Resource
Id	azure.managed_services.registration_definitions

Fields

The following fields are returned by SELECT queries:

get

OK - Returns the complete registration definition with plan details.

Name	Datatype	Description
id	string	The fully qualified path of the registration definition.
name	string	The name of the registration definition.
plan	object	The details for the Managed Services offer’s plan in Azure Marketplace.
properties	object	The properties of a registration definition.
systemData	object	The metadata for the registration assignment resource.
type	string	The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions).

list

OK - Returns a list of the registration definitions.

Name	Datatype	Description
id	string	The fully qualified path of the registration definition.
name	string	The name of the registration definition.
plan	object	The details for the Managed Services offer’s plan in Azure Marketplace.
properties	object	The properties of a registration definition.
systemData	object	The metadata for the registration assignment resource.
type	string	The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, registrationDefinitionId		Gets the registration definition details.
list	select	scope	$filter	Gets a list of the registration definitions.
create_or_update	insert	registrationDefinitionId, scope		Creates or updates a registration definition.
delete	delete	registrationDefinitionId, scope		Deletes the registration definition.

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
registrationDefinitionId	string	The GUID of the registration definition.
scope	string	The scope of the resource.
$filter	string	The filter query parameter to filter managed services resources by.

SELECT examples

get

Gets the registration definition details.

SELECT
id,
name,
plan,
properties,
systemData,
type
FROM azure.managed_services.registration_definitions
WHERE scope = '{{ scope }}' -- required
AND registrationDefinitionId = '{{ registrationDefinitionId }}' -- required
;

list

Gets a list of the registration definitions.

SELECT
id,
name,
plan,
properties,
systemData,
type
FROM azure.managed_services.registration_definitions
WHERE scope = '{{ scope }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates a registration definition.

INSERT INTO azure.managed_services.registration_definitions (
data__properties,
data__plan,
registrationDefinitionId,
scope
)
SELECT 
'{{ properties }}',
'{{ plan }}',
'{{ registrationDefinitionId }}',
'{{ scope }}'
RETURNING
id,
name,
plan,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: registration_definitions
  props:
    - name: registrationDefinitionId
      value: string
      description: Required parameter for the registration_definitions resource.
    - name: scope
      value: string
      description: Required parameter for the registration_definitions resource.
    - name: properties
      value: object
      description: |
        The properties of a registration definition.
    - name: plan
      value: object
      description: |
        The details for the Managed Services offer’s plan in Azure Marketplace.

DELETE examples

delete

Deletes the registration definition.

DELETE FROM azure.managed_services.registration_definitions
WHERE registrationDefinitionId = '{{ registrationDefinitionId }}' --required
AND scope = '{{ scope }}' --required
;