Microsoft.Blueprint blueprints

Template format

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

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

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Blueprint/blueprints object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the blueprint definition.
type enum Yes For JSON - Microsoft.Blueprint/blueprints
apiVersion enum Yes For JSON - 2018-11-01-preview
properties object Yes Detailed properties for blueprint definition. - BlueprintProperties object
resources array No versions artifacts

BlueprintProperties object

Name Type Required Value
displayName string No One-liner string explain this resource.
description string No Multi-line explain this resource.
targetScope enum No The scope where this blueprint definition can be assigned. - subscription or managementGroup
parameters object No Parameters required by this blueprint definition.
resourceGroups object No Resource group placeholders defined by this blueprint definition.
versions object No Published versions of this blueprint definition.
layout object No Layout view of the blueprint definition for UI reference.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blueprints - Create a new blueprint definition

Deploy to Azure
This template creaes 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.