assignments

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

Overview

Name	assignments
Type	Resource
Id	azure.blueprints.assignments

Fields

vw_assignments

Name	Datatype	Description
description	text	field from the properties object
assignmentName	text	field from the properties object
blueprint_id	text	field from the properties object
display_name	text	field from the properties object
identity	text	Managed identity generic object.
location	text	The location of this blueprint assignment.
locks	text	field from the properties object
parameters	text	field from the properties object
provisioning_state	text	field from the properties object
resourceScope	text	field from the properties object
resource_groups	text	field from the properties object
scope	text	field from the properties object
status	text	field from the properties object

assignments

Name	Datatype	Description
identity	object	Managed identity generic object.
location	string	The location of this blueprint assignment.
properties	object	Detailed properties for a blueprint assignment.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	assignmentName, resourceScope	Get a blueprint assignment.
list	SELECT	resourceScope	List blueprint assignments within a subscription or a management group.
create_or_update	INSERT	assignmentName, resourceScope, data__identity, data__properties	Create or update a blueprint assignment.
delete	DELETE	assignmentName, resourceScope	Delete a blueprint assignment.
who_is_blueprint	EXEC	assignmentName, resourceScope	Get Blueprints service SPN objectId

SELECT examples

List blueprint assignments within a subscription or a management group.

vw_assignments

SELECT
description,
assignmentName,
blueprint_id,
display_name,
identity,
location,
locks,
parameters,
provisioning_state,
resourceScope,
resource_groups,
scope,
status
FROM azure.blueprints.vw_assignments
WHERE resourceScope = '{{ resourceScope }}';

assignments

SELECT
identity,
location,
properties
FROM azure.blueprints.assignments
WHERE resourceScope = '{{ resourceScope }}';

INSERT example

Use the following StackQL query and manifest file to create a new assignments resource.

All Properties

/*+ create */
INSERT INTO azure.blueprints.assignments (
assignmentName,
resourceScope,
data__identity,
data__properties,
identity,
properties,
location
)
SELECT 
'{{ assignmentName }}',
'{{ resourceScope }}',
'{{ data__identity }}',
'{{ data__properties }}',
'{{ identity }}',
'{{ properties }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: userAssignedIdentities
          value: object
    - name: properties
      value:
        - name: blueprintId
          value: string
        - name: scope
          value: string
        - name: parameters
          value: object
        - name: resourceGroups
          value: object
        - name: status
          value:
            - name: managedResources
              value:
                - string
            - name: timeCreated
              value: string
            - name: lastModified
              value: string
        - name: locks
          value:
            - name: mode
              value: string
            - name: excludedPrincipals
              value:
                - string
            - name: excludedActions
              value:
                - string
        - name: provisioningState
          value: string
        - name: displayName
          value: string
        - name: description
          value: string
    - name: location
      value: string

DELETE example

Deletes the specified assignments resource.

/*+ delete */
DELETE FROM azure.blueprints.assignments
WHERE assignmentName = '{{ assignmentName }}'
AND resourceScope = '{{ resourceScope }}';