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
| Name | Description | Value |
|---|---|---|
| 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 Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| 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 |
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
| 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) |
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 |
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
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Blueprint/blueprints@2018-11-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | 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. |