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

Policy Assignments - List For Resource

检索应用于资源的所有策略分配。
此操作检索与给定资源组和订阅中与指定资源关联的所有策略分配的列表,该分配与可选给定$filter匹配。 $filter的有效值为:“atScope () ”、“atExactScope () ”或“policyDefinitionId eq ”{value}”。 如果未提供$filter,则未筛选列表包括与资源关联的所有策略分配,包括直接应用或从所有包含范围应用的策略分配,以及应用于资源中包含的资源的任何分配。 如果提供了 $filter=atScope () ,则返回的列表包括应用于资源的所有策略分配,这是未筛选列表中除应用于资源中包含的资源之外的所有内容。 如果提供了 $filter=atExactScope () ,则返回的列表仅包括资源级别的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”,则返回的列表包括应用于资源的 ID 为 {value} 的策略定义的所有策略分配。 三个参数以及资源名称用于标识特定资源。 如果资源不是父资源的一部分 (更常见的情况) ,则不应 (或作为“) ”提供父资源路径。 例如,可以将 Web 应用指定为 ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp') 。 如果资源是父资源的一部分,则应提供所有参数。 例如,可以将虚拟机 DNS 名称指定为 ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName') 。 单独提供命名空间和类型名称的简便替代方法是以 {resourceType} 参数、格式提供两者: ({resourceProviderNamespace} == '',{parentResourcePath} == == ', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp') 。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments?api-version=2021-06-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$top={$top}&api-version=2021-06-01

URI 参数

Name In Required Type Description
parentResourcePath
path True
  • string

父资源路径。 如果没有,请使用空字符串。

resourceGroupName
path True
  • string

包含资源的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+$

resourceName
path True
  • string

资源的名称。

resourceProviderNamespace
path True
  • string

资源提供程序的命名空间。 例如,虚拟机的命名空间是 Microsoft.Compute/virtualMachines) 中的 Microsoft.Compute (

resourceType
path True
  • string

资源类型名称。 例如,Web 应用的类型名称是 Microsoft.Web/sites) (的“sites”。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于操作的 API 版本。

$filter
query
  • string

要应用于操作的筛选器。 $filter的有效值为:“atScope () ”、“atExactScope () ”或“policyDefinitionId eq'{value}”。 如果未提供$filter,则不执行筛选。 如果提供了 $filter=atScope () ,则返回的列表仅包括应用于作用域的所有策略分配,这是未筛选列表中的所有内容,但应用于给定作用域中包含的子范围除外。 如果提供了 $filter=atExactScope () ,则返回的列表仅包括给定范围内的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”,则返回的列表包括 ID 为 {value} 的策略定义的所有策略分配。

$top
query
  • integer
int32

要返回的最大记录数。 如果未提供$top筛选器,它将返回 500 条记录。

响应

Name Type Description
200 OK

确定 - 返回策略分配数组。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List all policy assignments that apply to a resource

Sample Request

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/domainNames/MyTestComputer.cloudapp.net/providers/Microsoft.Authorization/policyAssignments?api-version=2021-06-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestCostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "VM Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/vmSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestTagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup",
        "notScopes": []
      }
    }
  ]
}

定义

CloudError

策略操作的错误响应。

createdByType

创建资源的标识的类型。

enforcementMode

策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorResponse

错误响应

Identity

资源的标识。 策略分配最多支持一个标识。 这是系统分配的标识或单个用户分配的标识。

NonComplianceMessage

描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息中,以及资源的不符合符合性结果。

ParameterValuesValue

参数的值。

PolicyAssignment

策略分配。

PolicyAssignmentListResult

策略分配列表。

ResourceIdentityType

标识类型。 将系统或用户分配的标识添加到资源时,这是唯一必需的字段。

systemData

与创建和上次修改资源相关的元数据。

UserAssignedIdentities

与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

CloudError

策略操作的错误响应。

Name Type Description
error

错误响应
所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

enforcementMode

策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。

Name Type Description
Default
  • string

在创建或更新资源期间强制实施策略效果。

DoNotEnforce
  • string

在资源创建或更新期间不会强制实施策略效果。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorResponse

错误响应

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

Identity

资源的标识。 策略分配最多支持一个标识。 这是系统分配的标识或单个用户分配的标识。

Name Type Description
principalId
  • string

资源标识的主体 ID。 仅为系统分配的标识提供此属性

tenantId
  • string

资源标识的租户 ID。 仅为系统分配的标识提供此属性

type

标识类型。 将系统或用户分配的标识添加到资源时,这是唯一必需的字段。

userAssignedIdentities

与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

NonComplianceMessage

描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息中,以及资源的不符合符合性结果。

Name Type Description
message
  • string

描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息中,以及资源的不符合符合性结果。

policyDefinitionReferenceId
  • string

消息适用于的策略集定义中的策略定义引用 ID。 仅当策略分配分配策略集定义时,才适用。 如果未提供此消息,则消息适用于此策略分配分配的所有策略。

ParameterValuesValue

参数的值。

Name Type Description
value
  • object

参数值。

PolicyAssignment

策略分配。

Name Type Default Value Description
id
  • string

策略分配的 ID。

identity

与策略分配关联的托管标识。

location
  • string

策略分配的位置。 仅当使用托管标识时才需要。

name
  • string

策略分配的名称。

properties.description
  • string

如果发生策略冲突,此消息将成为响应的一部分。

properties.displayName
  • string

策略分配的显示名称。

properties.enforcementMode Default

策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。

properties.metadata
  • object

策略分配元数据。 元数据是一个开放式结束对象,通常是键值对的集合。

properties.nonComplianceMessages

描述资源不符合策略的原因的消息。

properties.notScopes
  • string[]

策略的排除范围。

properties.parameters

分配的策略规则的参数值。 键是参数名称。

properties.policyDefinitionId
  • string

要分配的策略定义或策略集定义的 ID。

properties.scope
  • string

策略分配的范围。

systemData

与此资源相关的系统元数据。

type
  • string

策略分配的类型。

PolicyAssignmentListResult

策略分配列表。

Name Type Description
nextLink
  • string

用于获取下一组结果的 URL。

value

策略分配的数组。

ResourceIdentityType

标识类型。 将系统或用户分配的标识添加到资源时,这是唯一必需的字段。

Name Type Description
None
  • string

指示没有与资源关联的标识或应删除现有标识。

SystemAssigned
  • string

指示系统分配的标识与资源相关联。

UserAssigned
  • string

指示系统分配的标识与资源相关联。

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

UserAssignedIdentities

与策略关联的用户标识。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Name Type Description