Policy Restrictions - Check At Subscription Scope

Überprüft, welche Einschränkungen Azure Policy in einer Ressource innerhalb eines Abonnements platziert werden.

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

URI-Parameter

Name In Required Type Description
subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Required Type Description
resourceDetails True

Die Informationen zu der Ressource, die ausgewertet werden soll.

pendingFields

Die Liste der Felder und Werte, die für potenzielle Einschränkungen ausgewertet werden sollen.

Antworten

Name Type Description
200 OK

Die Einschränkungen, die durch Azure Policy auf die Ressource platziert werden.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
            }
          ]
        }
      }
    ]
  }
}

Definitionen

CheckRestrictionsRequest

Die Parameter der Überprüfungsrichtlinieneinschränkungen, die die zu bewertende Ressource beschreiben.

CheckRestrictionsResourceDetails

Die Informationen zu der Ressource, die ausgewertet werden soll.

CheckRestrictionsResult

Das Ergebnis einer Überprüfungsrichtlinieneinschränkungsauswertung für eine Ressource.

ContentEvaluationResult

Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt.

ErrorDefinition

Fehlerdefinition.

ErrorResponse

Fehlerantwort.

ExpressionEvaluationDetails

Bewertungsdetails von Richtlinienspracheausdrücken.

FieldRestriction

Die Einschränkungen für ein Feld, das von einer bestimmten Richtlinie auferlegt wird.

FieldRestrictionResult

Die Art der Einschränkung, die für das Feld auferlegt wird.

FieldRestrictions

Die Einschränkungen, die in einem Feld in der Ressource nach Richtlinie platziert werden.

IfNotExistsEvaluationDetails

Bewertungsdetails des IfNotExists-Effekts.

PendingField

Ein Feld, das gegen Azure Policy ausgewertet werden soll, um Einschränkungen zu ermitteln.

PolicyEvaluationDetails

Details zur Richtlinienauswertung.

PolicyEvaluationResult

Das Ergebnis einer nicht konformen Richtlinienauswertung für den angegebenen Ressourceninhalt.

PolicyReference

Ressourcenbezeichner für eine Richtlinie.

TypedErrorInfo

Szenariospezifische Fehlerdetails.

CheckRestrictionsRequest

Die Parameter der Überprüfungsrichtlinieneinschränkungen, die die zu bewertende Ressource beschreiben.

Name Type Description
pendingFields

Die Liste der Felder und Werte, die für potenzielle Einschränkungen ausgewertet werden sollen.

resourceDetails

Die Informationen zu der Ressource, die ausgewertet werden soll.

CheckRestrictionsResourceDetails

Die Informationen zu der Ressource, die ausgewertet werden soll.

Name Type Description
apiVersion
  • string

Die API-Version des Ressourceninhalts.

resourceContent
  • object

Der Ressourceninhalt. Dies sollte alle eigenschaften enthalten, die bereits bekannt sind und eine partielle Gruppe aller Ressourceneigenschaften sein können.

scope
  • string

Der Bereich, in dem die Ressource erstellt wird. Wenn die Ressource beispielsweise eine untergeordnete Ressource ist, wäre dies die Ressourcen-ID der übergeordneten Ressource.

CheckRestrictionsResult

Das Ergebnis einer Überprüfungsrichtlinieneinschränkungsauswertung für eine Ressource.

Name Type Description
contentEvaluationResult

Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt.

fieldRestrictions

Die Einschränkungen, die auf verschiedenen Feldern in der Ressource nach Richtlinie platziert werden.

ContentEvaluationResult

Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt.

Name Type Description
policyEvaluations

Ergebnisse der Richtlinienauswertung anhand des angegebenen Ressourceninhalts. Dies zeigt an, ob der bereitgestellte Teilinhalt wie folgt verweigert wird.

ErrorDefinition

Fehlerdefinition.

Name Type Description
additionalInfo

Zusätzliche Szenariospezifische Fehlerdetails.

code
  • string

Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.

details

Interne Fehlerdetails.

message
  • string

Beschreibung des Fehlers

target
  • string

Das Ziel des Fehlers.

ErrorResponse

Fehlerantwort.

Name Type Description
error

Die Fehlerdetails.

ExpressionEvaluationDetails

Bewertungsdetails von Richtlinienspracheausdrücken.

