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

Microsoft.Blueprint 蓝图 2018-11-01-preview

Bicep 资源定义

蓝图资源类型是 扩展资源,这意味着你可以将其应用于其他资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 Bicep 中设置扩展资源的范围

可以使用针对以下操作部署蓝图资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Blueprint/blueprints@2018-11-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    parameters: {}
    resourceGroups: {}
    targetScope: 'string'
    versions: any()
  }
}

属性值

blueprints

名称 说明
name 资源名称 字符串 (必需)
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 Bicep,请将此属性设置为资源的符号名称以应用 扩展资源
properties 蓝图定义的详细属性。 BlueprintProperties (必需)

BlueprintProperties

名称 说明
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
parameters 此蓝图定义所需的参数。 对象 (object)
resourceGroups 此蓝图定义定义的资源组占位符。 对象 (object)
targetScope 可以分配此蓝图定义的范围。 “managementGroup”
“subscription”
versions 此蓝图定义的已发布版本。 对于 Bicep,可以使用 any () 函数。

快速入门模板

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

模板 说明
蓝图 - 创建新的蓝图定义

部署到 Azure
此模板创建 Azure 蓝图定义。 蓝图定义包括策略分配项目,可以对其进行修改,然后将其部署到管理组或订阅,以确保环境一致。

ARM 模板资源定义

蓝图资源类型是 扩展资源,这意味着你可以将其应用于其他资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 ARM 模板中设置扩展资源的范围

可以使用针对以下操作部署蓝图资源类型:

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

资源格式

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

{
  "type": "Microsoft.Blueprint/blueprints",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "parameters": {},
    "resourceGroups": {},
    "targetScope": "string",
    "versions": {}
  }
}

属性值

blueprints

名称 说明 Value
type 资源类型 “Microsoft.Blueprint/blueprints”
apiVersion 资源 API 版本 “2018-11-01-preview”
name 资源名称 字符串 (必需)
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 JSON,请将值设置为要向其应用 扩展资源 的资源的全名。
properties 蓝图定义的详细属性。 BlueprintProperties (必需)

BlueprintProperties

名称 说明
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 string
parameters 此蓝图定义所需的参数。 对象 (object)
resourceGroups 此蓝图定义定义的资源组占位符。 对象 (object)
targetScope 可以分配此蓝图定义的范围。 “managementGroup”
“subscription”
versions 此蓝图定义的已发布版本。

快速入门模板

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

模板 说明
蓝图 - 创建新的蓝图定义

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

Terraform (AzAPI 提供程序) 资源定义

蓝图资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

可以使用面向以下操作部署蓝图资源类型:

  • 资源组
  • 订阅
  • 管理组

有关每个 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 = {}
      resourceGroups = {}
      targetScope = "string"
    }
  })
}

属性值

blueprints

名称 说明 Value
type 资源类型 “Microsoft.Blueprint/blueprints@2018-11-01-preview”
name 资源名称 字符串 (必需)
parent_id 要应用此扩展资源的资源的 ID。 字符串 (必需)
properties 蓝图定义的详细属性。 BlueprintProperties (必需)

BlueprintProperties

名称 说明
description 多行说明此资源。 string
displayName 单行字符串解释此资源。 string
parameters 此蓝图定义所需的参数。 对象 (object)
resourceGroups 此蓝图定义定义的资源组占位符。 对象 (object)
targetScope 可以分配此蓝图定义的范围。 “managementGroup”
“subscription”
versions 此蓝图定义的已发布版本。