Microsoft.Blueprint blueprints 2017-11-11-preview

• Latest
• 2018-11-01-preview
• 2017-11-11-preview

Bicep resource definition

The blueprints resource type can be deployed with operations that target:

• 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@2017-11-11-preview' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    layout: any(...)
    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'
      }
    }
    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
layout	Layout view of the blueprint, for UI reference.	any
parameters	Parameters required by this Blueprint definition.	ParameterDefinitionCollection
resourceGroups	Resource group placeholders defined by this Blueprint definition.	ResourceGroupDefinitionCollection
targetScope	The scope where this Blueprint can be applied.	'managementGroup' 'subscription'
versions	Published versions of this blueprint.	any

Microsoft.Blueprint/blueprints

Name	Description	Value
name	The resource name	string (required)
properties	Detailed properties for blueprint	BlueprintProperties (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 Azure Resource Manager template parameters.	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required)

ParameterDefinitionCollection

Name	Description	Value

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 assignment time.	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 Constraints: Max length = 90
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 Constraints: Min length = 1 Max length = 90

ResourceGroupDefinitionCollection

Name	Description	Value

ARM template resource definition

The blueprints resource type can be deployed with operations that target:

• 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": "2017-11-11-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "layout": {},
    "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"
      }
    },
    "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
layout	Layout view of the blueprint, for UI reference.	any
parameters	Parameters required by this Blueprint definition.	ParameterDefinitionCollection
resourceGroups	Resource group placeholders defined by this Blueprint definition.	ResourceGroupDefinitionCollection
targetScope	The scope where this Blueprint can be applied.	'managementGroup' 'subscription'
versions	Published versions of this blueprint.	any

Microsoft.Blueprint/blueprints

Name	Description	Value
apiVersion	The api version	'2017-11-11-preview'
name	The resource name	string (required)
properties	Detailed properties for blueprint	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 Azure Resource Manager template parameters.	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required)

ParameterDefinitionCollection

Name	Description	Value

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 assignment time.	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 Constraints: Max length = 90
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 Constraints: Min length = 1 Max length = 90

ResourceGroupDefinitionCollection

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:

• 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@2017-11-11-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      layout = ?
      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"
        }
      }
      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
layout	Layout view of the blueprint, for UI reference.	any
parameters	Parameters required by this Blueprint definition.	ParameterDefinitionCollection
resourceGroups	Resource group placeholders defined by this Blueprint definition.	ResourceGroupDefinitionCollection
targetScope	The scope where this Blueprint can be applied.	'managementGroup' 'subscription'
versions	Published versions of this blueprint.	any

Microsoft.Blueprint/blueprints

Name	Description	Value
name	The resource name	string (required)
properties	Detailed properties for blueprint	BlueprintProperties (required)
type	The resource type	"Microsoft.Blueprint/blueprints@2017-11-11-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 Azure Resource Manager template parameters.	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' (required)

ParameterDefinitionCollection

Name	Description	Value

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 assignment time.	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 Constraints: Max length = 90
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 Constraints: Min length = 1 Max length = 90

ResourceGroupDefinitionCollection

Name	Description	Value