Policy Assignments - Update

Servizio:

Policy

Versione API:

2023-04-01

Questa operazione aggiorna un'assegnazione di criteri con l'ambito e il nome specificati. Le assegnazioni di criteri si applicano a tutte le risorse contenute all'interno dell'ambito. Ad esempio, quando si assegna un criterio nell'ambito del gruppo di risorse, tale criterio si applica a tutte le risorse del gruppo.

PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
policyAssignmentName	path	True	string	Nome dell'assegnazione dei criteri. Criterio di espressione regolare: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope	path	True	string	Ambito dell'assegnazione dei criteri. Gli ambiti validi sono: gruppo di gestione (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), sottoscrizione (formato: '/subscriptions/{subscriptionId}'), gruppo di risorse (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', o risorsa (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
identity	Identity	Identità gestita associata all'assegnazione dei criteri.
location	string	Posizione dell'assegnazione dei criteri. Obbligatorio solo quando si usa l'identità gestita.
properties.overrides	Override[]	Override del valore della proprietà dei criteri.
properties.resourceSelectors	ResourceSelector[]	Elenco di selettore di risorse per filtrare i criteri in base alle proprietà delle risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	PolicyAssignment	OK: restituisce informazioni sull'assegnazione dei 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

Update a policy assignment with a system assigned identity

Update a policy assignment with a user assigned identity

Update a policy assignment with overrides

Update a policy assignment with resource selectors

Update a policy assignment with a system assigned identity

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

{
  "location": "eastus",
  "identity": {
    "type": "SystemAssigned"
  }
}

Risposta di esempio

Codice di stato:

200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Update a policy assignment with a user assigned identity

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

{
  "location": "eastus",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
    }
  }
}

Risposta di esempio

Codice di stato:

200

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Update a policy assignment with overrides

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

{
  "properties": {
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  }
}

Risposta di esempio

Codice di stato:

200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Update a policy assignment with resource selectors

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

{
  "properties": {
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  }
}

Risposta di esempio

Codice di stato:

200

{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

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.
PolicyAssignmentUpdate	Assegnazione di criteri per la richiesta patch.
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 .

PolicyAssignment

Assegnazione di criteri.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID dell'assegnazione dei criteri.
identity	Identity		Identità gestita associata all'assegnazione dei criteri.
location	string		Posizione dell'assegnazione dei criteri. Obbligatorio solo quando si usa l'identità gestita.
name	string		Nome dell'assegnazione dei criteri.
properties.definitionVersion	string		Versione della definizione di criteri da usare.
properties.description	string		Questo messaggio farà parte della risposta in caso di violazione dei criteri.
properties.displayName	string		Nome visualizzato dell'assegnazione dei criteri.
properties.effectiveDefinitionVersion	string		Versione effettiva della definizione di criteri in uso. Questa opzione è presente solo se richiesta tramite il parametro di query $expand.
properties.enforcementMode	enforcementMode	Default	Modalità di imposizione dell'assegnazione dei criteri. I valori possibili sono Default e DoNotEnforce.
properties.latestDefinitionVersion	string		Versione più recente della definizione dei criteri disponibile. Questa opzione è presente solo se richiesta tramite il parametro di query $expand.
properties.metadata	object		Metadati dell'assegnazione dei criteri. I metadati sono un oggetto aperto terminato ed è in genere una raccolta di coppie chiave-valore.
properties.nonComplianceMessages	NonComplianceMessage[]		Messaggi che descrivono il motivo per cui una risorsa non è conforme ai criteri.
properties.notScopes	string[]		Ambiti esclusi dai criteri.
properties.overrides	Override[]		Override del valore della proprietà dei criteri.
properties.parameters	<string,  ParameterValuesValue>		Valori dei parametri per la regola dei criteri assegnata. Le chiavi sono i nomi dei parametri.
properties.policyDefinitionId	string		ID della definizione di criteri o della definizione del set di criteri assegnata.
properties.resourceSelectors	ResourceSelector[]		Elenco di selettore di risorse per filtrare i criteri in base alle proprietà delle risorse.
properties.scope	string		Ambito per l'assegnazione dei criteri.
systemData	systemData		Metadati di sistema relativi a questa risorsa.
type	string		Tipo di assegnazione dei criteri.

PolicyAssignmentUpdate

Assegnazione di criteri per la richiesta patch.

Nome	Tipo	Descrizione
identity	Identity	Identità gestita associata all'assegnazione dei criteri.
location	string	Posizione dell'assegnazione dei criteri. Obbligatorio solo quando si usa l'identità gestita.
properties.overrides	Override[]	Override del valore della proprietà dei criteri.
properties.resourceSelectors	ResourceSelector[]	Elenco di selettore di risorse per filtrare i criteri in base alle proprietà delle risorse.

ResourceIdentityType

Tipo di identità. Questo è l'unico campo obbligatorio quando si aggiunge un'identità assegnata dal sistema o dall'utente a una risorsa.

Nome	Tipo	Descrizione
None	string	Indica che non è associata alcuna identità alla risorsa o che l'identità esistente deve essere rimossa.
SystemAssigned	string	Indica che un'identità assegnata dal sistema è associata alla risorsa.
UserAssigned	string	Indica che un'identità assegnata dal sistema è associata alla risorsa.

ResourceSelector

Selettore di risorse per filtrare i criteri in base alle proprietà delle risorse.

Nome	Tipo	Descrizione
name	string	Nome del selettore di risorse.
selectors	Selector[]	Elenco delle espressioni del selettore.

Selector

Espressione del selettore.

Nome	Tipo	Descrizione
in	string[]	Elenco di valori in cui filtrare.
kind	SelectorKind	Tipo di selettore.
notIn	string[]	Elenco di valori da escludere.

SelectorKind

Tipo di selettore.

Nome	Tipo	Descrizione
policyDefinitionReferenceId	string	Tipo di selettore per filtrare i criteri in base all'ID riferimento alla definizione dei criteri.
resourceLocation	string	Tipo di selettore per filtrare i criteri in base alla posizione della risorsa.
resourceType	string	Tipo di selettore per filtrare i criteri in base al tipo di risorsa.
resourceWithoutLocation	string	Tipo di selettore per filtrare i criteri in base alla risorsa senza posizione.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la 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}'.

Nome	Tipo	Descrizione