Policy Assignments - List

Riferimento

Servizio:: Policy

Versione API:: 2023-04-01

Recupera tutte le assegnazioni di criteri applicabili a una sottoscrizione.
Questa operazione recupera l'elenco di tutte le assegnazioni di criteri associate alla sottoscrizione specificata che corrispondono al $filter facoltativo specificato. I valori validi per $filter sono: 'atScope()', 'atExactScope()' o 'policyDefinitionId eq '{value}'. Se $filter non viene specificato, l'elenco non filtrato include tutte le assegnazioni di criteri associate alla sottoscrizione, incluse quelle che si applicano direttamente o dai gruppi di gestione che contengono la sottoscrizione specificata, nonché eventuali oggetti applicati agli oggetti contenuti nella sottoscrizione. Se viene specificato $filter=atScope(), l'elenco restituito include tutte le assegnazioni di criteri applicabili alla sottoscrizione, ovvero tutti gli elementi dell'elenco non filtrato tranne quelli applicati agli oggetti contenuti nella sottoscrizione. Se viene specificato $filter=atExactScope(), l'elenco restituito include solo tutte le assegnazioni di criteri presenti nella sottoscrizione. Se viene specificato $filter=policyDefinitionId eq '{value}', l'elenco restituito include tutte le assegnazioni di criteri della definizione dei criteri il cui ID è {value}.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01

Con parametri facoltativi:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$expand={$expand}&$top={$top}&api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$expand	query		string	Elenco delimitato da virgole di proprietà aggiuntive da includere nella risposta. I valori supportati sono 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
$filter	query		string	Filtro da applicare all'operazione. I valori validi per $filter sono: 'atScope()', 'atExactScope()' o 'policyDefinitionId eq '{value}'. Se non viene specificato $filter, non viene eseguito alcun filtro. Se viene specificato $filter=atScope(), l'elenco restituito include solo tutte le assegnazioni di criteri applicabili all'ambito, ovvero tutti gli elementi dell'elenco non filtrato tranne quelli applicati agli ambiti secondari contenuti nell'ambito specificato. Se viene specificato $filter=atExactScope(), l'elenco restituito include solo tutte le assegnazioni di criteri nell'ambito specificato. Se viene specificato $filter=policyDefinitionId eq '{value}', l'elenco restituito include tutte le assegnazioni di criteri della definizione dei criteri il cui ID è {value}.
$top	query		integer int32	Numero massimo di record da restituire. Quando il filtro $top non viene specificato, restituirà 500 record.

Risposte

Nome	Tipo	Descrizione
200 OK	PolicyAssignmentListResult	OK: restituisce una matrice di assegnazioni di criteri.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List policy assignments that apply to a subscription

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&$expand=LatestDefinitionVersion, EffectiveDefinitionVersion&api-version=2023-04-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "CostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/TagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore da un'operazione di criteri.
createdByType	Tipo di identità che ha creato la risorsa.
enforcementMode	Modalità di imposizione dell'assegnazione dei criteri. I valori possibili sono Default e DoNotEnforce.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta errore
Identity	Identità per la risorsa. Le assegnazioni di criteri supportano un massimo di un'identità. Si tratta di un'identità assegnata dal sistema o di una singola identità assegnata dall'utente.
NonComplianceMessage	Messaggio che descrive il motivo per cui una risorsa non è conforme ai criteri. Viene visualizzato nei messaggi di errore "nega" e nei risultati di conformità non conformi della risorsa.
Override	Override del valore della proprietà dei criteri.
OverrideKind	Tipo di override.
ParameterValuesValue	Valore di un parametro.
PolicyAssignment	Assegnazione di criteri.
PolicyAssignmentListResult	Elenco di assegnazioni di criteri.
ResourceIdentityType	Tipo di identità. Questo è l'unico campo obbligatorio quando si aggiunge un'identità assegnata dal sistema o dall'utente a una risorsa.
ResourceSelector	Selettore di risorse per filtrare i criteri in base alle proprietà delle risorse.
Selector	Espressione del selettore.
SelectorKind	Tipo di selettore.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserAssignedIdentities	Identità utente associata al criterio. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CloudError

Risposta di errore da un'operazione di criteri.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta errore Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

Modalità di imposizione dell'assegnazione dei criteri. I valori possibili sono Default e DoNotEnforce.

Nome	Tipo	Descrizione
Default	string	L'effetto dei criteri viene applicato durante la creazione o l'aggiornamento delle risorse.
DoNotEnforce	string	L'effetto dei criteri non viene applicato durante la creazione o l'aggiornamento delle risorse.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

Identity

Identità per la risorsa. Le assegnazioni di criteri supportano un massimo di un'identità. Si tratta di un'identità assegnata dal sistema o di una singola identità assegnata dall'utente.

Nome	Tipo	Descrizione
principalId	string	ID principale dell'identità della risorsa. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema
tenantId	string	ID tenant dell'identità della risorsa. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema
type	ResourceIdentityType	Tipo di identità. Questo è l'unico campo obbligatorio quando si aggiunge un'identità assegnata dal sistema o dall'utente a una risorsa.
userAssignedIdentities	UserAssignedIdentities	Identità utente associata al criterio. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Messaggio che descrive il motivo per cui una risorsa non è conforme ai criteri. Viene visualizzato nei messaggi di errore "nega" e nei risultati di conformità non conformi della risorsa.

Nome	Tipo	Descrizione
message	string	Messaggio che descrive il motivo per cui una risorsa non è conforme ai criteri. Viene visualizzato nei messaggi di errore "nega" e nei risultati di conformità non conformi della risorsa.
policyDefinitionReferenceId	string	L'ID riferimento alla definizione di criteri all'interno di una definizione del set di criteri per cui è destinato il messaggio. Questa opzione è applicabile solo se l'assegnazione di criteri assegna una definizione del set di criteri. Se non viene specificato, il messaggio si applica a tutti i criteri assegnati da questa assegnazione di criteri.

Override

Override del valore della proprietà dei criteri.

Nome	Tipo	Descrizione
kind	OverrideKind	Tipo di override.
selectors	Selector[]	Elenco delle espressioni del selettore.
value	string	Valore di cui eseguire l'override della proprietà dei criteri.

OverrideKind

Tipo di override.

Nome	Tipo	Descrizione
policyEffect	string	Eseguirà l'override del tipo di effetto dei criteri.

ParameterValuesValue

Valore di un parametro.

Nome	Tipo	Descrizione
value	object	Valore del parametro .