你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Authorization policyAssignments 2024-05-01
Bicep 资源定义
可以使用目标操作部署 policyAssignments 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyAssignments 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Authorization/policyAssignments@2024-05-01' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
assignmentType: 'string'
definitionVersion: 'string'
description: 'string'
displayName: 'string'
enforcementMode: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
nonComplianceMessages: [
{
message: 'string'
policyDefinitionReferenceId: 'string'
}
]
notScopes: [
'string'
]
overrides: [
{
kind: 'string'
selectors: [
{
in: [
'string'
]
kind: 'string'
notIn: [
'string'
]
}
]
value: 'string'
}
]
parameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
resourceSelectors: [
{
name: 'string'
selectors: [
{
in: [
'string'
]
kind: 'string'
notIn: [
'string'
]
}
]
}
]
}
}
属性值
身份
名字 | 描述 | 价值 |
---|---|---|
类型 | 标识类型。 这是将系统或用户分配的标识添加到资源时的唯一必填字段。 | “None” “SystemAssigned” “UserAssigned” |
userAssignedIdentities | 与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
名字 | 描述 | 价值 |
---|
Microsoft.Authorization/policyAssignments
名字 | 描述 | 价值 |
---|---|---|
身份 | 与策略分配关联的托管标识。 | 标识 |
位置 | 策略分配的位置。 仅当使用托管标识时才需要。 | 字符串 |
名字 | 资源名称 | 字符串 约束: 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (必需) |
性能 | 策略分配的属性。 | PolicyAssignmentProperties |
范围 | 在与部署范围不同的范围内创建资源时使用。 | 将此属性设置为资源的符号名称,以应用 扩展资源。 |
NonComplianceMessage
名字 | 描述 | 价值 |
---|---|---|
消息 | 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中,以及资源的不符合符合性结果。 | string (必需) |
policyDefinitionReferenceId | 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息,则消息适用于此策略分配分配的所有策略。 | 字符串 |
覆盖
名字 | 描述 | 价值 |
---|---|---|
类 | 重写类型。 | “definitionVersion” “policyEffect” |
选择 | 选择器表达式的列表。 | 选择器[] |
价值 | 要重写策略属性的值。 | 字符串 |
ParameterValues
名字 | 描述 | 价值 |
---|
ParameterValuesValue
名字 | 描述 | 价值 |
---|---|---|
价值 | 参数的值。 | 任何 |
PolicyAssignmentProperties
名字 | 描述 | 价值 |
---|---|---|
assignmentType | 策略分配的类型。 可能的值为 NotSpecified、System、SystemHidden 和 Custom。 变。 | “Custom” “NotSpecified” “System” “SystemHidden” |
definitionVersion | 要使用的策略定义的版本。 | 字符串 |
描述 | 如果发生策略冲突,此消息将是响应的一部分。 | 字符串 |
displayName | 策略分配的显示名称。 | 字符串 |
enforcementMode | 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 | “Default” “DoNotEnforce” |
元数据 | 策略分配元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
nonComplianceMessages | 描述资源不符合策略的原因的消息。 | NonComplianceMessage[] |
notScopes | 策略的排除范围。 | string[] |
重写 | 策略属性值重写。 | 替代[] |
参数 | 分配的策略规则的参数值。 键是参数名称。 | ParameterValues |
policyDefinitionId | 要分配的策略定义或策略集定义的 ID。 | 字符串 |
resourceSelectors | 按资源属性筛选策略的资源选择器列表。 | ResourceSelector[] |
ResourceSelector
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源选择器的名称。 | 字符串 |
选择 | 选择器表达式的列表。 | 选择器[] |
选择器
名字 | 描述 | 价值 |
---|---|---|
在 | 要筛选的值列表。 | string[] |
类 | 选择器类型。 | 'policyDefinitionReferenceId' “resourceLocation” “resourceType” “resourceWithoutLocation” |
notIn | 要筛选出的值列表。 | string[] |
UserAssignedIdentitiesValue
名字 | 描述 | 价值 |
---|
快速入门示例
以下快速入门示例部署此资源类型。
Bicep 文件 | 描述 |
---|---|
分配内置策略以审核 VM 托管磁盘 | 此模板将内置策略分配给资源组范围以审核虚拟机(VM)托管磁盘。 |
创建 Azure 虚拟网络管理器和示例 VNET | 此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。 |
部署策略 def 并将其分配给多个 Mgmt 组 | 此模板是一个管理组级模板,用于创建策略定义并将该策略分配给多个管理组。 |
部署策略定义并分配给管理组 | 此模板是一个管理组级模板,用于创建策略定义并将该策略分配给目标管理组。 目前,无法通过 Azure 门户部署此模板。 |
ARM 模板资源定义
可以使用目标操作部署 policyAssignments 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyAssignments 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Authorization/policyAssignments",
"apiVersion": "2024-05-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"assignmentType": "string",
"definitionVersion": "string",
"description": "string",
"displayName": "string",
"enforcementMode": "string",
"metadata": {},
"nonComplianceMessages": [
{
"message": "string",
"policyDefinitionReferenceId": "string"
}
],
"notScopes": [ "string" ],
"overrides": [
{
"kind": "string",
"selectors": [
{
"in": [ "string" ],
"kind": "string",
"notIn": [ "string" ]
}
],
"value": "string"
}
],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"resourceSelectors": [
{
"name": "string",
"selectors": [
{
"in": [ "string" ],
"kind": "string",
"notIn": [ "string" ]
}
]
}
]
}
}
属性值
身份
名字 | 描述 | 价值 |
---|---|---|
类型 | 标识类型。 这是将系统或用户分配的标识添加到资源时的唯一必填字段。 | “None” “SystemAssigned” “UserAssigned” |
userAssignedIdentities | 与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
名字 | 描述 | 价值 |
---|
Microsoft.Authorization/policyAssignments
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | '2024-05-01' |
身份 | 与策略分配关联的托管标识。 | 标识 |
位置 | 策略分配的位置。 仅当使用托管标识时才需要。 | 字符串 |
名字 | 资源名称 | 字符串 约束: 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (必需) |
性能 | 策略分配的属性。 | PolicyAssignmentProperties |
类型 | 资源类型 | “Microsoft.Authorization/policyAssignments” |
NonComplianceMessage
名字 | 描述 | 价值 |
---|---|---|
消息 | 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中,以及资源的不符合符合性结果。 | string (必需) |
policyDefinitionReferenceId | 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息,则消息适用于此策略分配分配的所有策略。 | 字符串 |
覆盖
名字 | 描述 | 价值 |
---|---|---|
类 | 重写类型。 | “definitionVersion” “policyEffect” |
选择 | 选择器表达式的列表。 | 选择器[] |
价值 | 要重写策略属性的值。 | 字符串 |
ParameterValues
名字 | 描述 | 价值 |
---|
ParameterValuesValue
名字 | 描述 | 价值 |
---|---|---|
价值 | 参数的值。 | 任何 |
PolicyAssignmentProperties
名字 | 描述 | 价值 |
---|---|---|
assignmentType | 策略分配的类型。 可能的值为 NotSpecified、System、SystemHidden 和 Custom。 变。 | “Custom” “NotSpecified” “System” “SystemHidden” |
definitionVersion | 要使用的策略定义的版本。 | 字符串 |
描述 | 如果发生策略冲突,此消息将是响应的一部分。 | 字符串 |
displayName | 策略分配的显示名称。 | 字符串 |
enforcementMode | 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 | “Default” “DoNotEnforce” |
元数据 | 策略分配元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
nonComplianceMessages | 描述资源不符合策略的原因的消息。 | NonComplianceMessage[] |
notScopes | 策略的排除范围。 | string[] |
重写 | 策略属性值重写。 | 替代[] |
参数 | 分配的策略规则的参数值。 键是参数名称。 | ParameterValues |
policyDefinitionId | 要分配的策略定义或策略集定义的 ID。 | 字符串 |
resourceSelectors | 按资源属性筛选策略的资源选择器列表。 | ResourceSelector[] |
ResourceSelector
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源选择器的名称。 | 字符串 |
选择 | 选择器表达式的列表。 | 选择器[] |
选择器
名字 | 描述 | 价值 |
---|---|---|
在 | 要筛选的值列表。 | string[] |
类 | 选择器类型。 | 'policyDefinitionReferenceId' “resourceLocation” “resourceType” “resourceWithoutLocation” |
notIn | 要筛选出的值列表。 | string[] |
UserAssignedIdentitiesValue
名字 | 描述 | 价值 |
---|
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
将内置策略分配给现有资源组 |
此模板将内置策略分配给现有资源组。 |
分配内置策略以审核 VM 托管磁盘 |
此模板将内置策略分配给资源组范围以审核虚拟机(VM)托管磁盘。 |
创建 Azure 虚拟网络管理器和示例 VNET |
此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。 |
部署策略 def 并将其分配给多个 Mgmt 组 |
此模板是一个管理组级模板,用于创建策略定义并将该策略分配给多个管理组。 |
部署策略定义并分配给管理组 |
此模板是一个管理组级模板,用于创建策略定义并将该策略分配给目标管理组。 目前,无法通过 Azure 门户部署此模板。 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 policyAssignments 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyAssignments 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyAssignments@2024-05-01"
name = "string"
parent_id = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
body = jsonencode({
properties = {
assignmentType = "string"
definitionVersion = "string"
description = "string"
displayName = "string"
enforcementMode = "string"
metadata = ?
nonComplianceMessages = [
{
message = "string"
policyDefinitionReferenceId = "string"
}
]
notScopes = [
"string"
]
overrides = [
{
kind = "string"
selectors = [
{
in = [
"string"
]
kind = "string"
notIn = [
"string"
]
}
]
value = "string"
}
]
parameters = {
{customized property} = {
value = ?
}
}
policyDefinitionId = "string"
resourceSelectors = [
{
name = "string"
selectors = [
{
in = [
"string"
]
kind = "string"
notIn = [
"string"
]
}
]
}
]
}
})
}
属性值
身份
名字 | 描述 | 价值 |
---|---|---|
类型 | 标识类型。 这是将系统或用户分配的标识添加到资源时的唯一必填字段。 | “None” “SystemAssigned” “UserAssigned” |
userAssignedIdentities | 与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
名字 | 描述 | 价值 |
---|
Microsoft.Authorization/policyAssignments
名字 | 描述 | 价值 |
---|---|---|
身份 | 与策略分配关联的托管标识。 | 标识 |
位置 | 策略分配的位置。 仅当使用托管标识时才需要。 | 字符串 |
名字 | 资源名称 | 字符串 约束: 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (必需) |
parent_id | 要向其应用此扩展资源的资源的 ID。 | string (必需) |
性能 | 策略分配的属性。 | PolicyAssignmentProperties |
类型 | 资源类型 | “Microsoft.Authorization/policyAssignments@2024-05-01” |
NonComplianceMessage
名字 | 描述 | 价值 |
---|---|---|
消息 | 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中,以及资源的不符合符合性结果。 | string (必需) |
policyDefinitionReferenceId | 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息,则消息适用于此策略分配分配的所有策略。 | 字符串 |
覆盖
名字 | 描述 | 价值 |
---|---|---|
类 | 重写类型。 | “definitionVersion” “policyEffect” |
选择 | 选择器表达式的列表。 | 选择器[] |
价值 | 要重写策略属性的值。 | 字符串 |
ParameterValues
名字 | 描述 | 价值 |
---|
ParameterValuesValue
名字 | 描述 | 价值 |
---|---|---|
价值 | 参数的值。 | 任何 |
PolicyAssignmentProperties
名字 | 描述 | 价值 |
---|---|---|
assignmentType | 策略分配的类型。 可能的值为 NotSpecified、System、SystemHidden 和 Custom。 变。 | “Custom” “NotSpecified” “System” “SystemHidden” |
definitionVersion | 要使用的策略定义的版本。 | 字符串 |
描述 | 如果发生策略冲突,此消息将是响应的一部分。 | 字符串 |
displayName | 策略分配的显示名称。 | 字符串 |
enforcementMode | 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 | “Default” “DoNotEnforce” |
元数据 | 策略分配元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
nonComplianceMessages | 描述资源不符合策略的原因的消息。 | NonComplianceMessage[] |
notScopes | 策略的排除范围。 | string[] |
重写 | 策略属性值重写。 | 替代[] |
参数 | 分配的策略规则的参数值。 键是参数名称。 | ParameterValues |
policyDefinitionId | 要分配的策略定义或策略集定义的 ID。 | 字符串 |
resourceSelectors | 按资源属性筛选策略的资源选择器列表。 | ResourceSelector[] |
ResourceSelector
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源选择器的名称。 | 字符串 |
选择 | 选择器表达式的列表。 | 选择器[] |
选择器
名字 | 描述 | 价值 |
---|---|---|
在 | 要筛选的值列表。 | string[] |
类 | 选择器类型。 | 'policyDefinitionReferenceId' “resourceLocation” “resourceType” “resourceWithoutLocation” |
notIn | 要筛选出的值列表。 | string[] |
UserAssignedIdentitiesValue
名字 | 描述 | 价值 |
---|