Policy Restrictions - Check At Subscription Scope

サブスクリプション内のリソースにAzure Policyされる制限を確認します。

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

URI パラメーター

Name In Required Type Description
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

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Check policy restrictions at subscription scope

Sample Request

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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

リソースに対するポリシー評価の結果。 通常、これは "非準拠" ですが、エラーが発生した場合は他の値が含まれる可能性があります。

policyInfo

評価されたポリシーの詳細。

PolicyReference

ポリシーのリソース識別子。

Name Type Description
policyAssignmentId
  • string

ポリシー割り当てのリソース識別子。

policyDefinitionId
  • string

ポリシー定義のリソース識別子。

policyDefinitionReferenceId
  • string

ポリシー セット定義内の特定のポリシー定義の参照識別子。

policySetDefinitionId
  • string

ポリシー セット定義のリソース識別子。

TypedErrorInfo

シナリオ固有のエラーの詳細。

Name Type Description
info

シナリオ固有のエラーの詳細。

type
  • string

含まれるエラーの詳細の種類。