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/versions 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/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Blueprint/blueprints/versions@2018-11-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
blueprintName: 'string'
changeNotes: 'string'
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'
}
}
Property Values
Microsoft.Blueprint/blueprints/versions
| Name | Description | Value |
|---|---|---|
| name | The resource name | 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) |
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 |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string Constraints: Max length = 500 |
| 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' |
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/versions 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/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": {
"{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"
}
}
Property Values
Microsoft.Blueprint/blueprints/versions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-11-01-preview' |
| name | The resource name | string (required) |
| properties | Detailed properties for published blueprint. | PublishedBlueprintProperties (required) |
| type | The resource type | 'Microsoft.Blueprint/blueprints/versions' |
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 |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string Constraints: Max length = 500 |
| 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' |
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
Terraform (AzAPI provider) resource definition
The blueprints/versions 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/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 = {
properties = {
blueprintName = "string"
changeNotes = "string"
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"
}
}
}
Property Values
Microsoft.Blueprint/blueprints/versions
| Name | Description | Value |
|---|---|---|
| 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) |
| type | The resource type | "Microsoft.Blueprint/blueprints/versions@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 |
PublishedBlueprintProperties
| Name | Description | Value |
|---|---|---|
| blueprintName | Name of the published blueprint definition. | string |
| changeNotes | Version-specific change notes. | string Constraints: Max length = 500 |
| 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' |
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 |
|---|