你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Blueprint 蓝图

• 最新
• 2018-11-01-preview
• 2017-11-11-preview

Bicep 资源定义

可以使用目标操作部署蓝图资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Blueprint/blueprints 资源，请将以下 Bicep 添加到模板。

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(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        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(Azure.Bicep.Types.Concrete.AnyType)
  }
}

属性值

BlueprintProperties

名字	描述	价值
描述	多行说明此资源。	字符串 约束： 最大长度 =
displayName	单行字符串解释此资源。	字符串 约束： 最大长度 =
参数	此蓝图定义所需的参数。	SharedBlueprintPropertiesParameters
resourceGroups	此蓝图定义定义的资源组占位符。	SharedBlueprintPropertiesResourceGroups
targetScope	可以分配此蓝图定义的作用域。	“managementGroup” “subscription”
版本	此蓝图定义的已发布版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	价值
名字	资源名称	string （必需）
性能	蓝图定义的详细属性。	BlueprintProperties （必需）
范围	在与部署范围不同的范围内创建资源时使用。	将此属性设置为资源的符号名称，以应用 扩展资源。

ParameterDefinition

名字	描述	价值
allowedValues	此参数允许的值数组。	any[]
defaultValue	此参数的默认值。	任何
元数据	此参数的用户友好属性。	ParameterDefinitionMetadata
类型	资源管理器模板参数的允许数据类型。	“array” “bool” “int” 'object' “secureObject” “secureString” “string”（必需）

ParameterDefinitionMetadata

名字	描述	价值
描述	此参数/resourceGroup 的说明。	字符串 约束： 最大长度 =
displayName	此参数/resourceGroup 的 DisplayName。	字符串 约束： 最大长度 =
strongType	用于 UI 的 StrongType 在蓝图分配期间呈现丰富的体验。 支持的强类型为 resourceType、principalId 和 location。	字符串 约束： 最大长度 =

ResourceGroupDefinition

名字	描述	价值
dependsOn	需要在此资源组之前部署的项目。	string[]
位置	此 resourceGroup 的位置。 如果在蓝图分配期间指定资源组位置，则保留为空。	字符串
元数据	此资源组的用户友好属性。	ParameterDefinitionMetadata
名字	此 resourceGroup 的名称。 如果在蓝图分配期间指定资源组名称，则保留为空。	字符串
标签	要分配给此资源组的标记。	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

名字	描述	价值

SharedBlueprintPropertiesParameters

名字	描述	价值

SharedBlueprintPropertiesResourceGroups

名字	描述	价值

ARM 模板资源定义

可以使用目标操作部署蓝图资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Blueprint/blueprints 资源，请将以下 JSON 添加到模板。

{
  "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": {}
  }
}

属性值

BlueprintProperties

名字	描述	价值
描述	多行说明此资源。	字符串 约束： 最大长度 =
displayName	单行字符串解释此资源。	字符串 约束： 最大长度 =
参数	此蓝图定义所需的参数。	SharedBlueprintPropertiesParameters
resourceGroups	此蓝图定义定义的资源组占位符。	SharedBlueprintPropertiesResourceGroups
targetScope	可以分配此蓝图定义的作用域。	“managementGroup” “subscription”
版本	此蓝图定义的已发布版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	价值
apiVersion	API 版本	'2018-11-01-preview'
名字	资源名称	string （必需）
性能	蓝图定义的详细属性。	BlueprintProperties （必需）
类型	资源类型	“Microsoft.Blueprint/blueprints”

ParameterDefinition

名字	描述	价值
allowedValues	此参数允许的值数组。	any[]
defaultValue	此参数的默认值。	任何
元数据	此参数的用户友好属性。	ParameterDefinitionMetadata
类型	资源管理器模板参数的允许数据类型。	“array” “bool” “int” 'object' “secureObject” “secureString” “string”（必需）

ParameterDefinitionMetadata

名字	描述	价值
描述	此参数/resourceGroup 的说明。	字符串 约束： 最大长度 =
displayName	此参数/resourceGroup 的 DisplayName。	字符串 约束： 最大长度 =
strongType	用于 UI 的 StrongType 在蓝图分配期间呈现丰富的体验。 支持的强类型为 resourceType、principalId 和 location。	字符串 约束： 最大长度 =

ResourceGroupDefinition

名字	描述	价值
dependsOn	需要在此资源组之前部署的项目。	string[]
位置	此 resourceGroup 的位置。 如果在蓝图分配期间指定资源组位置，则保留为空。	字符串
元数据	此资源组的用户友好属性。	ParameterDefinitionMetadata
名字	此 resourceGroup 的名称。 如果在蓝图分配期间指定资源组名称，则保留为空。	字符串
标签	要分配给此资源组的标记。	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

名字	描述	价值

SharedBlueprintPropertiesParameters

名字	描述	价值

SharedBlueprintPropertiesResourceGroups

名字	描述	价值

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
蓝图 - 创建新的蓝图定义	此模板创建 Azure 蓝图定义。 蓝图定义包括策略分配项目，可对其进行修改，然后部署到一致的环境的管理组或订阅。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署蓝图资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Blueprint/blueprints 资源，请将以下 Terraform 添加到模板。

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 = {
        {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 = ?
    }
  })
}

属性值

BlueprintProperties

名字	描述	价值
描述	多行说明此资源。	字符串 约束： 最大长度 =
displayName	单行字符串解释此资源。	字符串 约束： 最大长度 =
参数	此蓝图定义所需的参数。	SharedBlueprintPropertiesParameters
resourceGroups	此蓝图定义定义的资源组占位符。	SharedBlueprintPropertiesResourceGroups
targetScope	可以分配此蓝图定义的作用域。	“managementGroup” “subscription”
版本	此蓝图定义的已发布版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	价值
名字	资源名称	string （必需）
parent_id	要向其应用此扩展资源的资源的 ID。	string （必需）
性能	蓝图定义的详细属性。	BlueprintProperties （必需）
类型	资源类型	“Microsoft.Blueprint/blueprints@2018-11-01-preview”

ParameterDefinition

名字	描述	价值
allowedValues	此参数允许的值数组。	any[]
defaultValue	此参数的默认值。	任何
元数据	此参数的用户友好属性。	ParameterDefinitionMetadata
类型	资源管理器模板参数的允许数据类型。	“array” “bool” “int” 'object' “secureObject” “secureString” “string”（必需）

ParameterDefinitionMetadata

名字	描述	价值
描述	此参数/resourceGroup 的说明。	字符串 约束： 最大长度 =
displayName	此参数/resourceGroup 的 DisplayName。	字符串 约束： 最大长度 =
strongType	用于 UI 的 StrongType 在蓝图分配期间呈现丰富的体验。 支持的强类型为 resourceType、principalId 和 location。	字符串 约束： 最大长度 =

ResourceGroupDefinition

名字	描述	价值
dependsOn	需要在此资源组之前部署的项目。	string[]
位置	此 resourceGroup 的位置。 如果在蓝图分配期间指定资源组位置，则保留为空。	字符串
元数据	此资源组的用户友好属性。	ParameterDefinitionMetadata
名字	此 resourceGroup 的名称。 如果在蓝图分配期间指定资源组名称，则保留为空。	字符串
标签	要分配给此资源组的标记。	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

名字	描述	价值

SharedBlueprintPropertiesParameters

名字	描述	价值

SharedBlueprintPropertiesResourceGroups

名字	描述	价值