Share via

Microsoft.Blueprint blueprintAssignments 2017-11-11-preview

  • Article

Bicep resource definition

The blueprintAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2017-11-11-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    blueprintId: 'string'
    description: 'string'
    displayName: 'string'
    locks: {
      mode: 'string'
    }
    parameters: {
      {customized property}: {
        description: 'string'
      }
    }
    resourceGroups: {
      {customized property}: {
        location: 'string'
        name: 'string'
      }
    }
  }
}

Property Values

AssignmentLockSettings

Name Description Value
mode Lock mode. 'AllResources'
'None'

AssignmentProperties

Name Description Value
blueprintId ID of the Blueprint definition resource. string
description Multi-line explain this resource. string

Constraints:
Max length = 500
displayName One-liner string explain this resource. string

Constraints:
Max length = 256
locks Defines how Blueprint-managed resources will be locked. AssignmentLockSettings
parameters Blueprint parameter values. ParameterValueCollection (required)
resourceGroups Names and locations of resource group placeholders. ResourceGroupValueCollection (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 Service Identity. 'None'
'SystemAssigned'
'UserAssigned' (required)

Microsoft.Blueprint/blueprintAssignments

Name Description Value
identity Managed Service Identity for this Blueprint assignment ManagedServiceIdentity (required)
location The location of this Blueprint assignment. string (required)
name The resource name string (required)
properties Properties for Assignment object. AssignmentProperties (required)

ParameterValueBase

Name Description Value
description Optional property, just to establish ParameterValueBase as a BaseClass. string

ParameterValueCollection

Name Description Value

ResourceGroupValue

Name Description Value
location Location of the resource group string
name Name of the resource group string

Constraints:
Min length = 1
Max length = 90

ResourceGroupValueCollection

Name Description Value

ARM template resource definition

The blueprintAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Blueprint/blueprintAssignments",
  "apiVersion": "2017-11-11-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "blueprintId": "string",
    "description": "string",
    "displayName": "string",
    "locks": {
      "mode": "string"
    },
    "parameters": {
      "{customized property}": {
        "description": "string"
      }
    },
    "resourceGroups": {
      "{customized property}": {
        "location": "string",
        "name": "string"
      }
    }
  }
}

Property Values

AssignmentLockSettings

Name Description Value
mode Lock mode. 'AllResources'
'None'

AssignmentProperties

Name Description Value
blueprintId ID of the Blueprint definition resource. string
description Multi-line explain this resource. string

Constraints:
Max length = 500
displayName One-liner string explain this resource. string

Constraints:
Max length = 256
locks Defines how Blueprint-managed resources will be locked. AssignmentLockSettings
parameters Blueprint parameter values. ParameterValueCollection (required)
resourceGroups Names and locations of resource group placeholders. ResourceGroupValueCollection (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 Service Identity. 'None'
'SystemAssigned'
'UserAssigned' (required)

Microsoft.Blueprint/blueprintAssignments

Name Description Value
apiVersion The api version '2017-11-11-preview'
identity Managed Service Identity for this Blueprint assignment ManagedServiceIdentity (required)
location The location of this Blueprint assignment. string (required)
name The resource name string (required)
properties Properties for Assignment object. AssignmentProperties (required)
type The resource type 'Microsoft.Blueprint/blueprintAssignments'

ParameterValueBase

Name Description Value
description Optional property, just to establish ParameterValueBase as a BaseClass. string

ParameterValueCollection

Name Description Value

ResourceGroupValue

Name Description Value
location Location of the resource group string
name Name of the resource group string

Constraints:
Min length = 1
Max length = 90

ResourceGroupValueCollection

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The blueprintAssignments resource type can be deployed with operations that target:

  • Subscription

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprintAssignments@2017-11-11-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  body = {
    properties = {
      blueprintId = "string"
      description = "string"
      displayName = "string"
      locks = {
        mode = "string"
      }
      parameters = {
        {customized property} = {
          description = "string"
        }
      }
      resourceGroups = {
        {customized property} = {
          location = "string"
          name = "string"
        }
      }
    }
  }
}

Property Values

AssignmentLockSettings

Name Description Value
mode Lock mode. 'AllResources'
'None'

AssignmentProperties

Name Description Value
blueprintId ID of the Blueprint definition resource. string
description Multi-line explain this resource. string

Constraints:
Max length = 500
displayName One-liner string explain this resource. string

Constraints:
Max length = 256
locks Defines how Blueprint-managed resources will be locked. AssignmentLockSettings
parameters Blueprint parameter values. ParameterValueCollection (required)
resourceGroups Names and locations of resource group placeholders. ResourceGroupValueCollection (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 Service Identity. 'None'
'SystemAssigned'
'UserAssigned' (required)

Microsoft.Blueprint/blueprintAssignments

Name Description Value
identity Managed Service Identity for this Blueprint assignment ManagedServiceIdentity (required)
location The location of this Blueprint assignment. string (required)
name The resource name string (required)
properties Properties for Assignment object. AssignmentProperties (required)
type The resource type "Microsoft.Blueprint/blueprintAssignments@2017-11-11-preview"

ParameterValueBase

Name Description Value
description Optional property, just to establish ParameterValueBase as a BaseClass. string

ParameterValueCollection

Name Description Value

ResourceGroupValue

Name Description Value
location Location of the resource group string
name Name of the resource group string

Constraints:
Min length = 1
Max length = 90

ResourceGroupValueCollection

Name Description Value