Policy Restrictions - Check At Management Group Scope

Referencia

Service:: Policy

API Version:: 2023-03-01

Ellenőrzi, hogy milyen korlátozásokat Azure Policy a felügyeleti csoport erőforrásaira.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
managementGroupId	path	True	string	Felügyeleti csoport azonosítója.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
pendingFields	PendingField[]	Azoknak a mezőknek és értékeknek a listája, amelyeket ki kell értékelni a lehetséges korlátozások szempontjából.
resourceDetails	CheckRestrictionsResourceDetails	A kiértékelendő erőforrással kapcsolatos információk.

Válaszok

Name	Típus	Description
200 OK	CheckRestrictionsResult	A Azure Policy által az erőforrásra helyezendő korlátozások.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
CheckManagementGroupRestrictionsRequest	A kiértékelni kívánt erőforrást leíró szabályzatkorlátozások ellenőrzése paraméterek.
CheckRestrictionEvaluationDetails	Szabályzatértékelés részletei.
CheckRestrictionsResourceDetails	A kiértékelendő erőforrással kapcsolatos információk.
CheckRestrictionsResult	Az ellenőrzésre vonatkozó szabályzatkorlátozások kiértékelésének eredménye egy erőforráson.
ContentEvaluationResult	A megadott részleges erőforrástartalom kiértékelési eredményei.
ErrorDefinition	Hibadefiníció.
ErrorResponse	Hibaválasz.
ExpressionEvaluationDetails	A szabályzatnyelvi kifejezések kiértékelési részletei.
FieldRestriction	Egy adott szabályzat által meghatározott mezőre vonatkozó korlátozások.
FieldRestrictionResult	A mezőre vonatkozó korlátozás típusa.
FieldRestrictions	Azok a korlátozások, amelyek az erőforrás egy mezőjére lesznek helyezve szabályzat szerint.
IfNotExistsEvaluationDetails	Az IfNotExists hatás kiértékelési részletei.
ManagementGroupsNamespaceType	A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.
PendingField	Egy mező, amelyet Azure Policy kell kiértékelni a korlátozások meghatározásához.
PolicyEffectDetails	Az erőforrásra alkalmazott hatás részletei.
PolicyEvaluationResult	Az adott erőforrás-tartalomra vonatkozó, nem megfelelő szabályzatértékelés eredménye.
PolicyReference	Szabályzat erőforrás-azonosítói.
TypedErrorInfo	Esetspecifikus hiba részletei.

CheckManagementGroupRestrictionsRequest

A kiértékelni kívánt erőforrást leíró szabályzatkorlátozások ellenőrzése paraméterek.

Name	Típus	Description
pendingFields	PendingField[]	Azoknak a mezőknek és értékeknek a listája, amelyeket ki kell értékelni a lehetséges korlátozások szempontjából.
resourceDetails	CheckRestrictionsResourceDetails	A kiértékelendő erőforrással kapcsolatos információk.

CheckRestrictionEvaluationDetails

Szabályzatértékelés részletei.

Name	Típus	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	A kiértékelt kifejezések részletei.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Az IfNotExists hatás kiértékelési részletei.
reason	string	A kiértékelési eredmény oka.

CheckRestrictionsResourceDetails

A kiértékelendő erőforrással kapcsolatos információk.

Name	Típus	Description
apiVersion	string	Az erőforrás-tartalom API-verziója.
resourceContent	object	Az erőforrás tartalma. Ennek tartalmaznia kell minden olyan tulajdonságot, amely már ismert, és az összes erőforrástulajdonság részleges halmaza lehet.
scope	string	Az erőforrás létrehozásának hatóköre. Ha például az erőforrás gyermekerőforrás, akkor ez a szülőerőforrás erőforrás-azonosítója.

CheckRestrictionsResult

Az ellenőrzésre vonatkozó szabályzatkorlátozások kiértékelésének eredménye egy erőforráson.

Name	Típus	Description
contentEvaluationResult	ContentEvaluationResult	A megadott részleges erőforrástartalom kiértékelési eredményei.
fieldRestrictions	FieldRestrictions[]	Az erőforrás különböző mezőire vonatkozó korlátozások szabályzat szerint.

ContentEvaluationResult

A megadott részleges erőforrástartalom kiértékelési eredményei.

Name	Típus	Description
policyEvaluations	PolicyEvaluationResult[]	A szabályzat kiértékelése az adott erőforrás-tartalomra mutat. Ez azt jelzi, hogy a rendszer megtagadja-e a megadott részleges tartalmat.

ErrorDefinition

Hibadefiníció.

