Policy Assignments - Create By Id

Dienst:: Policy

API-Version:: 2025-01-01

Erstellt oder aktualisiert eine Richtlinienzuweisung.
Diese Operation erstellt oder aktualisiert die Richtlinienzuweisung mit der angegebenen ID. Richtlinienzuweisungen, die in einem Umfang vorgenommen werden, gelten für alle in diesem Umfang enthaltenen Ressourcen. Wenn man zum Beispiel einer Ressourcengruppe eine Richtlinie zuweist, gilt diese Richtlinie für alle Ressourcen in der Gruppe. Richtlinienzuweisungs-IDs haben dieses Format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Gültige Anwendungsbereiche sind: Management-Gruppe (Format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), Abonnement (Format: '/subscriptions/{subscriptionId}'), Ressourcengruppe (Format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' oder Resource (Format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
policyAssignmentId	path	True	string	Die ID der zu erstellenden Richtlinienzuweisung. Verwenden Sie das Format "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
identity	Identity	Die verwaltete Identität, die der Richtlinienzuweisung zugeordnet ist.
location	string	Der Speicherort der Richtlinienzuweisung. Nur erforderlich, wenn verwaltete Identität verwendet wird.
properties.assignmentType	assignmentType	Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.
properties.definitionVersion	string	Die Version der zu verwendenden Richtliniendefinition.
properties.description	string	Diese Nachricht wird teil der Antwort im Falle eines Richtlinienverstoßes sein.
properties.displayName	string	Der Anzeigename der Richtlinienzuweisung.
properties.enforcementMode	enforcementMode	Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".
properties.metadata	object	Die Metadaten der Richtlinienzuweisung. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.nonComplianceMessages	NonComplianceMessage[]	Die Nachrichten, die beschreiben, warum eine Ressource nicht mit der Richtlinie kompatibel ist.
properties.notScopes	string[]	Die ausgeschlossenen Bereiche der Richtlinie.
properties.overrides	Override[]	Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
properties.parameters	<string, ParameterValuesValue>	Die Parameterwerte für die zugewiesene Richtlinienregel. Die Schlüssel sind die Parameternamen.
properties.policyDefinitionId	string	Die ID der zugewiesenen Richtliniendefinition oder Richtliniensatzdefinition.
properties.resourceSelectors	ResourceSelector[]	Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften.

Antworten

Name	Typ	Beschreibung
201 Created	PolicyAssignment	Erstellt – Rückgabeinformationen zur Policenzuweisung.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

Beispielanforderung

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

Beispielanforderung

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Definitionen

Name	Beschreibung
assignmentType	Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
enforcementMode	Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Das ist entweder eine systemzugewiesene Identität oder eine einzelne Benutzer-zugewiesene Identität.
NonComplianceMessage	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
Override	Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
OverrideKind	Die Überschreibungsart.
ParameterValuesValue	Der Wert eines Parameters.
PolicyAssignment	Die Policenzuweisung.
ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.
ResourceSelector	Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.
Selector	Der Selektorausdruck.
SelectorKind	Die Selektorart.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentities	Die Benutzeridentität, die der Richtlinie zugeordnet ist. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

assignmentType

Enumeration

Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.

Wert	Beschreibung
NotSpecified
System
SystemHidden
Custom

CloudError

Objekt

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

enforcementMode

Enumeration

Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".

Wert	Beschreibung
Default	Die Richtlinienauswirkung wird während der Erstellung oder Aktualisierung von Ressourcen erzwungen.
DoNotEnforce	Der Policy-Effekt wird während der Ressourcenerstellung oder Aktualisierung nicht durchgesetzt.
Enroll	Der Policy-Effekt wird während der Ressourcenerstellung oder Aktualisierung nicht durchgesetzt, bis die Ressource oder der Umfang der Ressource in die Zuweisungsinstanz eingebunden ist. Die Anmeldung erfolgt nach der Bereitstellung der Policy-Enrollment-Ressource.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Identity

Objekt

Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Das ist entweder eine systemzugewiesene Identität oder eine einzelne Benutzer-zugewiesene Identität.

Name	Typ	Beschreibung
principalId	string	Die Haupt-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemzugeordnete Identität bereitgestellt
tenantId	string	Die Tenant-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemzugeordnete Identität bereitgestellt
type	ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.
userAssignedIdentities	UserAssignedIdentities	Die Benutzeridentität, die der Richtlinie zugeordnet ist. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Objekt

Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.

Name	Typ	Beschreibung
message	string	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
policyDefinitionReferenceId	string	Die Richtliniendefinitionsreferenz-ID innerhalb einer Richtliniensatzdefinition, für die die Nachricht vorgesehen ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben wird, gilt die Nachricht für alle Richtlinien, die von dieser Richtlinienzuweisung zugewiesen werden.

Override

Objekt

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.

Name	Typ	Beschreibung
kind	OverrideKind	Die Überschreibungsart.
selectors	Selector[]	Die Liste der Selektorausdrücke.
value	string	Der Wert, der die Richtlinieneigenschaft außer Kraft setzen soll.

OverrideKind

Enumeration

Die Überschreibungsart.

Wert	Beschreibung
policyEffect	Sie überschreibt die Art des Versicherungseffekts.
definitionVersion	Sie überschreibt den Definitionsversionseigenschaftswert der Policy-Zuweisung.

ParameterValuesValue

Objekt

Der Wert eines Parameters.

Name	Typ	Beschreibung
value		Der Wert des Parameters.