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

Policy Assignments - Get

参考

服务:: Policy

API 版本:: 2023-04-01

检索策略分配。
此操作检索单个策略分配，给定其名称和创建范围。

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01

具有可选参数:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?$expand={$expand}&api-version=2023-04-01

URI 参数

名称	在	必需	类型	说明
policyAssignmentName	path	True	string	要获取的策略分配的名称。正则表达式模式: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
scope	path	True	string	策略分配的范围。有效范围包括：管理组（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、订阅（格式：'/subscriptions/{subscriptionId}'）、资源组（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'，或资源（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	用于此操作的 API 版本。
$expand	query		string	要包含在响应中的其他属性的逗号分隔列表。支持的值为“LatestDefinitionVersion， EffectiveDefinitionVersion”。

响应

名称	类型	说明
200 OK	PolicyAssignment	确定 - 返回有关策略分配的信息。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Retrieve a policy assignment

Retrieve a policy assignment with a system assigned identity

Retrieve a policy assignment with a user assigned identity

Retrieve a policy assignment with overrides

Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

示例请求

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

示例响应

状态代码:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a system assigned identity

示例请求

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

示例响应

状态代码:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a user assigned identity

示例请求

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

示例响应

状态代码:: 200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with overrides

示例请求

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

示例响应

状态代码:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Retrieve a policy assignment with resource selectors

示例请求

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

示例响应

状态代码:: 200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

定义

名称	说明
CloudError	策略操作的错误响应。
createdByType	创建资源的标识的类型。
enforcementMode	策略分配强制模式。可能的值为 Default 和 DoNotEnforce。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
Identity	资源的标识。策略分配最多支持一个标识。这是系统分配的标识或单个用户分配的标识。
NonComplianceMessage	描述资源不符合策略的原因的消息。这会显示在“拒绝”错误消息中，以及资源的不符合符合性结果。
Override	策略属性值重写。
OverrideKind	重写类型。
ParameterValuesValue	参数的值。
PolicyAssignment	策略分配。
ResourceIdentityType	标识类型。这是将系统或用户分配的标识添加到资源时的唯一必填字段。
ResourceSelector	按资源属性筛选策略的资源选择器。
Selector	选择器表达式。
SelectorKind	选择器类型。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentities	与策略关联的用户标识。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

CloudError

策略操作的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式。）

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

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

名称	类型	说明
Default	string	在资源创建或更新期间强制实施策略效果。
DoNotEnforce	string	在资源创建或更新期间，不会强制实施策略效果。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

Identity

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

名称	类型	说明
principalId	string	资源标识的主体 ID。此属性仅针对系统分配的标识提供
tenantId	string	资源标识的租户 ID。此属性仅针对系统分配的标识提供
type	ResourceIdentityType	标识类型。这是将系统或用户分配的标识添加到资源时的唯一必填字段。
userAssignedIdentities	UserAssignedIdentities	与策略关联的用户标识。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

NonComplianceMessage

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

名称	类型	说明
message	string	描述资源不符合策略的原因的消息。这会显示在“拒绝”错误消息中，以及资源的不符合符合性结果。
policyDefinitionReferenceId	string	消息适用于的策略集定义中的策略定义引用 ID。这仅适用于策略分配分配策略集定义。如果未提供此消息，则消息适用于此策略分配分配的所有策略。

Override

策略属性值重写。

名称	类型	说明
kind	OverrideKind	重写类型。
selectors	Selector[]	选择器表达式的列表。
value	string	要重写策略属性的值。

OverrideKind

重写类型。

名称	类型	说明
policyEffect	string	它将替代策略效果类型。

ParameterValuesValue

参数的值。

名称	类型	说明
value	object	参数的值。

PolicyAssignment

策略分配。

名称	类型	默认值	说明
id	string		策略分配的 ID。
identity	Identity		与策略分配关联的托管标识。
location	string		策略分配的位置。仅当使用托管标识时才需要。
name	string		策略分配的名称。
properties.definitionVersion	string		要使用的策略定义的版本。
properties.description	string		如果发生策略冲突，此消息将是响应的一部分。
properties.displayName	string		策略分配的显示名称。
properties.effectiveDefinitionVersion	string		正在使用的策略定义的有效版本。仅当通过$expand查询参数请求时，才存在此参数。
properties.enforcementMode	enforcementMode	Default	策略分配强制模式。可能的值为 Default 和 DoNotEnforce。
properties.latestDefinitionVersion	string		可用的策略定义的最新版本。仅当通过$expand查询参数请求时，才存在此参数。
properties.metadata	object		策略分配元数据。元数据是一个开放结束的对象，通常是键值对的集合。
properties.nonComplianceMessages	NonComplianceMessage[]		描述资源不符合策略的原因的消息。
properties.notScopes	string[]		策略的排除范围。
properties.overrides	Override[]		策略属性值重写。
properties.parameters	<string, ParameterValuesValue>		分配的策略规则的参数值。键是参数名称。
properties.policyDefinitionId	string		要分配的策略定义或策略集定义的 ID。
properties.resourceSelectors	ResourceSelector[]		按资源属性筛选策略的资源选择器列表。
properties.scope	string		策略分配的范围。
systemData	systemData		与此资源相关的系统元数据。
type	string		策略分配的类型。

ResourceIdentityType

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

名称	类型	说明
None	string	指示没有与资源关联的标识或应删除现有标识。
SystemAssigned	string	指示系统分配的标识与资源相关联。
UserAssigned	string	指示系统分配的标识与资源相关联。

ResourceSelector

按资源属性筛选策略的资源选择器。

名称	类型	说明
name	string	资源选择器的名称。
selectors	Selector[]	选择器表达式的列表。

Selector

选择器表达式。

名称	类型	说明
in	string[]	要筛选的值列表。
kind	SelectorKind	选择器类型。
notIn	string[]	要筛选出的值列表。

SelectorKind

选择器类型。

名称	类型	说明
policyDefinitionReferenceId	string	按策略定义引用 ID 筛选策略的选择器类型。
resourceLocation	string	按资源位置筛选策略的选择器类型。
resourceType	string	按资源类型筛选策略的选择器类型。
resourceWithoutLocation	string	按没有位置的资源筛选策略的选择器类型。

systemData

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

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentities

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

名称	类型	说明

通过

Policy Assignments - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Retrieve a policy assignment

示例请求

示例响应

Retrieve a policy assignment with a system assigned identity

示例请求

示例响应

Retrieve a policy assignment with a user assigned identity

示例请求

示例响应

Retrieve a policy assignment with overrides

示例请求

示例响应

Retrieve a policy assignment with resource selectors

示例请求

示例响应

定义

CloudError

createdByType

enforcementMode

ErrorAdditionalInfo

ErrorResponse

Identity

NonComplianceMessage

Override

OverrideKind

ParameterValuesValue

PolicyAssignment

ResourceIdentityType

ResourceSelector

Selector

SelectorKind

systemData

UserAssignedIdentities

其他资源