Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The blueprints resource type can be deployed with operations that target:
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' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
allowedValues: [
any(...)
]
defaultValue: any(...)
metadata: {
description: 'string'
displayName: 'string'
strongType: 'string'
}
type: 'string'
}
}
resourceGroups: {
{customized property}: {
dependsOn: [
'string'
]
location: 'string'
metadata: {
description: 'string'
displayName: 'string'
strongType: 'string'
}
name: 'string'
tags: {
{customized property}: 'string'
}
}
}
targetScope: 'string'
versions: any(...)
}
}
Property Values
BlueprintProperties
| Name | Description | Value |
|---|---|---|
| description | Multi-line explain this resource. | string Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameters required by this blueprint definition. | SharedBlueprintPropertiesParameters |
| resourceGroups | Resource group placeholders defined by this blueprint definition. | SharedBlueprintPropertiesResourceGroups |
| targetScope | The scope where this blueprint definition can be assigned. | 'managementGroup' 'subscription' |
| versions | Published versions of this blueprint definition. | any |
Microsoft.Blueprint/blueprints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Detailed properties for blueprint definition. | BlueprintProperties (required) |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
ParameterDefinition
| Name | Description | Value |
|---|---|---|
| allowedValues | Array of allowed values for this parameter. | any[] |
| defaultValue | Default Value for this parameter. | any |
| metadata | User-friendly properties for this parameter. | ParameterDefinitionMetadata |
| type | Allowed data types for Resource Manager template parameters. | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required) |
ParameterDefinitionMetadata
| Name | Description | Value |
|---|---|---|
| description | Description of this parameter/resourceGroup. | string Constraints: Max length = 500 |
| displayName | DisplayName of this parameter/resourceGroup. | string Constraints: Max length = 256 |
| strongType | StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. | string Constraints: Max length = 64 |
ResourceGroupDefinition
| Name | Description | Value |
|---|---|---|
| dependsOn | Artifacts which need to be deployed before this resource group. | string[] |
| location | Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment. | string |
| metadata | User-friendly properties for this resource group. | ParameterDefinitionMetadata |
| name | Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment. | string |
| tags | Tags to be assigned to this resource group. | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| Name | Description | Value |
|---|
SharedBlueprintPropertiesParameters
| Name | Description | Value |
|---|
SharedBlueprintPropertiesResourceGroups
| Name | Description | Value |
|---|
ARM template resource definition
The blueprints resource type can be deployed with operations that target:
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": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"description": "string",
"displayName": "string",
"strongType": "string"
},
"type": "string"
}
},
"resourceGroups": {
"{customized property}": {
"dependsOn": [ "string" ],
"location": "string",
"metadata": {
"description": "string",
"displayName": "string",
"strongType": "string"
},
"name": "string",
"tags": {
"{customized property}": "string"
}
}
},
"targetScope": "string",
"versions": {}
}
}
Property Values
BlueprintProperties
| Name | Description | Value |
|---|---|---|
| description | Multi-line explain this resource. | string Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameters required by this blueprint definition. | SharedBlueprintPropertiesParameters |
| resourceGroups | Resource group placeholders defined by this blueprint definition. | SharedBlueprintPropertiesResourceGroups |
| targetScope | The scope where this blueprint definition can be assigned. | 'managementGroup' 'subscription' |
| versions | Published versions of this blueprint definition. | any |
Microsoft.Blueprint/blueprints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-11-01-preview' |
| name | The resource name | string (required) |
| properties | Detailed properties for blueprint definition. | BlueprintProperties (required) |
| type | The resource type | 'Microsoft.Blueprint/blueprints' |
ParameterDefinition
| Name | Description | Value |
|---|---|---|
| allowedValues | Array of allowed values for this parameter. | any[] |
| defaultValue | Default Value for this parameter. | any |
| metadata | User-friendly properties for this parameter. | ParameterDefinitionMetadata |
| type | Allowed data types for Resource Manager template parameters. | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required) |
ParameterDefinitionMetadata
| Name | Description | Value |
|---|---|---|
| description | Description of this parameter/resourceGroup. | string Constraints: Max length = 500 |
| displayName | DisplayName of this parameter/resourceGroup. | string Constraints: Max length = 256 |
| strongType | StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. | string Constraints: Max length = 64 |
ResourceGroupDefinition
| Name | Description | Value |
|---|---|---|
| dependsOn | Artifacts which need to be deployed before this resource group. | string[] |
| location | Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment. | string |
| metadata | User-friendly properties for this resource group. | ParameterDefinitionMetadata |
| name | Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment. | string |
| tags | Tags to be assigned to this resource group. | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| Name | Description | Value |
|---|
SharedBlueprintPropertiesParameters
| Name | Description | Value |
|---|
SharedBlueprintPropertiesResourceGroups
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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 can be deployed with operations that target:
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 = {
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
resourceGroups = {
{customized property} = {
dependsOn = [
"string"
]
location = "string"
metadata = {
description = "string"
displayName = "string"
strongType = "string"
}
name = "string"
tags = {
{customized property} = "string"
}
}
}
targetScope = "string"
versions = ?
}
}
}
Property Values
BlueprintProperties
| Name | Description | Value |
|---|---|---|
| description | Multi-line explain this resource. | string Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameters required by this blueprint definition. | SharedBlueprintPropertiesParameters |
| resourceGroups | Resource group placeholders defined by this blueprint definition. | SharedBlueprintPropertiesResourceGroups |
| targetScope | The scope where this blueprint definition can be assigned. | 'managementGroup' 'subscription' |
| versions | Published versions of this blueprint definition. | any |
Microsoft.Blueprint/blueprints
| Name | Description | Value |
|---|---|---|
| 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) |
| type | The resource type | "Microsoft.Blueprint/blueprints@2018-11-01-preview" |
ParameterDefinition
| Name | Description | Value |
|---|---|---|
| allowedValues | Array of allowed values for this parameter. | any[] |
| defaultValue | Default Value for this parameter. | any |
| metadata | User-friendly properties for this parameter. | ParameterDefinitionMetadata |
| type | Allowed data types for Resource Manager template parameters. | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required) |
ParameterDefinitionMetadata
| Name | Description | Value |
|---|---|---|
| description | Description of this parameter/resourceGroup. | string Constraints: Max length = 500 |
| displayName | DisplayName of this parameter/resourceGroup. | string Constraints: Max length = 256 |
| strongType | StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. | string Constraints: Max length = 64 |
ResourceGroupDefinition
| Name | Description | Value |
|---|---|---|
| dependsOn | Artifacts which need to be deployed before this resource group. | string[] |
| location | Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment. | string |
| metadata | User-friendly properties for this resource group. | ParameterDefinitionMetadata |
| name | Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment. | string |
| tags | Tags to be assigned to this resource group. | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| Name | Description | Value |
|---|
SharedBlueprintPropertiesParameters
| Name | Description | Value |
|---|
SharedBlueprintPropertiesResourceGroups
| Name | Description | Value |
|---|