你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.BlueprintAssignments
Bicep 资源定义
blueprintAssignments 资源类型是 扩展资源,这意味着你可以将其应用于其他资源。
scope
使用此资源上的 属性可设置此资源的范围。 请参阅 在 Bicep 中设置扩展资源的范围。
blueprintAssignments 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {}
}
properties: {
blueprintId: 'string'
description: 'string'
displayName: 'string'
locks: {
excludedPrincipals: [
'string'
]
mode: 'string'
}
parameters: {}
resourceGroups: {}
scope: 'string'
}
}
属性值
blueprintAssignments
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) 字符限制:90 有效字符: 字母数字、下划线字符和连字符。 |
location | 此蓝图分配的位置。 | 字符串 (必需) |
scope | 在与部署范围不同的范围创建扩展资源时使用 。 | 目标资源 对于 Bicep,请将此属性设置为资源的符号名称以应用 扩展资源。 |
identity | 此蓝图分配的托管标识。 | 需要 managedServiceIdentity () |
properties | 蓝图分配对象的属性。 | AssignmentProperties (必需) |
ManagedServiceIdentity
名称 | 说明 | 值 |
---|---|---|
principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
tenantId | Azure Active Directory 的 ID。 | 字符串 |
type | 托管标识的类型。 | “None” “SystemAssigned” “UserAssigned” (必需) |
userAssignedIdentities | 与资源关联的用户分配的托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | 对象 (object) |
AssignmentProperties
名称 | 说明 | 值 |
---|---|---|
blueprintId | 蓝图定义的已发布版本的 ID。 | 字符串 |
description | 多行说明此资源。 | 字符串 |
displayName | 单行字符串解释此资源。 | 字符串 |
锁定 | 定义如何锁定蓝图分配部署的资源。 | AssignmentLockSettings |
parameters | 蓝图分配参数值。 | 对象 (必需) |
resourceGroups | 资源组占位符的名称和位置。 | 对象 (必需) |
scope | 蓝图分配的目标订阅范围 (格式:“/subscriptions/{subscriptionId}”) 。 对于管理组级别分配,属性是必需的。 | string |
AssignmentLockSettings
名称 | 说明 | 值 |
---|---|---|
excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
mode | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” “None” |
ARM 模板资源定义
blueprintAssignments 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。
scope
使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围。
可以使用面向以下操作部署 blueprintAssignments 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Blueprint/blueprintAssignments",
"apiVersion": "2018-11-01-preview",
"name": "string",
"location": "string",
"scope": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"blueprintId": "string",
"description": "string",
"displayName": "string",
"locks": {
"excludedPrincipals": [ "string" ],
"mode": "string"
},
"parameters": {},
"resourceGroups": {},
"scope": "string"
}
}
属性值
blueprintAssignments
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | 'Microsoft.Blueprint/blueprintAssignments' |
apiVersion | 资源 API 版本 | “2018-11-01-preview” |
name | 资源名称 | 字符串 (必需) 字符限制:90 有效字符: 字母数字、下划线字符和连字符。 |
location | 此蓝图分配的位置。 | 字符串 (必需) |
scope | 在不同于部署范围的范围创建扩展资源时使用 。 | 目标资源 对于 JSON,请将值设置为要向其应用 扩展资源的资源 的全名。 |
identity | 此蓝图分配的托管标识。 | 需要 managedServiceIdentity () |
properties | 蓝图分配对象的属性。 | AssignmentProperties (必需) |
ManagedServiceIdentity
名称 | 说明 | 值 |
---|---|---|
principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | string |
tenantId | Azure Active Directory 的 ID。 | string |
type | 托管标识的类型。 | “None” “SystemAssigned” “UserAssigned” (必需) |
userAssignedIdentities | 与资源关联的用户分配的托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | 对象 (object) |
AssignmentProperties
名称 | 说明 | 值 |
---|---|---|
blueprintId | 蓝图定义的已发布版本的 ID。 | string |
description | 多行说明此资源。 | string |
displayName | 单行字符串解释此资源。 | 字符串 |
锁定 | 定义如何锁定蓝图分配部署的资源。 | AssignmentLockSettings |
parameters | 蓝图分配参数值。 | 对象 (必需) |
resourceGroups | 资源组占位符的名称和位置。 | 对象 (必需) |
scope | 蓝图分配的目标订阅范围 (格式:“/subscriptions/{subscriptionId}”) 。 对于管理组级别分配, 属性是必需的。 | string |
AssignmentLockSettings
名称 | 说明 | 值 |
---|---|---|
excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
mode | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” “None” |
Terraform (AzAPI 提供程序) 资源定义
blueprintAssignments 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。
parent_id
使用此资源上的 属性可设置此资源的作用域。
可以使用面向以下操作部署 blueprintAssignments 资源类型:
- 资源组
- 订阅
- 管理组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
blueprintId = "string"
description = "string"
displayName = "string"
locks = {
excludedPrincipals = [
"string"
]
mode = "string"
}
parameters = {}
resourceGroups = {}
scope = "string"
}
})
}
属性值
blueprintAssignments
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview” |
name | 资源名称 | 字符串 (必需) 字符限制:90 有效字符: 字母数字、下划线字符和连字符。 |
location | 此蓝图分配的位置。 | 字符串 (必需) |
parent_id | 要应用此扩展资源的资源的 ID。 | 字符串 (必需) |
identity | 此蓝图分配的托管标识。 | 需要 managedServiceIdentity () |
properties | 蓝图分配对象的属性。 | AssignmentProperties (必需) |
ManagedServiceIdentity
名称 | 说明 | Value |
---|---|---|
type | 托管标识的类型。 | “SystemAssigned” “UserAssigned” (必需) |
identity_ids | 与资源关联的用户分配的托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | 用户标识 ID 的数组。 |
AssignmentProperties
名称 | 说明 | 值 |
---|---|---|
blueprintId | 蓝图定义的已发布版本的 ID。 | 字符串 |
description | 多行说明此资源。 | 字符串 |
displayName | 单行字符串解释此资源。 | string |
锁定 | 定义如何锁定蓝图分配部署的资源。 | AssignmentLockSettings |
parameters | 蓝图分配参数值。 | 对象 (必需) |
resourceGroups | 资源组占位符的名称和位置。 | 对象 (必需) |
scope | 蓝图分配的目标订阅范围 (格式:“/subscriptions/{subscriptionId}”) 。 对于管理组级别分配, 属性是必需的。 | 字符串 |
AssignmentLockSettings
名称 | 说明 | 值 |
---|---|---|
excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
mode | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” "None" |