Policy Assignments - Create By Id

Referenz

Dienst:: Policy

API-Version:: 2023-04-01

Erstellt oder aktualisiert eine Richtlinienzuweisung.
Dieser Vorgang erstellt oder aktualisiert die Richtlinienzuweisung mit der angegebenen ID. Richtlinienzuweisungen, die in einem 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 dieses 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	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.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 und DoNotEnforce.
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 – Gibt Informationen zur Richtlinienzuweisung zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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=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",
    "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"
  },
  "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=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",
    "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"
  },
  "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 Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default und DoNotEnforce.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine vom System zugewiesene 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 Richtlinienzuweisung.
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}".

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (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 Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default und DoNotEnforce.

Name	Typ	Beschreibung
Default	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung erzwungen.
DoNotEnforce	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung nicht erzwungen.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorResponse

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

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

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene 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

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

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

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.