Policy Restrictions - Check At Subscription Scope

Služba:: Policy

Verze rozhraní API:: 2024-10-01

Kontroluje, jaká omezení Azure Policy uloží na zdroj v rámci předplatného.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
resourceDetails	True	CheckRestrictionsResourceDetails	Informace o prostředku, který se vyhodnotí.
includeAuditEffect		boolean	Zda zahrnout zásady s účinkem auditování ve výsledcích. Výchozí nastavení je „false“.
pendingFields		PendingField[]	Seznampolích

Odpovědi

Name	Typ	Description
200 OK	CheckRestrictionsResult	Omezení, která budou na zdroj uvalena Azure Policy.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Check policy restrictions at subscription scope

Check policy restrictions at subscription scope including audit effect

Check policy restrictions at subscription scope

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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
}

Ukázková odpověď

Stavový kó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"
        }
      }
    ]
  }
}

Definice

Name	Description
CheckRestrictionEvaluationDetails	Podrobnosti o vyhodnocení zásad
CheckRestrictionsRequest	Parametry omezení zásad kontroly popisující prostředek, který se vyhodnocuje.
CheckRestrictionsResourceDetails	Informace o prostředku, který se vyhodnotí.
CheckRestrictionsResult	Výsledek vyhodnocení omezení zásad kontroly u prostředku.
ContentEvaluationResult	Výsledky vyhodnocení poskytnutého částečného obsahu prostředků
ErrorDefinition	Definice chyby
ErrorResponse	Chybová odpověď.
ExpressionEvaluationDetails	Podrobnosti vyhodnocení výrazů jazyka zásad
FieldRestriction	Omezení pole stanovené konkrétní zásadou.
FieldRestrictionResult	Typ omezení, které je pro pole uloženo.
FieldRestrictions	Omezení, která budou v poli v prostředku uložena zásadami.
IfNotExistsEvaluationDetails	Podrobnosti vyhodnocení efektu IfNotExists
PendingField	Pole, které by mělo být vyhodnuto podle Azure Policy pro určení omezení.
PolicyEffectDetails	Podrobnosti o efektu použitém u prostředku.
PolicyEvaluationResult	Výsledek vyhodnocení nekompatibilních zásad s daným obsahem prostředků.
PolicyReference	Identifikátory prostředků pro zásadu
TypedErrorInfo	Podrobnosti o konkrétní chybě scénáře

CheckRestrictionEvaluationDetails

Objekt

Podrobnosti o vyhodnocení zásad

Name	Typ	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Podrobnosti vyhodnocovaných výrazů
ifNotExistsDetails	IfNotExistsEvaluationDetails	Podrobnosti vyhodnocení efektu IfNotExists
reason	string	Důvod vyhodnocení.

CheckRestrictionsRequest

Objekt

Parametry omezení zásad kontroly popisující prostředek, který se vyhodnocuje.

Name	Typ	Default value	Description
includeAuditEffect	boolean	False	Zda zahrnout zásady s účinkem auditování ve výsledcích. Výchozí nastavení je „false“.
pendingFields	PendingField[]		Seznampolích
resourceDetails	CheckRestrictionsResourceDetails		Informace o prostředku, který se vyhodnotí.

CheckRestrictionsResourceDetails

Objekt

Informace o prostředku, který se vyhodnotí.

Name	Typ	Description
apiVersion	string	Verze api-version obsahu prostředku.
resourceContent	object	Obsah prostředku. To by mělo zahrnovat všechny vlastnosti, které už jsou známé a mohou být částečnou sadou všech vlastností prostředku.
scope	string	Obor, ve kterém se prostředek vytváří. Pokud je prostředek například podřízeným prostředkem, jedná se například o ID prostředku nadřazeného prostředku.

CheckRestrictionsResult

Objekt

Výsledek vyhodnocení omezení zásad kontroly u prostředku.

Name	Typ	Description
contentEvaluationResult	ContentEvaluationResult	Výsledky vyhodnocení poskytnutého částečného obsahu prostředků
fieldRestrictions	FieldRestrictions[]	Omezení, která se uvedou na různá pole v prostředku podle zásad.

ContentEvaluationResult

Objekt

Výsledky vyhodnocení poskytnutého částečného obsahu prostředků

Name	Typ	Description
policyEvaluations	PolicyEvaluationResult[]	Výsledky vyhodnocení zásad oproti danému obsahu prostředků To bude indikovat, zda bude částečný obsah, který byl poskytnut, odepřen as-is.

ErrorDefinition

Objekt

Definice chyby

Name	Typ	Description
additionalInfo	TypedErrorInfo[]	Další podrobnosti o chybě specifické pro konkrétní scénář
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav kódu chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	ErrorDefinition	Podrobnosti o chybě.