Name	Típus	Description
additionalInfo	TypedErrorInfo[]	További forgatókönyvspecifikus hibaadatok.
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	ErrorDefinition[]	Belső hiba részletei.
message	string	A hiba leírása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	ErrorDefinition	A hiba részletei.

ExpressionEvaluationDetails

A szabályzatnyelvi kifejezések kiértékelési részletei.

Name	Típus	Description
expression	string	Kifejezés kiértékelve.
expressionKind	string	A kiértékelt kifejezés típusa.
expressionValue	object	A kifejezés értéke.
operator	string	Operátor a kifejezésérték és a célérték összehasonlításához.
path	string	Tulajdonság elérési útja, ha a kifejezés mező vagy alias.
result	string	Kiértékelési eredmény.
targetValue	object	A kifejezés értékével összehasonlítandó célérték.

FieldRestriction

Egy adott szabályzat által meghatározott mezőre vonatkozó korlátozások.

Name	Típus	Description
defaultValue	string	A mezőhöz beállított érték, ha a felhasználó nem ad meg értéket.
policy	PolicyReference	A mezőkorlátozást okozó szabályzat részletei.
policyEffect	string	A mezőkorlátozást okozó szabályzat hatása. http://aka.ms/policyeffects
reason	string	A korlátozás oka.
result	FieldRestrictionResult	A mezőre vonatkozó korlátozás típusa.
values	string[]	Azok az értékek, amelyeket a házirend megkövetel vagy tagad a mezőhöz.

FieldRestrictionResult

A mezőre vonatkozó korlátozás típusa.

Name	Típus	Description
Audit	string	A mezőt és/vagy az értékeket a szabályzat naplózhatja.
Deny	string	A mezőt és/vagy az értékeket a szabályzat megtagadja.
Removed	string	A mezőt a szabályzat eltávolítja.
Required	string	A mezőre és/vagy az értékekre a szabályzatnak szüksége van.

FieldRestrictions

Azok a korlátozások, amelyek az erőforrás egy mezőjére lesznek helyezve szabályzat szerint.

Name	Típus	Description
field	string	A mező neve. Ez lehet egy legfelső szintű tulajdonság, például a "name" vagy a "type" vagy a Azure Policy mezőalias.
restrictions	FieldRestriction[]	A mezőre vonatkozó korlátozások szabályzat szerint.

IfNotExistsEvaluationDetails

Az IfNotExists hatás kiértékelési részletei.

Name	Típus	Description
resourceId	string	Az IfNotExists effektus utolsó kiértékelt erőforrásának azonosítója.
totalResources	integer	Azon erőforrások teljes száma, amelyekre a létezési feltétel alkalmazható.

ManagementGroupsNamespaceType

A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.

Name	Típus	Description
Microsoft.Management	string

PendingField

Egy mező, amelyet Azure Policy kell kiértékelni a korlátozások meghatározásához.

Name	Típus	Description
field	string	A mező neve. Ez lehet egy legfelső szintű tulajdonság, például a "name" vagy a "type" vagy a Azure Policy mezőalias.
values	string[]	A mező azon lehetséges értékeinek listája, amelyeket Azure Policy kell kiértékelni.

PolicyEffectDetails

Az erőforrásra alkalmazott hatás részletei.

Name	Típus	Description
policyEffect	string	Az erőforrásra alkalmazott hatás. http://aka.ms/policyeffects

PolicyEvaluationResult

Az adott erőforrás-tartalomra vonatkozó, nem megfelelő szabályzatértékelés eredménye.

Name	Típus	Description
effectDetails	PolicyEffectDetails	Az erőforrásra alkalmazott hatás részletei.
evaluationDetails	CheckRestrictionEvaluationDetails	A kiértékelt szabályzatkifejezések és értékek részletes eredményei.
evaluationResult	string	Az erőforrásra vonatkozó szabályzatértékelés eredménye. Ez általában "Nem megfelelő", de hiba esetén más értékeket is tartalmazhat.
policyInfo	PolicyReference	A kiértékelt szabályzat részletei.

PolicyReference

Szabályzat erőforrás-azonosítói.

Name	Típus	Description
policyAssignmentId	string	A szabályzat-hozzárendelés erőforrás-azonosítója.
policyDefinitionId	string	A szabályzatdefiníció erőforrás-azonosítója.
policyDefinitionReferenceId	string	Egy adott szabályzatdefiníció referenciaazonosítója egy szabályzatkészlet-definícióban.
policySetDefinitionId	string	A szabályzatkészlet-definíció erőforrás-azonosítója.

TypedErrorInfo

Esetspecifikus hiba részletei.

Name	Típus	Description
info		A forgatókönyv konkrét hibaadatai.
type	string	A hiba részleteinek típusa.

Megosztás a következőn keresztül: