Policy Restrictions - Check At Subscription Scope

Ellenőrzi, hogy az előfizetésen belüli erőforrásokra milyen korlátozások Azure Policy vonatkoznak.

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

URI-paraméterek

Name In Required Type Description
subscriptionId
path True
  • string

A cél-előfizetés azonosítója.

api-version
query True
  • string

A művelethez használandó API-verzió.

Kérelem törzse

Name Required Type Description
resourceDetails True

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

pendingFields

Azoknak a mezőknek és értékeknek a listája, amelyeket ki kell értékelni a lehetséges korlátozások szempontjából.

Válaszok

Name Type Description
200 OK

A Azure Policy által az erőforrásra vonatkozó korlátozások.

Other Status Codes

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

Definíciók

CheckRestrictionsRequest

Az ellenőrzési szabályzat korlátozásai a kiértékelni kívánt erőforrást leíró paramétereket ismertetik.

CheckRestrictionsResourceDetails

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

CheckRestrictionsResult

Az ellenőrzési szabályzatok eredményei korlátozzák az erőforrások kiértékelését.

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

Az adott szabályzat által meghatározott mezőkre 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 hatás kiértékelési részletei.

PendingField

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

PolicyEvaluationDetails

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

PolicyEvaluationResult

Egy nem megfelelő szabályzat kiértékelésének eredménye az adott erőforrás-tartalommal szemben.

PolicyReference

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

TypedErrorInfo

Esetspecifikus hiba részletei.

CheckRestrictionsRequest

Az ellenőrzési szabályzat korlátozásai a kiértékelni kívánt erőforrást leíró paramétereket ismertetik.

Name Type Description
pendingFields

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

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

CheckRestrictionsResourceDetails

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

Name Type Description
apiVersion
  • string

Az erőforrás tartalmának 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 egy gyermekerőforrás, akkor ez a szülőerőforrás erőforrás-azonosítója.

CheckRestrictionsResult

Az ellenőrzési szabályzatok eredményei korlátozzák az erőforrások kiértékelését.

Name Type Description
contentEvaluationResult

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

fieldRestrictions

Az erőforrás különböző mezőire szabályzat alapján érvényes korlátozások.

ContentEvaluationResult

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

Name Type Description
policyEvaluations

A szabályzatértékelés eredménye a megadott erőforrás-tartalomra vonatkozik. Ez jelzi, hogy a rendszer megtagadja-e a megadott részleges tartalmat.

ErrorDefinition

Hibadefiníció.

Name Type Description
additionalInfo

További esetspecifikus hibaadatok.

code
  • string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.

details

Belső hiba részletei.

message
  • string

A hiba leírása.

target
  • string

A hiba célja.

ErrorResponse

Hibaválasz.

Name Type Description
error

A hiba részletei.

ExpressionEvaluationDetails

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

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

Az adott szabályzat által meghatározott mezőkre vonatkozó korlátozások.

Name Type Description
defaultValue
  • string

A mezőhöz beállított érték, ha a felhasználó nem ad meg értéket.

policy

A mezőkorlátozást okozó szabályzat részletei.

result

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

values
  • string[]

A házirend által megkövetelt vagy letiltott értékek a mezőhöz.

FieldRestrictionResult

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

Name Type Description
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 értékekre a szabályzatnak szüksége van.

FieldRestrictions

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

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

A mezőre vonatkozó korlátozások szabályzat szerint.

IfNotExistsEvaluationDetails

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

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

PendingField

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

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

PolicyEvaluationDetails

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

Name Type Description
evaluatedExpressions

A kiértékelt kifejezések részletei.

ifNotExistsDetails

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

PolicyEvaluationResult

Egy nem megfelelő szabályzat kiértékelésének eredménye az adott erőforrás-tartalommal szemben.

Name Type Description
evaluationDetails

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

A kiértékelt szabályzat részletei.

PolicyReference

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

Name Type 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ó referencia-azonosí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 Type Description
info

A forgatókönyv konkrét hibaadatai.

type
  • string

A belefoglalt hiba részleteinek típusa.