Microsoft.Blueprint blueprints/versions
Bicep resource definition
The blueprints/versions resource type can be deployed to:
- 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/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Blueprint/blueprints/versions@2018-11-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
blueprintName: 'string'
changeNotes: 'string'
description: 'string'
displayName: 'string'
parameters: {}
resourceGroups: {}
targetScope: 'string'
}
}
Property values
blueprints/versions
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: blueprints |
| properties | Detailed properties for published blueprint. | PublishedBlueprintProperties (required) |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string |
| 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' |
ARM template resource definition
The blueprints/versions resource type can be deployed to:
- 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/versions resource, add the following JSON to your template.
{
"type": "Microsoft.Blueprint/blueprints/versions",
"apiVersion": "2018-11-01-preview",
"name": "string",
"properties": {
"blueprintName": "string",
"changeNotes": "string",
"description": "string",
"displayName": "string",
"parameters": {},
"resourceGroups": {},
"targetScope": "string"
}
}
Property values
blueprints/versions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Blueprint/blueprints/versions' |
| apiVersion | The resource api version | '2018-11-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Detailed properties for published blueprint. | PublishedBlueprintProperties (required) |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string |
| 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' |
Terraform (AzAPI provider) resource definition
The blueprints/versions resource type can be deployed to:
- 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/versions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Blueprint/blueprints/versions@2018-11-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
blueprintName = "string"
changeNotes = "string"
description = "string"
displayName = "string"
parameters = {}
resourceGroups = {}
targetScope = "string"
}
})
}
Property values
blueprints/versions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Blueprint/blueprints/versions@2018-11-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: blueprints |
| properties | Detailed properties for published blueprint. | PublishedBlueprintProperties (required) |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string |
| 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" |