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

Name	Datatype	Description
id	string	The fully qualified path of the registration definition.
name	string	The name of the registration definition.
authorizations	array	The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
description	string	The description of the registration definition.
eligibleAuthorizations	array	The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
managedByTenantId	string	The identifier of the managedBy tenant. Required.
managedByTenantName	string	The name of the managedBy tenant.
manageeTenantId	string	The identifier of the managed tenant.
manageeTenantName	string	The name of the managed tenant.
plan	object	The details for the Managed Services offer’s plan in Azure Marketplace.
provisioningState	string	The current provisioning state of the registration definition. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
registrationDefinitionName	string	The name of the registration definition.
type	string	The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions).

list

Name	Datatype	Description
id	string	The fully qualified path of the registration definition.
name	string	The name of the registration definition.
authorizations	array	The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
description	string	The description of the registration definition.
eligibleAuthorizations	array	The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
managedByTenantId	string	The identifier of the managedBy tenant. Required.
managedByTenantName	string	The name of the managedBy tenant.
manageeTenantId	string	The identifier of the managed tenant.
manageeTenantName	string	The name of the managed tenant.
plan	object	The details for the Managed Services offer’s plan in Azure Marketplace.
provisioningState	string	The current provisioning state of the registration definition. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
registrationDefinitionName	string	The name of the registration definition.
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, registration_definition_id		Gets the registration definition details.
list	select	scope		Gets a list of the registration definitions.
create_or_update	insert	registration_definition_id, scope		Creates or updates a registration definition.
create_or_update	replace	registration_definition_id, scope		Creates or updates a registration definition.
delete	delete	registration_definition_id, 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
registration_definition_id	string	The GUID of the registration definition. Required.
scope	string	The scope of the resource. Required.

SELECT examples

get

Gets the registration definition details.

SELECT
id,
name,
authorizations,
description,
eligibleAuthorizations,
managedByTenantId,
managedByTenantName,
manageeTenantId,
manageeTenantName,
plan,
provisioningState,
registrationDefinitionName,
type
FROM azure.managed_services.registration_definitions
WHERE scope = '{{ scope }}' -- required
AND registration_definition_id = '{{ registration_definition_id }}' -- required
;

list

Gets a list of the registration definitions.

SELECT
id,
name,
authorizations,
description,
eligibleAuthorizations,
managedByTenantId,
managedByTenantName,
manageeTenantId,
manageeTenantName,
plan,
provisioningState,
registrationDefinitionName,
type
FROM azure.managed_services.registration_definitions
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

Creates or updates a registration definition.

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

Manifest

# Description fields are for documentation purposes
- name: registration_definitions
props:
  - name: registration_definition_id
    value: "{{ registration_definition_id }}"
    description: Required parameter for the registration_definitions resource.
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the registration_definitions resource.
  - name: properties
    description: |
      The properties of a registration definition.
    value:
      description: "{{ description }}"
      authorizations:
        - principalId: "{{ principalId }}"
          principalIdDisplayName: "{{ principalIdDisplayName }}"
          roleDefinitionId: "{{ roleDefinitionId }}"
          delegatedRoleDefinitionIds: "{{ delegatedRoleDefinitionIds }}"
      eligibleAuthorizations:
        - principalId: "{{ principalId }}"
          principalIdDisplayName: "{{ principalIdDisplayName }}"
          roleDefinitionId: "{{ roleDefinitionId }}"
          justInTimeAccessPolicy:
            multiFactorAuthProvider: "{{ multiFactorAuthProvider }}"
            maximumActivationDuration: "{{ maximumActivationDuration }}"
            managedByTenantApprovers:
              - principalId: "{{ principalId }}"
                principalIdDisplayName: "{{ principalIdDisplayName }}"
      registrationDefinitionName: "{{ registrationDefinitionName }}"
      managedByTenantId: "{{ managedByTenantId }}"
      provisioningState: "{{ provisioningState }}"
      manageeTenantId: "{{ manageeTenantId }}"
      manageeTenantName: "{{ manageeTenantName }}"
      managedByTenantName: "{{ managedByTenantName }}"
  - name: plan
    description: |
      The details for the Managed Services offer’s plan in Azure Marketplace.
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      version: "{{ version }}"

REPLACE examples

create_or_update

Creates or updates a registration definition.

REPLACE azure.managed_services.registration_definitions
SET 
properties = '{{ properties }}',
plan = '{{ plan }}'
WHERE 
registration_definition_id = '{{ registration_definition_id }}' --required
AND scope = '{{ scope }}' --required
RETURNING
id,
name,
plan,
properties,
type;

DELETE examples

delete

Deletes the registration definition.

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