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

Microsoft.Blueprint 蓝图/项目

Bicep 资源定义

蓝图/项目资源类型可以使用目标操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see blueprints/artifacts objects
}

blueprints/artifacts 对象

设置 kind 属性以指定对象的类型。

对于 policyAssignment,请使用:

  kind: 'policyAssignment'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    parameters: {}
    policyDefinitionId: 'string'
    resourceGroup: 'string'
  }

对于 roleAssignment,请使用:

  kind: 'roleAssignment'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    principalIds: any()
    resourceGroup: 'string'
    roleDefinitionId: 'string'
  }

对于 模板,请使用:

  kind: 'template'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    parameters: {}
    resourceGroup: 'string'
    template: any()
  }

属性值

blueprints/artifacts

名称 说明
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。
字符串 (必需)
kind 设置对象类型 policyAssignment
roleAssignment
模板 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为资源的符号名称: 蓝图

PolicyAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 “policyAssignment” (必需的)
properties policyAssignment Artifact 的属性 PolicyAssignmentArtifactProperties (必需)

PolicyAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
parameters 策略定义的参数值。 对象 (必需)
policyDefinitionId 策略定义的 Azure 资源 ID。 字符串 (必需)
resourceGroup 策略将分配到的资源组占位符的名称。 string

RoleAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 “roleAssignment” (必需)
properties 角色分配蓝图项目的属性。 RoleAssignmentArtifactProperties (必需的)

RoleAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
principalIds Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。 对于 Bicep,可以使用所需的 any () function. ()
resourceGroup RoleAssignment 的范围将限定为此资源组。 如果为空,则其范围限定为订阅。 字符串
roleDefinitionId RoleDefinition 的 Azure 资源 ID。 字符串 (必需)

TemplateArtifact

名称 说明
kind 指定蓝图项目的类型。 “template” (必需)
properties 资源管理器模板蓝图项目的属性。 TemplateArtifactProperties (必需)

TemplateArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
parameters 资源管理器模板蓝图项目参数值。 对象 (必需)
resourceGroup 资源管理器模板蓝图项目将部署到的资源组占位符(如果适用)。 string
template 资源管理器模板蓝图项目主体。 对于 Bicep,可以使用 所需的 any () function. ()

快速入门模板

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

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

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

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "kind": "string",
  // For remaining properties, see blueprints/artifacts objects
}

蓝图/项目对象

设置 kind 属性以指定对象的类型。

对于 policyAssignment,请使用:

  "kind": "policyAssignment",
  "properties": {
    "dependsOn": [ "string" ],
    "description": "string",
    "displayName": "string",
    "parameters": {},
    "policyDefinitionId": "string",
    "resourceGroup": "string"
  }

对于 roleAssignment,请使用:

  "kind": "roleAssignment",
  "properties": {
    "dependsOn": [ "string" ],
    "description": "string",
    "displayName": "string",
    "principalIds": {},
    "resourceGroup": "string",
    "roleDefinitionId": "string"
  }

对于 模板,请使用:

  "kind": "template",
  "properties": {
    "dependsOn": [ "string" ],
    "description": "string",
    "displayName": "string",
    "parameters": {},
    "resourceGroup": "string",
    "template": {}
  }

属性值

blueprints/artifacts

名称 说明 Value
type 资源类型 'Microsoft.Blueprint/blueprints/artifacts'
apiVersion 资源 API 版本 “2018-11-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
kind 设置对象类型 policyAssignment
roleAssignment
模板 (必需)

PolicyAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 需要“policyAssignment” ()
properties policyAssignment Artifact 的属性 PolicyAssignmentArtifactProperties (必需)

PolicyAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 string
displayName 单行字符串解释此资源。 字符串
parameters 策略定义的参数值。 对象 (必需)
policyDefinitionId 策略定义的 Azure 资源 ID。 字符串 (必需)
resourceGroup 策略将分配到的资源组占位符的名称。 字符串

RoleAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 需要“roleAssignment” ()
properties 角色分配蓝图项目的属性。 RoleAssignmentArtifactProperties (必需)

RoleAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
principalIds Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。
resourceGroup RoleAssignment 的范围将限定为此 resourceGroup。 如果为空,则其范围限定为订阅。 string
roleDefinitionId RoleDefinition 的 Azure 资源 ID。 字符串 (必需)

TemplateArtifact

名称 说明
kind 指定蓝图项目的类型。 “template” (必需)
properties 资源管理器模板蓝图项目的属性。 TemplateArtifactProperties (必需)

TemplateArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
parameters 资源管理器模板蓝图项目参数值。 对象 (必需)
resourceGroup 资源管理器模板蓝图项目将部署到的资源组占位符(如果适用)。 string
template 资源管理器模板蓝图项目主体。

快速入门模板

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

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

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

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

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

  • 资源组
  • 订阅
  • 管理组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  // For remaining properties, see blueprints/artifacts objects
  body = jsonencode({
    kind = "string"
  })
}

蓝图/项目对象

设置 kind 属性以指定对象的类型。

对于 policyAssignment,请使用:

  kind = "policyAssignment"
  properties = {
    dependsOn = [
      "string"
    ]
    description = "string"
    displayName = "string"
    parameters = {}
    policyDefinitionId = "string"
    resourceGroup = "string"
  }

对于 roleAssignment,请使用:

  kind = "roleAssignment"
  properties = {
    dependsOn = [
      "string"
    ]
    description = "string"
    displayName = "string"
    resourceGroup = "string"
    roleDefinitionId = "string"
  }

对于 模板,请使用:

  kind = "template"
  properties = {
    dependsOn = [
      "string"
    ]
    description = "string"
    displayName = "string"
    parameters = {}
    resourceGroup = "string"
  }

属性值

blueprints/artifacts

名称 说明 Value
type 资源类型 “Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为的资源的 ID: 蓝图
kind 设置对象类型 policyAssignment
roleAssignment
模板 (必需)

PolicyAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 “policyAssignment” (必需)
properties policyAssignment Artifact 的属性 PolicyAssignmentArtifactProperties (必需)

PolicyAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 字符串
displayName 单行字符串解释此资源。 字符串
parameters 策略定义的参数值。 对象 (必需)
policyDefinitionId 策略定义的 Azure 资源 ID。 字符串 (必需)
resourceGroup 策略将分配到的资源组占位符的名称。 字符串

RoleAssignmentArtifact

名称 说明
kind 指定蓝图项目的类型。 “roleAssignment” (必需)
properties 角色分配蓝图项目的属性。 RoleAssignmentArtifactProperties (必需)

RoleAssignmentArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 string
displayName 单行字符串解释此资源。 字符串
principalIds Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。
resourceGroup RoleAssignment 的范围将限定为此 resourceGroup。 如果为空,则其范围限定为订阅。 string
roleDefinitionId RoleDefinition 的 Azure 资源 ID。 字符串 (必需)

TemplateArtifact

名称 说明
kind 指定蓝图项目的类型。 “template” (必需)
properties 资源管理器模板蓝图项目的属性。 TemplateArtifactProperties (必需)

TemplateArtifactProperties

名称 说明
dependsOn 需要在指定项目之前部署的项目。 string[]
description 多行说明此资源。 string
displayName 单行字符串解释此资源。 字符串
parameters 资源管理器模板蓝图项目参数值。 对象 (必需)
resourceGroup 资源管理器模板蓝图项目将部署到的资源组占位符(如果适用)。 字符串
template 资源管理器模板蓝图项目主体。