registration_assignments

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

Overview

Name	registration_assignments
Type	Resource
Id	azure.managed_services.registration_assignments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The fully qualified path of the registration assignment.
name	string	The name of the registration assignment.
provisioningState	string	The current provisioning state of the registration assignment. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
registrationDefinition	object	The registration definition associated with the registration assignment.
registrationDefinitionId	string	The fully qualified path of the registration definition. Required.
type	string	The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments).

list

Name	Datatype	Description
id	string	The fully qualified path of the registration assignment.
name	string	The name of the registration assignment.
provisioningState	string	The current provisioning state of the registration assignment. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
registrationDefinition	object	The registration definition associated with the registration assignment.
registrationDefinitionId	string	The fully qualified path of the registration definition. Required.
type	string	The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, registration_assignment_id	$expandRegistrationDefinition	Gets the details of the specified registration assignment.
list	select	scope	$expandRegistrationDefinition	Gets a list of the registration assignments.
create_or_update	insert	scope, registration_assignment_id		Creates or updates a registration assignment.
create_or_update	replace	scope, registration_assignment_id		Creates or updates a registration assignment.
delete	delete	scope, registration_assignment_id		Deletes the specified registration assignment.

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_assignment_id	string	The GUID of the registration assignment. Required.
scope	string	The scope of the resource. Required.
$expandRegistrationDefinition	boolean	The flag indicating whether to return the registration definition details along with the registration assignment details. Default value is None.

SELECT examples

get

Gets the details of the specified registration assignment.

SELECT
id,
name,
provisioningState,
registrationDefinition,
registrationDefinitionId,
type
FROM azure.managed_services.registration_assignments
WHERE scope = '{{ scope }}' -- required
AND registration_assignment_id = '{{ registration_assignment_id }}' -- required
AND $expandRegistrationDefinition = '{{ $expandRegistrationDefinition }}'
;

list

Gets a list of the registration assignments.

SELECT
id,
name,
provisioningState,
registrationDefinition,
registrationDefinitionId,
type
FROM azure.managed_services.registration_assignments
WHERE scope = '{{ scope }}' -- required
AND $expandRegistrationDefinition = '{{ $expandRegistrationDefinition }}'
;

INSERT examples

create_or_update

Creates or updates a registration assignment.

INSERT INTO azure.managed_services.registration_assignments (
properties,
scope,
registration_assignment_id
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ registration_assignment_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: registration_assignments
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the registration_assignments resource.
  - name: registration_assignment_id
    value: "{{ registration_assignment_id }}"
    description: Required parameter for the registration_assignments resource.
  - name: properties
    description: |
      The properties of a registration assignment.
    value:
      registrationDefinitionId: "{{ registrationDefinitionId }}"
      provisioningState: "{{ provisioningState }}"
      registrationDefinition:
        properties:
          description: "{{ description }}"
          authorizations:
            - principalId: "{{ principalId }}"
              principalIdDisplayName: "{{ principalIdDisplayName }}"
              roleDefinitionId: "{{ roleDefinitionId }}"
              delegatedRoleDefinitionIds: "{{ delegatedRoleDefinitionIds }}"
          eligibleAuthorizations:
            - principalId: "{{ principalId }}"
              principalIdDisplayName: "{{ principalIdDisplayName }}"
              roleDefinitionId: "{{ roleDefinitionId }}"
              justInTimeAccessPolicy:
                multiFactorAuthProvider: "{{ multiFactorAuthProvider }}"
                maximumActivationDuration: "{{ maximumActivationDuration }}"
                managedByTenantApprovers: "{{ managedByTenantApprovers }}"
          registrationDefinitionName: "{{ registrationDefinitionName }}"
          provisioningState: "{{ provisioningState }}"
          manageeTenantId: "{{ manageeTenantId }}"
          manageeTenantName: "{{ manageeTenantName }}"
          managedByTenantId: "{{ managedByTenantId }}"
          managedByTenantName: "{{ managedByTenantName }}"
        plan:
          name: "{{ name }}"
          publisher: "{{ publisher }}"
          product: "{{ product }}"
          version: "{{ version }}"
        id: "{{ id }}"
        type: "{{ type }}"
        name: "{{ name }}"

REPLACE examples

create_or_update

Creates or updates a registration assignment.

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

DELETE examples

delete

Deletes the specified registration assignment.

DELETE FROM azure.managed_services.registration_assignments
WHERE scope = '{{ scope }}' --required
AND registration_assignment_id = '{{ registration_assignment_id }}' --required
;