Microsoft.Blueprint blueprints

Bicep resource definition

The blueprints resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

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

• Resource groups - See resource group deployment commands
• Subscriptions - See subscription deployment commands
• Management groups - See management group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Blueprint/blueprints@2018-11-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    parameters: {}
    resourceGroups: {}
    targetScope: 'string'
    versions: any()
  }
}

Property values

blueprints

BlueprintProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Blueprints - Create a new blueprint definition	This template creates an Azure Blueprint blueprint definition. The blueprint definition includes a policy assignment artifact and can be modified and then deployed to management groups or subscriptions for consistent environments.

ARM template resource definition

The blueprints resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

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

• Resource groups - See resource group deployment commands
• Subscriptions - See subscription deployment commands
• Management groups - See management group deployment commands

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

Resource format

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

{
  "type": "Microsoft.Blueprint/blueprints",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "parameters": {},
    "resourceGroups": {},
    "targetScope": "string",
    "versions": {}
  }
}

Property values

blueprints

BlueprintProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Blueprints - Create a new blueprint definition	This template creates an Azure Blueprint blueprint definition. The blueprint definition includes a policy assignment artifact and can be modified and then deployed to management groups or subscriptions for consistent environments.

Terraform (AzAPI provider) resource definition

The blueprints resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

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

• Resource groups
• Subscriptions
• Management groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {}
      resourceGroups = {}
      targetScope = "string"
    }
  })
}

Property values

blueprints

BlueprintProperties