Microsoft.Blueprint blueprintAssignments

The blueprintAssignments resource type can be deployed to: Resource groups, Subscriptions, Management groups.

To learn about resource group deployments, see Bicep or ARM template. To learn about subscription deployments, see Bicep or ARM template To learn about management group deployments, see Bicep or ARM template

Template format

To create a Microsoft.Blueprint/blueprintAssignments resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
  name: 'string'
  location: 'string'
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    blueprintId: 'string'
    description: 'string'
    displayName: 'string'
    locks: {
      excludedPrincipals: [ 'string' ]
    }
    parameters: {}
    resourceGroups: {}
    scope: 'string'
  }
}

Property values

blueprintAssignments

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Blueprint/blueprintAssignments'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-11-01-preview'
name The resource name string (required)
location The location of this blueprint assignment. string (required)
identity Managed identity generic object. ManagedServiceIdentity (required)
properties Detailed properties for a blueprint assignment. AssignmentProperties (required)

ManagedServiceIdentity

Name Description Value
principalId Azure Active Directory principal ID associated with this Identity. string
tenantId ID of the Azure Active Directory. string
type Type of the managed identity. 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. object

AssignmentProperties

Name Description Value
blueprintId ID of the published version of a blueprint definition. string
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
locks Defines how resources deployed by a blueprint assignment are locked. AssignmentLockSettings
parameters Blueprint assignment parameter values. object (required)
resourceGroups Names and locations of resource group placeholders. object (required)
scope The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. string

AssignmentLockSettings

Name Description Value
excludedPrincipals List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. string[]