Policy Restrictions - Check At Management Group Scope

Referentie

Service:: Policy

API Version:: 2023-03-01

Hiermee wordt gecontroleerd welke beperkingen Azure Policy op resources in een beheergroep plaatst.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

URI-parameters

Name	In	Vereist	Type	Description
managementGroupId	path	True	string	Beheergroep-id.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
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.

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 management group scope

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

{
  "pendingFields": [
    {
      "field": "type"
    }
  ]
}

Sample Response

Status code:: 200

{
  "fieldRestrictions": [
    {
      "field": "type",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Microsoft.Compute/virtualMachines"
          ],
          "policy": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyDefinitions/allowedTypes",
            "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "type not allowed"
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": []
  }
}

Definities

Name	Description
CheckManagementGroupRestrictionsRequest	De parameters voor controlebeleidsbeperkingen beschrijven de resource die wordt geëvalueerd.
CheckRestrictionEvaluationDetails	Details van beleidsevaluatie.
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.
ManagementGroupsNamespaceType	De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan.
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.

CheckManagementGroupRestrictionsRequest

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

Name	Type	Description
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.

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.

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 voor 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. Hiermee wordt aangegeven of de gedeeltelijke inhoud die is opgegeven, in de huidige staat 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[]	Details van interne fouten.
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 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 het beleid vereist of weigert 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 op dat veld zijn geplaatst.

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.

ManagementGroupsNamespaceType

De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan.

Name	Type	Description
Microsoft.Management	string

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