ExpressionEvaluationDetails

Objekt

Podrobnosti vyhodnocení výrazů jazyka zásad

Name	Typ	Description
expression	string	Výraz byl vyhodnocen.
expressionKind	string	Druh výrazu, který byl vyhodnocen.
expressionValue	object	Hodnota výrazu.
operator	string	Operátor pro porovnání hodnoty výrazu a cílové hodnoty
path	string	Cesta k vlastnosti, pokud je výraz pole nebo alias.
result	string	Výsledek vyhodnocení.
targetValue	object	Cílová hodnota, která se má porovnat s hodnotou výrazu.

FieldRestriction

Objekt

Omezení pole stanovené konkrétní zásadou.

Name	Typ	Description
defaultValue	string	Hodnota, kterou zásada nastaví pro pole, pokud uživatel nezadá hodnotu.
policy	PolicyReference	Podrobnosti o zásadách, které způsobují omezení polí.
policyEffect	string	Účinek zásady, která způsobuje omezení polí. http://aka.ms/policyeffects
reason	string	Důvod omezení.
result	FieldRestrictionResult	Typ omezení, které je pro pole uloženo.
values	string[]	Hodnoty, které zásada vyžaduje nebo odmítne pro dané pole.

FieldRestrictionResult

Výčet

Typ omezení, které je pro pole uloženo.

Hodnota	Description
Required	Pole a/nebo hodnoty jsou vyžadovány zásadami.
Removed	Pole bude odebráno zásadami.
Deny	Pole a/nebo hodnoty budou zásady odepřeny.
Audit	Pole a/nebo hodnoty budou auditovány zásadami.

FieldRestrictions

Objekt

Omezení, která budou v poli v prostředku uložena zásadami.

Name	Typ	Description
field	string	Název pole. Může to být vlastnost nejvyšší úrovně jako 'name' nebo 'type' nebo alias pole Azure Policy.
restrictions	FieldRestriction[]	Omezení pro toto pole podle zásad.

IfNotExistsEvaluationDetails

Objekt

Podrobnosti vyhodnocení efektu IfNotExists

Name	Typ	Description
resourceId	string	ID posledního vyhodnoceného prostředku pro účinek IfNotExists
totalResources	integer	Celkový počet prostředků, na které je podmínka existence použitelná.

PendingField

Objekt

Pole, které by mělo být vyhodnuto podle Azure Policy pro určení omezení.

Name	Typ	Description
field	string	Název pole. Může to být vlastnost nejvyšší úrovně jako 'name' nebo 'type' nebo alias pole Azure Policy.
values	string[]	Seznam možných hodnot pro pole, které by měly být vyhodnoceny vůči Azure Policy.

PolicyEffectDetails

Objekt

Podrobnosti o efektu použitém u prostředku.

Name	Typ	Description
policyEffect	string	Účinek použitý na prostředek. http://aka.ms/policyeffects

PolicyEvaluationResult

Objekt

Výsledek vyhodnocení nekompatibilních zásad s daným obsahem prostředků.

Name	Typ	Description
effectDetails	PolicyEffectDetails	Podrobnosti o efektu použitém u prostředku.
evaluationDetails	CheckRestrictionEvaluationDetails	Podrobné výsledky výrazů zásad a hodnot, které byly vyhodnoceny.
evaluationResult	string	Výsledek vyhodnocení zásad pro prostředek. Obvykle to bude "Nedodržující předpisy", ale může obsahovat další hodnoty, pokud byly zjištěny chyby.
policyInfo	PolicyReference	Podrobnosti o vyhodnocených zásadách

PolicyReference

Objekt

Identifikátory prostředků pro zásadu

Name	Typ	Description
policyAssignmentId	string	Identifikátor prostředku přiřazení zásady.
policyDefinitionId	string	Identifikátor prostředku definice zásady.
policyDefinitionReferenceId	string	Referenční identifikátor konkrétní definice zásady v rámci definice sady zásad.
policySetDefinitionId	string	Identifikátor prostředku definice sady zásad.

TypedErrorInfo

Objekt

Podrobnosti o konkrétní chybě scénáře

Name	Typ	Description
info		Podrobnosti o konkrétní chybě scénáře.
type	string	Typ zahrnutých podrobností o chybě.

Sdílet prostřednictvím

Policy Restrictions - Check At Subscription Scope

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Check policy restrictions at subscription scope

Ukázkový požadavek

Ukázková odpověď

Check policy restrictions at subscription scope including audit effect

Ukázkový požadavek

Ukázková odpověď

Definice

CheckRestrictionEvaluationDetails

CheckRestrictionsRequest

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo