Policy Assignments - Create By Id

Referenz

Service:: Policy

API Version:: 2023-04-01

Erstellt oder aktualisiert eine Richtlinienzuweisung.
Dieser Vorgang erstellt oder aktualisiert die Richtlinienzuweisung mit der angegebenen ID. Richtlinienzuweisungen, die für einen Bereich vorgenommen werden, gelten für alle Ressourcen, die in diesem Bereich enthalten sind. Wenn Sie beispielsweise einer Ressourcengruppe eine Richtlinie zuweisen, gilt diese Richtlinie für alle Ressourcen in der Gruppe. Richtlinienzuweisungs-IDs weisen das folgende Format auf: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Gültige Bereiche sind: Verwaltungsgruppe (Format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), Abonnement (Format: '/subscriptions/{subscriptionId}'), Ressourcengruppe (Format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', oder Ressource (Format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2023-04-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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

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.description	string	Diese Meldung ist Teil der Antwort im Falle eines Richtlinienverstoßes.
properties.displayName	string	Der Anzeigename der Richtlinienzuweisung.
properties.enforcementMode	enforcementMode	Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.
properties.metadata	object	Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.nonComplianceMessages	NonComplianceMessage[]	Die Meldungen, die beschreiben, warum eine Ressource nicht mit der Richtlinie konform ist.
properties.notScopes	string[]	Die ausgeschlossenen Bereiche der Richtlinie.
properties.overrides	Override[]	Der Wert der Richtlinieneigenschaft wird außer Kraft gesetzt.
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: Gibt Informationen zur Richtlinienzuweisung zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

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

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-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",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 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",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "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

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-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",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 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",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "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
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
enforcementMode	Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine systemseitig zugewiesene Identität oder eine einzelne benutzerseitig zugewiesene Identität.
NonComplianceMessage	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
Override	Der Richtlinieneigenschaftswert überschreibt.
OverrideKind	Die Überschreibungsart.
ParameterValuesValue	Der Wert eines Parameters.
PolicyAssignment	Die Richtlinienzuweisung.
ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.
ResourceSelector	Der Ressourcenauswahlgeber zum Filtern von Richtlinien nach Ressourceneigenschaften.
Selector	Der Selektorausdruck.
SelectorKind	Die Selektorart.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserAssignedIdentities	Die der Richtlinie zugeordnete Benutzeridentität. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.

Name	Typ	Beschreibung
Default	string	Die Richtlinienauswirkung wird während der Erstellung oder Aktualisierung von Ressourcen erzwungen.
DoNotEnforce	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung nicht erzwungen.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

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

Identity

Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine systemseitig zugewiesene Identität oder eine einzelne benutzerseitig zugewiesene Identität.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.
userAssignedIdentities	UserAssignedIdentities	Die der Richtlinie zugeordnete Benutzeridentität. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den 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 konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
policyDefinitionReferenceId	string	Die Referenz-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht bestimmt ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben ist, gilt die Nachricht für alle Richtlinien, die von dieser Richtlinienzuweisung zugewiesen werden.

Override

Der Richtlinieneigenschaftswert überschreibt.

Name	Typ	Beschreibung
kind	OverrideKind	Die Überschreibungsart.
selectors	Selector[]	Die Liste der Selektorausdrücke.
value	string	Der Wert zum Überschreiben der Richtlinieneigenschaft.

OverrideKind

Die Überschreibungsart.

Name	Typ	Beschreibung
policyEffect	string	Er überschreibt den Richtlinieneffekttyp.

ParameterValuesValue

Der Wert eines Parameters.

Name	Typ	Beschreibung
value	object	Der Wert des Parameters.