Policy Restrictions - Check At Subscription Scope

Verifica quali restrizioni Criteri di Azure verranno inserite in una risorsa all'interno di una sottoscrizione.

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

Parametri dell'URI

Name In Required Type Description
subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Name Required Type Description
resourceDetails True

Informazioni sulla risorsa che verrà valutata.

pendingFields

Elenco di campi e valori che devono essere valutati per le potenziali restrizioni.

Risposte

Name Type Description
200 OK

Restrizioni che verranno inserite nella risorsa da Criteri di Azure.

Other Status Codes

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

CheckRestrictionsRequest

Parametri delle restrizioni dei criteri di controllo che descrivono la risorsa che viene valutata.

CheckRestrictionsResourceDetails

Informazioni sulla risorsa che verrà valutata.

CheckRestrictionsResult

Risultato di una valutazione delle restrizioni dei criteri di controllo in una risorsa.

ContentEvaluationResult

Risultati della valutazione per il contenuto parziale della risorsa fornito.

ErrorDefinition

Definizione di errore.

ErrorResponse

Risposta di errore.

ExpressionEvaluationDetails

Dettagli di valutazione delle espressioni del linguaggio dei criteri.

FieldRestriction

Restrizioni per un campo imposto da criteri specifici.

FieldRestrictionResult

Tipo di restrizione imposto sul campo.

FieldRestrictions

Restrizioni che verranno inserite in un campo nella risorsa in base ai criteri.

IfNotExistsEvaluationDetails

Dettagli di valutazione dell'effetto IfNotExists.

PendingField

Campo che deve essere valutato rispetto alle Criteri di Azure per determinare le restrizioni.

PolicyEvaluationDetails

Dettagli sulla valutazione dei criteri.

PolicyEvaluationResult

Risultato di una valutazione dei criteri non conforme rispetto al contenuto della risorsa specificato.

PolicyReference

Identificatori di risorsa per un criterio.

TypedErrorInfo

Dettagli degli errori specifici dello scenario.

CheckRestrictionsRequest

Parametri delle restrizioni dei criteri di controllo che descrivono la risorsa che viene valutata.

Name Type Description
pendingFields

Elenco di campi e valori che devono essere valutati per le potenziali restrizioni.

resourceDetails

Informazioni sulla risorsa che verrà valutata.

CheckRestrictionsResourceDetails

Informazioni sulla risorsa che verrà valutata.

Name Type Description
apiVersion
  • string

Versione api del contenuto della risorsa.

resourceContent
  • object

Contenuto della risorsa. Ciò deve includere qualsiasi proprietà già nota e può essere un set parziale di tutte le proprietà delle risorse.

scope
  • string

Ambito in cui viene creata la risorsa. Ad esempio, se la risorsa è una risorsa figlio, si tratta dell'ID risorsa della risorsa padre.

CheckRestrictionsResult

Risultato di una valutazione delle restrizioni dei criteri di controllo in una risorsa.

Name Type Description
contentEvaluationResult

Risultati della valutazione per il contenuto parziale della risorsa fornito.

fieldRestrictions

Restrizioni che verranno inserite in vari campi nella risorsa in base ai criteri.

ContentEvaluationResult

Risultati della valutazione per il contenuto parziale della risorsa fornito.

Name Type Description
policyEvaluations

Risultati della valutazione dei criteri rispetto al contenuto della risorsa specificato. In questo modo verrà indicato se il contenuto parziale fornito verrà negato come è.

ErrorDefinition

Definizione di errore.

Name Type Description
additionalInfo

Dettagli aggiuntivi sugli errori specifici dello scenario.

code
  • string

Codice di errore specifico del servizio che funge da sottostatus per il codice di errore HTTP.

details

Dettagli dell'errore interno.

message
  • string

Descrizione dell'errore.

target
  • string

Destinazione dell'errore.

ErrorResponse

Risposta di errore.

Name Type Description
error

Dettagli dell'errore.

ExpressionEvaluationDetails

Dettagli di valutazione delle espressioni del linguaggio dei criteri.

Name Type Description
expression
  • string

Espressione valutata.

expressionKind
  • string

Tipo di espressione valutata.

expressionValue
  • object

Valore dell'espressione.

operator
  • string

Operatore per confrontare il valore dell'espressione e il valore di destinazione.

path
  • string

Percorso della proprietà se l'espressione è un campo o un alias.

result
  • string

Risultato della valutazione.

targetValue
  • object

Valore di destinazione da confrontare con il valore dell'espressione.

FieldRestriction

Restrizioni per un campo imposto da criteri specifici.

Name Type Description
defaultValue
  • string

Valore impostato per il campo se l'utente non fornisce un valore.

policy

Dettagli dei criteri che causano la restrizione del campo.

result

Tipo di restrizione imposto sul campo.

values
  • string[]

I valori che i criteri richiedono o negano per il campo.

FieldRestrictionResult

Tipo di restrizione imposto sul campo.

Name Type Description
Deny
  • string

Il campo e/o i valori verranno negati dai criteri.

Removed
  • string

Il campo verrà rimosso dai criteri.

Required
  • string

Il campo e/o i valori sono richiesti dai criteri.

FieldRestrictions

Restrizioni che verranno inserite in un campo nella risorsa in base ai criteri.

Name Type Description
field
  • string

Nome del campo. Questa può essere una proprietà di primo livello, ad esempio 'name' o 'type' o un alias di campo Criteri di Azure.

restrictions

Restrizioni applicate a tale campo in base ai criteri.

IfNotExistsEvaluationDetails

Dettagli di valutazione dell'effetto IfNotExists.

Name Type Description
resourceId
  • string

ID dell'ultima risorsa valutata per l'effetto IfNotExists.

totalResources
  • integer

Numero totale di risorse a cui è applicabile la condizione di esistenza.

PendingField

Campo che deve essere valutato rispetto alle Criteri di Azure per determinare le restrizioni.

Name Type Description
field
  • string

Nome del campo. Questa può essere una proprietà di primo livello, ad esempio 'name' o 'type' o un alias di campo Criteri di Azure.

values
  • string[]

Elenco di valori potenziali per il campo che deve essere valutato rispetto alla Criteri di Azure.

PolicyEvaluationDetails

Dettagli sulla valutazione dei criteri.

Name Type Description
evaluatedExpressions

Dettagli delle espressioni valutate.

ifNotExistsDetails

Dettagli di valutazione dell'effetto IfNotExists.

PolicyEvaluationResult

Risultato di una valutazione dei criteri non conforme rispetto al contenuto della risorsa specificato.

Name Type Description
evaluationDetails

I risultati dettagliati delle espressioni e dei valori dei criteri valutati.

evaluationResult
  • string

Risultato della valutazione dei criteri rispetto alla risorsa. In genere si tratta di "NonCompliant", ma può contenere altri valori se sono stati rilevati errori.

policyInfo

Dettagli dei criteri valutati.

PolicyReference

Identificatori di risorsa per un criterio.

Name Type Description
policyAssignmentId
  • string

Identificatore della risorsa dell'assegnazione di criteri.

policyDefinitionId
  • string

Identificatore della risorsa della definizione dei criteri.

policyDefinitionReferenceId
  • string

Identificatore di riferimento di una definizione di criteri specifica all'interno di una definizione del set di criteri.

policySetDefinitionId
  • string

Identificatore della risorsa della definizione del set di criteri.

TypedErrorInfo

Dettagli degli errori specifici dello scenario.

Name Type Description
info

Dettagli dell'errore specifico dello scenario.

type
  • string

Tipo di dettagli di errore inclusi.