你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.BlueprintAssignments
Bicep 资源定义
可以使用目标操作部署 blueprintAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
scope: resourceSymbolicName or scope
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
blueprintId: 'string'
description: 'string'
displayName: 'string'
locks: {
excludedActions: [
'string'
]
excludedPrincipals: [
'string'
]
mode: 'string'
}
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
resourceGroups: {
{customized property}: {
location: 'string'
name: 'string'
}
}
scope: 'string'
}
}
属性值
AssignmentLockSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| excludedActions | 从蓝图锁中排除的管理操作列表。 最多允许 200 个操作。 如果锁定模式设置为“AllResourcesReadOnly”，则以下操作会自动追加到“excludedActions”、“Microsoft.Network/virtualNetworks/subnets/join/action”和“Microsoft.Authorization/locks/delete”。 如果锁定模式设置为“AllResourcesDoNotDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
| 模式 | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” “None” |
AssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blueprintId | 蓝图定义的已发布版本的 ID。 | 字符串 |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 锁 | 定义蓝图分配部署的资源被锁定的方式。 | AssignmentLockSettings |
| 参数 | 蓝图分配参数值。 | AssignmentPropertiesParameters （必需） |
| resourceGroups | 资源组占位符的名称和位置。 | AssignmentPropertiesResourceGroups （必需） |
| 范围 | 蓝图分配的目标订阅范围（格式：“/subscriptions/{subscriptionId}”。 对于管理组级别分配，属性是必需的。 | 字符串 |
AssignmentPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
AssignmentPropertiesResourceGroups
| 名字 | 描述 | 价值 |
|---|
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
ManagedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
| tenantId | Azure Active Directory 的 ID。 | 字符串 |
| 类型 | 托管标识的类型。 | “None” “SystemAssigned” “UserAssigned”（必需） |
| userAssignedIdentities | 与资源关联的用户分配托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.Blueprint/blueprintAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | 此蓝图分配的托管标识。 | ManagedServiceIdentity （必需） |
| 位置 | 此蓝图分配的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 蓝图分配对象的属性。 | AssignmentProperties （必需） |
| 范围 | 在与部署范围不同的范围内创建资源时使用。 | 将此属性设置为资源的符号名称，以应用 扩展资源。 |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
ResourceGroupValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源组的位置。 | 字符串 |
| 名字 | 资源组的名称。 | 字符串 约束： 最小长度 = 1 最大长度 = 1 |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 与此标识关联的客户端应用 ID。 | 字符串 |
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
ARM 模板资源定义
可以使用目标操作部署 blueprintAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Blueprint/blueprintAssignments",
"apiVersion": "2018-11-01-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"blueprintId": "string",
"description": "string",
"displayName": "string",
"locks": {
"excludedActions": [ "string" ],
"excludedPrincipals": [ "string" ],
"mode": "string"
},
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"resourceGroups": {
"{customized property}": {
"location": "string",
"name": "string"
}
},
"scope": "string"
}
}
属性值
AssignmentLockSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| excludedActions | 从蓝图锁中排除的管理操作列表。 最多允许 200 个操作。 如果锁定模式设置为“AllResourcesReadOnly”，则以下操作会自动追加到“excludedActions”、“Microsoft.Network/virtualNetworks/subnets/join/action”和“Microsoft.Authorization/locks/delete”。 如果锁定模式设置为“AllResourcesDoNotDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
| 模式 | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” “None” |
AssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blueprintId | 蓝图定义的已发布版本的 ID。 | 字符串 |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 锁 | 定义蓝图分配部署的资源被锁定的方式。 | AssignmentLockSettings |
| 参数 | 蓝图分配参数值。 | AssignmentPropertiesParameters （必需） |
| resourceGroups | 资源组占位符的名称和位置。 | AssignmentPropertiesResourceGroups （必需） |
| 范围 | 蓝图分配的目标订阅范围（格式：“/subscriptions/{subscriptionId}”。 对于管理组级别分配，属性是必需的。 | 字符串 |
AssignmentPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
AssignmentPropertiesResourceGroups
| 名字 | 描述 | 价值 |
|---|
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
ManagedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
| tenantId | Azure Active Directory 的 ID。 | 字符串 |
| 类型 | 托管标识的类型。 | “None” “SystemAssigned” “UserAssigned”（必需） |
| userAssignedIdentities | 与资源关联的用户分配托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.Blueprint/blueprintAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-11-01-preview' |
| 身份 | 此蓝图分配的托管标识。 | ManagedServiceIdentity （必需） |
| 位置 | 此蓝图分配的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 蓝图分配对象的属性。 | AssignmentProperties （必需） |
| 类型 | 资源类型 | “Microsoft.Blueprint/blueprintAssignments” |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
ResourceGroupValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源组的位置。 | 字符串 |
| 名字 | 资源组的名称。 | 字符串 约束： 最小长度 = 1 最大长度 = 1 |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 与此标识关联的客户端应用 ID。 | 字符串 |
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 blueprintAssignments 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Blueprint/blueprintAssignments 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"
name = "string"
parent_id = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
body = jsonencode({
properties = {
blueprintId = "string"
description = "string"
displayName = "string"
locks = {
excludedActions = [
"string"
]
excludedPrincipals = [
"string"
]
mode = "string"
}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
resourceGroups = {
{customized property} = {
location = "string"
name = "string"
}
}
scope = "string"
}
})
}
属性值
AssignmentLockSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| excludedActions | 从蓝图锁中排除的管理操作列表。 最多允许 200 个操作。 如果锁定模式设置为“AllResourcesReadOnly”，则以下操作会自动追加到“excludedActions”、“Microsoft.Network/virtualNetworks/subnets/join/action”和“Microsoft.Authorization/locks/delete”。 如果锁定模式设置为“AllResourcesDoNotDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。 | string[] |
| 模式 | 锁定模式。 | “AllResourcesDoNotDelete” “AllResourcesReadOnly” “None” |
AssignmentProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blueprintId | 蓝图定义的已发布版本的 ID。 | 字符串 |
| 描述 | 多行说明此资源。 | 字符串 约束： 最大长度 = |
| displayName | 单行字符串解释此资源。 | 字符串 约束： 最大长度 = |
| 锁 | 定义蓝图分配部署的资源被锁定的方式。 | AssignmentLockSettings |
| 参数 | 蓝图分配参数值。 | AssignmentPropertiesParameters （必需） |
| resourceGroups | 资源组占位符的名称和位置。 | AssignmentPropertiesResourceGroups （必需） |
| 范围 | 蓝图分配的目标订阅范围（格式：“/subscriptions/{subscriptionId}”。 对于管理组级别分配，属性是必需的。 | 字符串 |
AssignmentPropertiesParameters
| 名字 | 描述 | 价值 |
|---|
AssignmentPropertiesResourceGroups
| 名字 | 描述 | 价值 |
|---|
KeyVaultReference
| 名字 | 描述 | 价值 |
|---|---|---|
| id | Key Vault 的 Azure 资源 ID。 | string （必需） |
ManagedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |
| tenantId | Azure Active Directory 的 ID。 | 字符串 |
| 类型 | 托管标识的类型。 | “None” “SystemAssigned” “UserAssigned”（必需） |
| userAssignedIdentities | 与资源关联的用户分配托管标识的列表。 密钥是托管标识的 Azure 资源 ID。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
Microsoft.Blueprint/blueprintAssignments
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | 此蓝图分配的托管标识。 | ManagedServiceIdentity （必需） |
| 位置 | 此蓝图分配的位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| parent_id | 要向其应用此扩展资源的资源的 ID。 | string （必需） |
| 性能 | 蓝图分配对象的属性。 | AssignmentProperties （必需） |
| 类型 | 资源类型 | “Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview” |
ParameterValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 参考 | 参数值作为引用类型。 | SecretValueReference |
| 价值 | 参数值。 允许任何有效的 JSON 值，包括对象、数组、字符串、数字和布尔值。 | 任何 |
ResourceGroupValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源组的位置。 | 字符串 |
| 名字 | 资源组的名称。 | 字符串 约束： 最小长度 = 1 最大长度 = 1 |
SecretValueReference
| 名字 | 描述 | 价值 |
|---|---|---|
| keyVault | 指定对给定 Azure Key Vault 的引用。 | KeyVaultReference（必需） |
| secretName | 机密的名称。 | string （必需） |
| secretVersion | 要使用的机密版本。 如果留空，则使用最新版本的机密。 | 字符串 |
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 与此标识关联的客户端应用 ID。 | 字符串 |
| principalId | 与此标识关联的 Azure Active Directory 主体 ID。 | 字符串 |