你当前正在访问 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'
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 对象
设置 类型 属性以指定对象的类型。
对于 policyAssignment，请使用：
{
kind: 'policyAssignment'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
resourceGroup: 'string'
}
}
对于 roleAssignment，请使用：
{
kind: 'roleAssignment'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
principalIds: any(Azure.Bicep.Types.Concrete.AnyType)
resourceGroup: 'string'
roleDefinitionId: 'string'
}
}
对于 模板，请使用：
{
kind: 'template'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
resourceGroup: 'string'
template: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
属性值
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
Microsoft.Blueprint/blueprints/artifacts
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 policyAssignment |
“policyAssignment” “roleAssignment” “template”（必需） |
| 名字 | 资源名称 | string （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：蓝图 |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
PolicyAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “policyAssignment”（必需） |
| 性能 | policyAssignment Artifact 的属性 | PolicyAssignmentArtifactProperties（必需） |
PolicyAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 策略定义的参数值。 | PolicyAssignmentArtifactPropertiesParameters （必需） |
| policyDefinitionId | 策略定义的 Azure 资源 ID。 | string （必需） |
| resourceGroup | 将向其分配策略的资源组占位符的名称。 | 字符串 |
PolicyAssignmentArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
RoleAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “roleAssignment”（必需） |
| 性能 | 角色分配蓝图项目的属性。 | RoleAssignmentArtifactProperties（必需） |
RoleAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| principalIds | Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。 | 任何（必需） |
| resourceGroup | RoleAssignment 的范围将限定为此 resourceGroup。 如果为空，则范围限定为订阅。 | 字符串 |
| roleDefinitionId | RoleDefinition 的 Azure 资源 ID。 | string （必需） |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
TemplateArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “template”（必需） |
| 性能 | 资源管理器模板蓝图项目的属性。 | TemplateArtifactProperties （必需） |
TemplateArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 资源管理器模板蓝图项目参数值。 | TemplateArtifactPropertiesParameters （必需） |
| resourceGroup | 如果适用，则会将资源管理器模板蓝图项目部署到的资源组占位符的名称。 | 字符串 |
| 模板 | 资源管理器模板蓝图项目正文。 | 任何（必需） |
TemplateArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
ARM 模板资源定义
可以使用目标操作部署蓝图/项目资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprints/artifacts 资源，请将以下 JSON 添加到模板。
{
"name": "string",
"kind": "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 对象
设置 类型 属性以指定对象的类型。
对于 policyAssignment，请使用：
{
"kind": "policyAssignment",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"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": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"resourceGroup": "string",
"template": {}
}
}
属性值
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
Microsoft.Blueprint/blueprints/artifacts
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-11-01-preview' |
| 类 | 对于 policyAssignment |
“policyAssignment” “roleAssignment” “template”（必需） |
| 名字 | 资源名称 | string （必需） |
| 类型 | 资源类型 | “Microsoft.Blueprint/blueprints/artifacts” |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
PolicyAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “policyAssignment”（必需） |
| 性能 | policyAssignment Artifact 的属性 | PolicyAssignmentArtifactProperties（必需） |
PolicyAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 策略定义的参数值。 | PolicyAssignmentArtifactPropertiesParameters （必需） |
| policyDefinitionId | 策略定义的 Azure 资源 ID。 | string （必需） |
| resourceGroup | 将向其分配策略的资源组占位符的名称。 | 字符串 |
PolicyAssignmentArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
RoleAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “roleAssignment”（必需） |
| 性能 | 角色分配蓝图项目的属性。 | RoleAssignmentArtifactProperties（必需） |
RoleAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| principalIds | Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。 | 任何（必需） |
| resourceGroup | RoleAssignment 的范围将限定为此 resourceGroup。 如果为空，则范围限定为订阅。 | 字符串 |
| roleDefinitionId | RoleDefinition 的 Azure 资源 ID。 | string （必需） |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
TemplateArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “template”（必需） |
| 性能 | 资源管理器模板蓝图项目的属性。 | TemplateArtifactProperties （必需） |
TemplateArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 资源管理器模板蓝图项目参数值。 | TemplateArtifactPropertiesParameters （必需） |
| resourceGroup | 如果适用，则会将资源管理器模板蓝图项目部署到的资源组占位符的名称。 | 字符串 |
| 模板 | 资源管理器模板蓝图项目正文。 | 任何（必需） |
TemplateArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
蓝图 - 创建新的蓝图定义
|
此模板创建 Azure 蓝图定义。 蓝图定义包括策略分配项目，可对其进行修改，然后部署到一致的环境的管理组或订阅。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署蓝图/项目资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprints/artifacts 资源，请将以下 Terraform 添加到模板中。
resource "azapi_resource" "symbolicname" {
name = "string"
kind = "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 对象
设置 类型 属性以指定对象的类型。
对于 policyAssignment，请使用：
{
kind = "policyAssignment"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
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 = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
resourceGroup = "string"
template = ?
}
}
属性值
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
Microsoft.Blueprint/blueprints/artifacts
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 对于 policyAssignment |
“policyAssignment” “roleAssignment” “template”（必需） |
| 名字 | 资源名称 | string （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：蓝图 |
| 类型 | 资源类型 | “Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview” |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
PolicyAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “policyAssignment”（必需） |
| 性能 | policyAssignment Artifact 的属性 | PolicyAssignmentArtifactProperties（必需） |
PolicyAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 策略定义的参数值。 | PolicyAssignmentArtifactPropertiesParameters （必需） |
| policyDefinitionId | 策略定义的 Azure 资源 ID。 | string （必需） |
| resourceGroup | 将向其分配策略的资源组占位符的名称。 | 字符串 |
PolicyAssignmentArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
RoleAssignmentArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “roleAssignment”（必需） |
| 性能 | 角色分配蓝图项目的属性。 | RoleAssignmentArtifactProperties（必需） |
RoleAssignmentArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| principalIds | Azure Active Directory 中的用户或组标识数组。 roleDefinition 将应用于每个标识。 | 任何（必需） |
| resourceGroup | RoleAssignment 的范围将限定为此 resourceGroup。 如果为空，则范围限定为订阅。 | 字符串 |
| roleDefinitionId | RoleDefinition 的 Azure 资源 ID。 | string （必需） |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
TemplateArtifact
| 名字 | 描述 | 价值 |
|---|---|---|
| 类 | 指定蓝图项目的类型。 | “template”（必需） |
| 性能 | 资源管理器模板蓝图项目的属性。 | TemplateArtifactProperties （必需） |
TemplateArtifactProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| dependsOn | 需要在指定项目之前部署的项目。 | string[] |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 参数 | 资源管理器模板蓝图项目参数值。 | TemplateArtifactPropertiesParameters （必需） |
| resourceGroup | 如果适用，则会将资源管理器模板蓝图项目部署到的资源组占位符的名称。 | 字符串 |
| 模板 | 资源管理器模板蓝图项目正文。 | 任何（必需） |
TemplateArtifactPropertiesParameters
| 名字 | 描述 | 价值 |
|---|