Microsoft.Blueprint blueprints
The blueprints resource type can be deployed to: Resource groups, Subscriptions, Management groups.
To learn about resource group deployments, see Bicep or ARM template. To learn about subscription deployments, see Bicep or ARM template To learn about management group deployments, see Bicep or ARM template
Template format
To create a Microsoft.Blueprint/blueprints resource, add the following Bicep or JSON 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 |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.Blueprint/blueprints' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2018-11-01-preview' |
| name | The resource name | string (required) |
| properties | Schema for blueprint definition properties. | 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 | Any object | 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 |
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. |