Microsoft.Blueprint blueprints

Bicep resource definition

The blueprints resource type can be deployed to: 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 Bicep to your template.

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

Property values

blueprints

Name Description Value
name The resource name string (required)
properties Detailed properties for blueprint definition. BlueprintProperties (required)

BlueprintProperties

Name Description Value
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
parameters Parameters required by this blueprint definition. object
resourceGroups Resource group placeholders defined by this blueprint definition. object
targetScope The scope where this blueprint definition can be assigned. 'managementGroup'
'subscription'
versions Published versions of this blueprint definition. For Bicep, you can use the any() function.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blueprints - Create a new blueprint definition

Deploy to Azure
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 can be deployed to: 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 JSON to your template.

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

Property values

blueprints

Name Description Value
type The resource type 'Microsoft.Blueprint/blueprints'
apiVersion The resource api version '2018-11-01-preview'
name The resource name string (required)
properties Detailed properties for blueprint definition. BlueprintProperties (required)

BlueprintProperties

Name Description Value
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
parameters Parameters required by this blueprint definition. object
resourceGroups Resource group placeholders defined by this blueprint definition. object
targetScope The scope where this blueprint definition can be assigned. 'managementGroup'
'subscription'
versions Published versions of this blueprint definition.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blueprints - Create a new blueprint definition

Deploy to Azure
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 can be deployed to: 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

Name Description Value
type The resource type "Microsoft.Blueprint/blueprints@2018-11-01-preview"
name The resource name string (required)
parent_id string (required)
properties Detailed properties for blueprint definition. BlueprintProperties (required)

BlueprintProperties

Name Description Value
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
parameters Parameters required by this blueprint definition. object
resourceGroups Resource group placeholders defined by this blueprint definition. object
targetScope The scope where this blueprint definition can be assigned. "managementGroup"
"subscription"
versions Published versions of this blueprint definition.