Freigeben über

Policy Assignments - Update

  • Referenz
Dienst:
Policy
API-Version:
2023-04-01

Dieser Vorgang aktualisiert eine Richtlinienzuweisung mit dem angegebenen Bereich und Namen. Richtlinienzuweisungen gelten für alle Ressourcen, die in ihrem Bereich enthalten sind. Wenn Sie beispielsweise eine Richtlinie im Ressourcengruppenbereich zuweisen, gilt diese Richtlinie für alle Ressourcen in der Gruppe.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
policyAssignmentName
 path True

string

Der Name der Richtlinienzuweisung.

RegEx-Muster: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

Der Bereich der Richtlinienzuweisung. 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}'
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.overrides

Override[]

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
properties.resourceSelectors

ResourceSelector[]

Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften.

Antworten

Name Typ Beschreibung
200 OK

PolicyAssignment

OK – 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

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

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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": {}
    }
  }
}

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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"
            ]
          }
        ]
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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"
            ]
          }
        ]
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
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"
}

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.
PolicyAssignmentUpdate

Die Richtlinienzuweisung für Patchanforderung.
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.

PolicyAssignment

Die Richtlinienzuweisung.

Name Typ Standardwert Beschreibung
id

string

Die ID der Richtlinienzuweisung.
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.
name

string

Der Name der Richtlinienzuweisung.
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.effectiveDefinitionVersion

string

Die effektive Version der verwendeten Richtliniendefinition. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
properties.enforcementMode

enforcementMode

Default

Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default und DoNotEnforce.
properties.latestDefinitionVersion

string

Die neueste Version der verfügbaren Richtliniendefinition. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
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.
properties.scope

string

Der Bereich für die Richtlinienzuweisung.
systemData

systemData

Die Systemmetadaten, die sich auf diese Ressource beziehen.
type

string

Der Typ der Richtlinienzuweisung.

PolicyAssignmentUpdate

Die Richtlinienzuweisung für Patchanforderung.

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.overrides

Override[]

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
properties.resourceSelectors

ResourceSelector[]

Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften.

ResourceIdentityType

Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.

Name Typ Beschreibung
None

string

Gibt an, dass der Ressource keine Identität zugeordnet ist oder die vorhandene Identität entfernt werden soll.
SystemAssigned

string

Gibt an, dass eine vom System zugewiesene Identität der Ressource zugeordnet ist.
UserAssigned

string

Gibt an, dass eine vom System zugewiesene Identität der Ressource zugeordnet ist.

ResourceSelector

Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.

Name Typ Beschreibung
name

string

Der Name der Ressourcenauswahl.
selectors

Selector[]

Die Liste der Selektorausdrücke.

Selector

Der Selektorausdruck.

Name Typ Beschreibung
in

string[]

Die Liste der zu filternden Werte.
kind

SelectorKind

Die Selektorart.
notIn

string[]

Die Liste der zu filternden Werte.

SelectorKind

Die Selektorart.

Name Typ Beschreibung
policyDefinitionReferenceId

string

Die Auswahlart zum Filtern von Richtlinien nach der Richtliniendefinitionsreferenz-ID.
resourceLocation

string

Die Auswahlart zum Filtern von Richtlinien nach dem Ressourcenspeicherort.
resourceType

string

Die Auswahlart zum Filtern von Richtlinien nach dem Ressourcentyp.
resourceWithoutLocation

string

Die Auswahlart zum Filtern von Richtlinien nach der Ressource ohne Speicherort.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

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}".

Name Typ Beschreibung