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

Policy Restrictions - Check At Resource Group Scope

检查资源组中资源Azure Policy将施加哪些限制。 在资源组中创建资源时使用此资源组已已知。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2020-07-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Required Type Description
resourceDetails True

有关要评估的资源的信息。

pendingFields

应针对潜在限制进行评估的字段和值的列表。

响应

Name Type Description
200 OK

Azure Policy将对资源施加的限制。

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 模拟用户帐户

示例

Check policy restrictions at resource group scope

Sample Request

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/vmRg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2020-07-01

{
  "resourceDetails": {
    "resourceContent": {
      "type": "Microsoft.Compute/virtualMachines",
      "properties": {
        "priority": "Spot"
      }
    },
    "apiVersion": "2019-12-01"
  },
  "pendingFields": [
    {
      "field": "name",
      "values": [
        "myVMName"
      ]
    },
    {
      "field": "location",
      "values": [
        "eastus",
        "westus",
        "westus2",
        "westeurope"
      ]
    },
    {
      "field": "tags"
    }
  ]
}

Sample Response

{
  "fieldRestrictions": [
    {
      "field": "tags.newtag",
      "restrictions": [
        {
          "result": "Required",
          "defaultValue": "defaultVal",
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    },
    {
      "field": "tags.environment",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Prod",
            "Int",
            "Test"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    },
    {
      "field": "location",
      "restrictions": [
        {
          "result": "Deny",
          "values": [
            "west europe"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
            "policyDefinitionReferenceId": "DefRef"
          }
        },
        {
          "result": "Deny",
          "values": [
            "eastus",
            "westus"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": [
      {
        "policyInfo": {
          "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
          "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
          "policyDefinitionReferenceId": "defref222",
          "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
        },
        "evaluationResult": "NonCompliant",
        "evaluationDetails": {
          "evaluatedExpressions": [
            {
              "result": "True",
              "expressionKind": "field",
              "expression": "type",
              "path": "type",
              "expressionValue": "microsoft.compute/virtualmachines",
              "targetValue": "microsoft.compute/virtualmachines",
              "operator": "equals"
            }
          ]
        }
      }
    ]
  }
}

定义

CheckRestrictionsRequest

检查策略限制描述正在评估的资源的参数。

CheckRestrictionsResourceDetails

有关要评估的资源的信息。

CheckRestrictionsResult

对资源进行检查策略限制评估的结果。

ContentEvaluationResult

提供的部分资源内容的评估结果。

ErrorDefinition

错误定义。

ErrorResponse

错误响应。

ExpressionEvaluationDetails

策略语言表达式的评估详细信息。

FieldRestriction

对特定策略施加的字段的限制。

FieldRestrictionResult

对字段施加的限制类型。

FieldRestrictions

将按策略对资源中的字段施加的限制。

IfNotExistsEvaluationDetails

IfNotExists 效果的评估详细信息。

PendingField

应根据Azure Policy进行评估以确定限制的字段。

PolicyEvaluationDetails

策略评估详细信息。

PolicyEvaluationResult

针对给定资源内容进行不合规的策略评估的结果。

PolicyReference

策略的资源标识符。

TypedErrorInfo

方案特定的错误详细信息。

CheckRestrictionsRequest

检查策略限制描述正在评估的资源的参数。

Name Type Description
pendingFields

应针对潜在限制进行评估的字段和值的列表。

resourceDetails

有关要评估的资源的信息。

CheckRestrictionsResourceDetails

有关要评估的资源的信息。

Name Type Description
apiVersion
  • string

资源内容的 API 版本。

resourceContent
  • object

资源内容。 这应包括已知的任何属性,并且可以是所有资源属性的一组部分。

scope
  • string

正在创建资源的范围。 例如,如果资源是子资源,则这将是父资源的资源 ID。

CheckRestrictionsResult

对资源进行检查策略限制评估的结果。

Name Type Description
contentEvaluationResult

提供的部分资源内容的评估结果。

fieldRestrictions

将按策略对资源中的各种字段施加的限制。

ContentEvaluationResult

提供的部分资源内容的评估结果。

Name Type Description
policyEvaluations

针对给定资源内容的策略评估结果。 这将指示是否按原样拒绝提供的部分内容。

ErrorDefinition

错误定义。

Name Type Description
additionalInfo

其他方案特定的错误详细信息。

code
  • string

服务特定的错误代码,用作 HTTP 错误代码的子状态。

details

内部错误详细信息。

message
  • string

错误的说明。

target
  • string

错误的目标。

ErrorResponse

错误响应。

Name Type Description
error

错误详细信息。

ExpressionEvaluationDetails

策略语言表达式的评估详细信息。

Name Type Description
expression
  • string

计算的表达式。

expressionKind
  • string

计算的表达式类型。

expressionValue
  • object

表达式的值。

operator
  • string

用于比较表达式值和目标值的运算符。

path
  • string

如果表达式是字段或别名,则属性路径。

result
  • string

评估结果。

targetValue
  • object

要与表达式值进行比较的目标值。

FieldRestriction

对特定策略施加的字段的限制。

Name Type Description
defaultValue
  • string

如果用户未提供值,策略将为字段设置的值。

policy

导致字段限制的策略的详细信息。

result

对字段施加的限制类型。

values
  • string[]

策略要求或拒绝字段的值。

FieldRestrictionResult

对字段施加的限制类型。

Name Type Description
Deny
  • string

字段和/或值将由策略拒绝。

Removed
  • string

字段将由策略删除。

Required
  • string

策略需要字段和/或值。

FieldRestrictions

将按策略对资源中的字段施加的限制。

Name Type Description
field
  • string

字段的名称。 可以是顶级属性,如“name”或“type”或Azure Policy字段别名。

restrictions

按策略对该字段施加的限制。

IfNotExistsEvaluationDetails

IfNotExists 效果的评估详细信息。

Name Type Description
resourceId
  • string

IfNotExists 效果的最后一个评估资源 ID。

totalResources
  • integer

存在条件适用的资源总数。

PendingField

应根据Azure Policy进行评估以确定限制的字段。

Name Type Description
field
  • string

字段的名称。 可以是顶级属性,如“name”或“type”或Azure Policy字段别名。

values
  • string[]

应针对Azure Policy评估的字段的潜在值列表。

PolicyEvaluationDetails

策略评估详细信息。

Name Type Description
evaluatedExpressions

计算表达式的详细信息。

ifNotExistsDetails

IfNotExists 效果的评估详细信息。

PolicyEvaluationResult

针对给定资源内容进行不合规的策略评估的结果。

Name Type Description
evaluationDetails

计算的策略表达式和值的详细结果。

evaluationResult
  • string

针对资源的策略评估结果。 这通常为“NonCompliant”,但如果遇到错误,则可能包含其他值。

policyInfo

评估的策略的详细信息。

PolicyReference

策略的资源标识符。

Name Type Description
policyAssignmentId
  • string

策略分配的资源标识符。

policyDefinitionId
  • string

策略定义的资源标识符。

policyDefinitionReferenceId
  • string

策略集定义中特定策略定义的引用标识符。

policySetDefinitionId
  • string

策略集定义的资源标识符。

TypedErrorInfo

方案特定的错误详细信息。

Name Type Description
info

方案特定的错误详细信息。

type
  • string

包含的错误详细信息的类型。