Name Type Description
expression
  • string

Ausdruck ausgewertet.

expressionKind
  • string

Die Art des Ausdrucks, der ausgewertet wurde.

expressionValue
  • object

Wert des Ausdrucks.

operator
  • string

Operator zum Vergleichen des Ausdruckswerts und des Zielwerts.

path
  • string

Eigenschaftspfad, wenn der Ausdruck ein Feld oder ein Alias ist.

result
  • string

Auswertungsergebnis.

targetValue
  • object

Zielwert, der mit dem Ausdruckswert verglichen werden soll.

FieldRestriction

Die Einschränkungen für ein Feld, das von einer bestimmten Richtlinie auferlegt wird.

Name Type Description
defaultValue
  • string

Der Wert, den diese Richtlinie für das Feld festgelegt wird, wenn der Benutzer keinen Wert bereitstellt.

policy

Die Details der Richtlinie, die die Feldeinschränkung verursacht.

result

Die Art der Einschränkung, die für das Feld auferlegt wird.

values
  • string[]

Die Werte, die die Richtlinie entweder erfordert oder verweigert, für das Feld.

FieldRestrictionResult

Die Art der Einschränkung, die für das Feld auferlegt wird.

Name Type Description
Deny
  • string

Das Feld und/oder die Werte werden von der Richtlinie verweigert.

Removed
  • string

Das Feld wird von der Richtlinie entfernt.

Required
  • string

Das Feld und/oder die Werte sind von der Richtlinie erforderlich.

FieldRestrictions

Die Einschränkungen, die in einem Feld in der Ressource nach Richtlinie platziert werden.

Name Type Description
field
  • string

Der Name des Felds. Dies kann eine Eigenschaft auf oberster Ebene wie "Name" oder "Type" oder ein Azure Policy Feldalias sein.

restrictions

Die Einschränkungen für dieses Feld nach Richtlinie.

IfNotExistsEvaluationDetails

Bewertungsdetails des IfNotExists-Effekts.

Name Type Description
resourceId
  • string

ID der zuletzt ausgewerteten Ressource für IfNotExists-Effekt.

totalResources
  • integer

Die Gesamtanzahl der Ressourcen, für die die Existenzbedingung gilt.

PendingField

Ein Feld, das gegen Azure Policy ausgewertet werden soll, um Einschränkungen zu ermitteln.

Name Type Description
field
  • string

Der Name des Felds. Dies kann eine Eigenschaft auf oberster Ebene wie "Name" oder "Type" oder ein Azure Policy Feldalias sein.

values
  • string[]

Die Liste der potenziellen Werte für das Feld, das gegen Azure Policy ausgewertet werden soll.

PolicyEvaluationDetails

Details zur Richtlinienauswertung.

Name Type Description
evaluatedExpressions

Details zu den ausgewerteten Ausdrücken.

ifNotExistsDetails

Bewertungsdetails des IfNotExists-Effekts.

PolicyEvaluationResult

Das Ergebnis einer nicht konformen Richtlinienauswertung für den angegebenen Ressourceninhalt.

Name Type Description
evaluationDetails

Die detaillierten Ergebnisse der Richtlinienausdrücke und -werte, die ausgewertet wurden.

evaluationResult
  • string

Das Ergebnis der Richtlinienauswertung für die Ressource. Dies ist in der Regel "NonCompliant", kann jedoch andere Werte enthalten, wenn Fehler aufgetreten sind.

policyInfo

Die Details der Richtlinie, die ausgewertet wurde.

PolicyReference

Ressourcenbezeichner für eine Richtlinie.

Name Type Description
policyAssignmentId
  • string

Der Ressourcenbezeichner der Richtlinienzuweisung.

policyDefinitionId
  • string

Der Ressourcenbezeichner der Richtliniendefinition.

policyDefinitionReferenceId
  • string

Der Referenzbezeichner einer bestimmten Richtliniendefinition innerhalb einer Richtliniensatzdefinition.

policySetDefinitionId
  • string

Der Ressourcenbezeichner der Richtliniensatzdefinition.

TypedErrorInfo

Szenariospezifische Fehlerdetails.

Name Type Description
info

Die szenariospezifischen Fehlerdetails.

type
  • string

Der Typ der enthaltenen Fehlerdetails.