Policy Restrictions - Check At Subscription Scope

Szolgáltatás:: Policy

API-verzió:: 2024-10-01

Ellenőrzi, milyen korlátozásokat szab az Azure Policy egy előfizetésen belüli erőforrásra.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
resourceDetails	True	CheckRestrictionsResourceDetails	A kiértékelendő erőforrással kapcsolatos információk.
includeAuditEffect		boolean	Hogy a szabályzatok szerepeljenek-e az eredményekben az "audit" effektussal. Alapértelmezés szerint hamis.
pendingFields		PendingField[]	A lehetséges korlátozások szempontjából értékelendő mezők és értékek listája.

Válaszok

Name	Típus	Description
200 OK	CheckRestrictionsResult	Az Azure Policy által az erőforrásra vonatkozó korlátozások.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Check policy restrictions at subscription scope

Check policy restrictions at subscription scope including audit effect

Check policy restrictions at subscription scope

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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 subscription scope including audit effect

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
        }
      }
    ]
  }
}

Definíciók

Name	Description
CheckRestrictionEvaluationDetails	Szabályzatértékelés részletei.
CheckRestrictionsRequest	A kiértékelendő erőforrást leíró ellenőrzési szabályzatkorlátozási paraméterek.
CheckRestrictionsResourceDetails	A kiértékelendő erőforrással kapcsolatos információk.
CheckRestrictionsResult	Az erőforrásra vonatkozó ellenőrzési házirend-korlátozások kiértékelésének eredménye.
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	Az erőforrás egy mezőjére szabályzat szerint helyezendő korlátozások.
IfNotExistsEvaluationDetails	Az IfNotExists effektus kiértékelési részletei.
PendingField	Egy mező, amelyet az Azure Policy alapján kell értékelni a korlátozások meghatározására.
PolicyEffectDetails	Az erőforrásra alkalmazott hatás részletei.
PolicyEvaluationResult	Az adott erőforrástartalomra vonatkozó, nem megfelelő szabályzatértékelés eredménye.
PolicyReference	Erőforrás-azonosítók egy szabályzathoz.
TypedErrorInfo	Esetspecifikus hiba részletei.

CheckRestrictionEvaluationDetails

Tárgy

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 effektus kiértékelési részletei.
reason	string	A kiértékelési eredmény oka.

CheckRestrictionsRequest

Tárgy

A kiértékelendő erőforrást leíró ellenőrzési szabályzatkorlátozási paraméterek.

Name	Típus	Alapértelmezett érték	Description
includeAuditEffect	boolean	False	Hogy a szabályzatok szerepeljenek-e az eredményekben az "audit" effektussal. Alapértelmezés szerint hamis.
pendingFields	PendingField[]		A lehetséges korlátozások szempontjából értékelendő mezők és értékek listája.
resourceDetails	CheckRestrictionsResourceDetails		A kiértékelendő erőforrással kapcsolatos információk.

CheckRestrictionsResourceDetails

Tárgy

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 a már ismert tulajdonságokat, és az összes erőforrástulajdonság részleges készlete 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

Tárgy

Az erőforrásra vonatkozó ellenőrzési házirend-korlátozások kiértékelésének eredménye.

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 szabályzat szerint helyezendő korlátozások.

ContentEvaluationResult

Tárgy

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

Name	Típus	Description
policyEvaluations	PolicyEvaluationResult[]	A szabályzatok kiértékelési eredményei a megadott erőforrás-tartalommal szemben. Ez azt jelzi, hogy a megadott részleges tartalom megtagadva lesz-e as-is.

ErrorDefinition

Tárgy

Hibadefiníció.

Name	Típus	Description
additionalInfo	TypedErrorInfo[]	További esetspecifikus 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

Tárgy

Hibaválasz.

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

ExpressionEvaluationDetails

Tárgy

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ének és a célértéknek az ö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

Tárgy

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

Felsorolás

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

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

FieldRestrictions

Tárgy

Az erőforrás egy mezőjére szabályzat szerint helyezendő korlátozások.

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

IfNotExistsEvaluationDetails

Tárgy

Az IfNotExists effektus 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 vonatkozik.

PendingField

Tárgy

Egy mező, amelyet az Azure Policy alapján kell értékelni a korlátozások meghatározására.

Name	Típus	Description
field	string	A mező neve. Ez lehet egy felső szintű tulajdonság, például 'name' vagy 'type', vagy egy Azure Policy field alias.
values	string[]	A mező potenciális értékeinek listája, amelyeket az Azure Policy alapján kell értékelni.

PolicyEffectDetails

Tárgy

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

Tárgy

Az adott erőforrástartalomra 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	A szabályzat kiértékelésének eredménye az erőforráson. 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

Tárgy

Erőforrás-azonosítók egy szabályzathoz.

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ón belül.
policySetDefinitionId	string	A szabályzatkészlet definíciójának erőforrás-azonosítója.

TypedErrorInfo

Tárgy

Esetspecifikus hiba részletei.

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

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

Policy Restrictions - Check At Subscription Scope

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Check policy restrictions at subscription scope

Mintakérelem

Mintaválasz

Check policy restrictions at subscription scope including audit effect

Mintakérelem

Mintaválasz

Definíciók

CheckRestrictionEvaluationDetails

CheckRestrictionsRequest

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo