Policy Restrictions - Check At Resource Group Scope

Referentie

Service:: Policy

API Version:: 2023-03-01

Controleert welke beperkingen Azure Policy op een resource in een resourcegroep plaatst. Gebruik dit wanneer de resourcegroep waarin de resource wordt gemaakt al bekend is.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
resourceDetails	True	CheckRestrictionsResourceDetails	De informatie over de resource die wordt geëvalueerd.
includeAuditEffect		boolean	Of u beleidsregels met het effect 'audit' wilt opnemen in de resultaten. De standaardinstelling is false.
pendingFields		PendingField[]	De lijst met velden en waarden die moeten worden geëvalueerd op mogelijke beperkingen.

Antwoorden

Name	Type	Description
200 OK	CheckRestrictionsResult	De beperkingen die door Azure Policy op de resource worden geplaatst.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Check policy restrictions at resource group scope

Check policy restrictions at resource group scope including audit effect

Check policy restrictions at resource group scope

Sample Request

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/vmRg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-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

Status code:: 200

{
  "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"
          },
          "policyEffect": "Deny",
          "reason": "tags.newtag is required"
        }
      ]
    },
    {
      "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"
          },
          "policyEffect": "Deny",
          "reason": "tags.environment is required"
        }
      ]
    },
    {
      "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"
          },
          "policyEffect": "Deny",
          "reason": "location must be one of the following: eastus, westus, westus2"
        },
        {
          "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"
          },
          "policyEffect": "Deny",
          "reason": "location must be one of the following: westus2"
        }
      ]
    }
  ],
  "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"
            }
          ]
        },
        "effectDetails": {
          "policyEffect": "Deny"
        }
      }
    ]
  }
}

Check policy restrictions at resource group scope including audit effect

Sample Request

HTTP

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/vmRg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-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"
    }
  ],
  "includeAuditEffect": true
}

Sample Response

Status code:: 200

{
  "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"
          },
          "policyEffect": "Deny",
          "reason": "tags.newtag is required"
        }
      ]
    },
    {
      "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"
          },
          "policyEffect": "Audit",
          "reason": "tags.environment is required"
        }
      ]
    },
    {
      "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"
          },
          "policyEffect": "Deny",
          "reason": "The selected location is not allowed"
        },
        {
          "result": "Audit",
          "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"
          },
          "policyEffect": "Audit",
          "reason": "The selected location is not allowed"
        }
      ]
    }
  ],
  "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"
            }
          ],
          "reason": "Resource creation of the selected type is not allowed"
        },
        "effectDetails": {
          "policyEffect": "Audit"
        }
      }
    ]
  }
}

Definities

Name	Description
CheckRestrictionEvaluationDetails	Details van beleidsevaluatie.
CheckRestrictionsRequest	De parameters voor controlebeleidsbeperkingen die de resource beschrijven die wordt geëvalueerd.
CheckRestrictionsResourceDetails	De informatie over de resource die wordt geëvalueerd.
CheckRestrictionsResult	Het resultaat van een evaluatie van controlebeleidsbeperkingen voor een resource.
ContentEvaluationResult	Evaluatieresultaten voor de opgegeven gedeeltelijke resource-inhoud.
ErrorDefinition	Foutdefinitie.
ErrorResponse	Foutreactie.
ExpressionEvaluationDetails	Evaluatiedetails van beleidstaalexpressies.
FieldRestriction	De beperkingen voor een veld die zijn opgelegd door een specifiek beleid.
FieldRestrictionResult	Het type beperking dat aan het veld wordt opgelegd.
FieldRestrictions	De beperkingen die per beleid voor een veld in de resource worden geplaatst.
IfNotExistsEvaluationDetails	Evaluatiedetails van het IfNotExists-effect.
PendingField	Een veld dat moet worden geëvalueerd op basis van Azure Policy om beperkingen te bepalen.
PolicyEffectDetails	De details van het effect dat is toegepast op de resource.
PolicyEvaluationResult	Het resultaat van een niet-compatibele beleidsevaluatie op basis van de opgegeven resource-inhoud.
PolicyReference	Resource-id's voor een beleid.
TypedErrorInfo	Scenariospecifieke foutdetails.

CheckRestrictionEvaluationDetails

Details van beleidsevaluatie.

Name	Type	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Details van de geëvalueerde expressies.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Evaluatiedetails van het IfNotExists-effect.
reason	string	De reden voor het evaluatieresultaat.

CheckRestrictionsRequest

De parameters voor controlebeleidsbeperkingen die de resource beschrijven die wordt geëvalueerd.

Name	Type	Standaardwaarde	Description
includeAuditEffect	boolean	False	Of u beleidsregels met het effect 'audit' wilt opnemen in de resultaten. De standaardinstelling is false.
pendingFields	PendingField[]		De lijst met velden en waarden die moeten worden geëvalueerd op mogelijke beperkingen.
resourceDetails	CheckRestrictionsResourceDetails		De informatie over de resource die wordt geëvalueerd.

CheckRestrictionsResourceDetails

De informatie over de resource die wordt geëvalueerd.

Name	Type	Description
apiVersion	string	De API-versie van de resource-inhoud.
resourceContent	object	De resource-inhoud. Dit moet de eigenschappen omvatten die al bekend zijn en kan een gedeeltelijke set van alle resource-eigenschappen zijn.
scope	string	Het bereik waarin de resource wordt gemaakt. Als de resource bijvoorbeeld een onderliggende resource is, is dit de resource-id van de bovenliggende resource.

CheckRestrictionsResult

Het resultaat van een evaluatie van controlebeleidsbeperkingen voor een resource.

Name	Type	Description
contentEvaluationResult	ContentEvaluationResult	Evaluatieresultaten voor de opgegeven gedeeltelijke resource-inhoud.
fieldRestrictions	FieldRestrictions[]	De beperkingen die per beleid op verschillende velden in de resource worden geplaatst.

ContentEvaluationResult

Evaluatieresultaten voor de opgegeven gedeeltelijke resource-inhoud.

Name	Type	Description
policyEvaluations	PolicyEvaluationResult[]	Resultaten van beleidsevaluatie op basis van de opgegeven resource-inhoud. Dit geeft aan of de gedeeltelijke inhoud die is opgegeven, wordt geweigerd.

ErrorDefinition

Foutdefinitie.

Name	Type	Description
additionalInfo	TypedErrorInfo[]	Aanvullende scenariospecifieke foutdetails.
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	ErrorDefinition[]	Interne foutdetails.
message	string	Beschrijving van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	ErrorDefinition	De foutdetails.

ExpressionEvaluationDetails

Evaluatiedetails van beleidstaalexpressies.

Name	Type	Description
expression	string	Expressie geëvalueerd.
expressionKind	string	Het type expressie dat is geëvalueerd.
expressionValue	object	Waarde van de expressie.
operator	string	Operator om de expressiewaarde en de doelwaarde te vergelijken.
path	string	Eigenschapspad als de expressie een veld of een alias is.
result	string	Evaluatieresultaat.
targetValue	object	Doelwaarde die moet worden vergeleken met de expressiewaarde.

FieldRestriction

De beperkingen voor een veld die zijn opgelegd door een specifiek beleid.

Name	Type	Description
defaultValue	string	De waarde die door beleid wordt ingesteld voor het veld als de gebruiker geen waarde opgeeft.
policy	PolicyReference	De details van het beleid dat de veldbeperking veroorzaakt.
policyEffect	string	Het effect van het beleid dat de veldbeperking veroorzaakt. http://aka.ms/policyeffects
reason	string	De reden voor de beperking.
result	FieldRestrictionResult	Het type beperking dat aan het veld wordt opgelegd.
values	string[]	De waarden die door beleid worden vereist of geweigerd voor het veld.

FieldRestrictionResult

Het type beperking dat aan het veld wordt opgelegd.

Name	Type	Description
Audit	string	Het veld en/of de waarden worden gecontroleerd door beleid.
Deny	string	Het veld en/of de waarden worden geweigerd door het beleid.
Removed	string	Het veld wordt verwijderd door beleid.
Required	string	Het veld en/of de waarden zijn vereist door beleid.

FieldRestrictions

De beperkingen die per beleid voor een veld in de resource worden geplaatst.

Name	Type	Description
field	string	De naam van het veld. Dit kan een eigenschap op het hoogste niveau zijn, zoals 'naam' of 'type' of een Azure Policy-veldalias.
restrictions	FieldRestriction[]	De beperkingen die op basis van beleid voor dat veld zijn ingesteld.

IfNotExistsEvaluationDetails

Evaluatiedetails van het IfNotExists-effect.

Name	Type	Description
resourceId	string	Id van de laatst geëvalueerde resource voor het IfNotExists-effect.
totalResources	integer	Totaal aantal resources waarop de bestaansvoorwaarde van toepassing is.

PendingField

Een veld dat moet worden geëvalueerd op basis van Azure Policy om beperkingen te bepalen.

Name	Type	Description
field	string	De naam van het veld. Dit kan een eigenschap op het hoogste niveau zijn, zoals 'naam' of 'type' of een Azure Policy-veldalias.
values	string[]	De lijst met mogelijke waarden voor het veld die moeten worden geëvalueerd op basis van Azure Policy.

PolicyEffectDetails

De details van het effect dat is toegepast op de resource.

Name	Type	Description
policyEffect	string	Het effect dat is toegepast op de resource. http://aka.ms/policyeffects

PolicyEvaluationResult

Het resultaat van een niet-compatibele beleidsevaluatie op basis van de opgegeven resource-inhoud.

Name	Type	Description
effectDetails	PolicyEffectDetails	De details van het effect dat is toegepast op de resource.
evaluationDetails	CheckRestrictionEvaluationDetails	De gedetailleerde resultaten van de beleidsexpressies en -waarden die zijn geëvalueerd.
evaluationResult	string	Het resultaat van de beleidsevaluatie op basis van de resource. Dit is doorgaans 'Niet-compatibel', maar kan andere waarden bevatten als er fouten zijn opgetreden.
policyInfo	PolicyReference	De details van het beleid dat is geëvalueerd.

PolicyReference

Resource-id's voor een beleid.

Name	Type	Description
policyAssignmentId	string	De resource-id van de beleidstoewijzing.
policyDefinitionId	string	De resource-id van de beleidsdefinitie.
policyDefinitionReferenceId	string	De referentie-id van een specifieke beleidsdefinitie binnen een beleidssetdefinitie.
policySetDefinitionId	string	De resource-id van de definitie van de beleidsset.

TypedErrorInfo

Scenariospecifieke foutdetails.

Name	Type	Description
info		De specifieke foutdetails van het scenario.
type	string	Het type opgenomen foutdetails.

Delen via

Policy Restrictions - Check At Resource Group Scope

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

Check policy restrictions at resource group scope

Sample Request

Sample Response

Check policy restrictions at resource group scope including audit effect

Sample Request

Sample Response

Definities

CheckRestrictionEvaluationDetails

CheckRestrictionsRequest

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo

Aanvullende resources