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:
For a list of changed properties in each API version, see change log.
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": {}
}
}
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) |
scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
properties | Detailed properties for blueprint definition. | BlueprintProperties (required) |
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. |
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. |