Policy Assignments - Update
Dieser Vorgang aktualisiert eine Richtlinienzuweisung mit dem angegebenen Bereich und Namen. Richtlinienzuweisungen gelten für alle Ressourcen, die in ihrem Gültigkeitsbereich 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 |
---|---|---|---|---|
policy
|
path | True |
string |
Der Name der Richtlinienzuweisung. Regex pattern: |
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 |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
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[] |
Der Wert der Richtlinieneigenschaft wird außer Kraft gesetzt. |
properties.resourceSelectors |
Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK: Gibt Informationen zur Richtlinienzuweisung zurück. |
|
Other Status Codes |
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
Update a policy assignment with a system assigned identity
Sample Request
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"
}
}
Sample Response
{
"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",
"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
Sample Request
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": {}
}
}
}
Sample Response
{
"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",
"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
Sample Request
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"
]
}
]
}
]
}
}
Sample Response
{
"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",
"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
Sample Request
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"
]
}
]
}
]
}
}
Sample Response
{
"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",
"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 |
---|---|
Cloud |
Eine Fehlerantwort eines Richtlinienvorgangs. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
enforcement |
Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
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. |
Non |
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. |
Override |
Die Überschreibungsart. |
Parameter |
Der Wert eines Parameters. |
Policy |
Die Richtlinienzuweisung. |
Policy |
Die Richtlinienzuweisung für die Patchanforderung. |
Resource |
Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource. |
Resource |
Der Ressourcenauswahlgeber zum Filtern von Richtlinien nach Ressourceneigenschaften. |
Selector |
Der Selektorausdruck. |
Selector |
Die Selektorart. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
User |
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 |
Fehlerantwort |
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 |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
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 |
Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource. |
|
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 |
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. |
PolicyAssignment
Die Richtlinienzuweisung.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Die ID der Richtlinienzuweisung. |
|
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.description |
string |
Diese Nachricht ist Teil der Antwort im Falle eines Richtlinienverstoßes. |
|
properties.displayName |
string |
Der Anzeigename der Richtlinienzuweisung. |
|
properties.enforcementMode | Default |
Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce. |
|
properties.metadata |
object |
Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren. |
|
properties.nonComplianceMessages |
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 Richtlinieneigenschaftswert überschreibt. |
|
properties.parameters |
<string,
Parameter |
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 |
Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften. |
||
properties.scope |
string |
Der Bereich für die Richtlinienzuweisung. |
|
systemData |
Die Systemmetadaten, die sich auf diese Ressource beziehen. |
||
type |
string |
Der Typ der Richtlinienzuweisung. |
PolicyAssignmentUpdate
Die Richtlinienzuweisung für die Patchanforderung.
Name | Typ | Beschreibung |
---|---|---|
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[] |
Der Richtlinieneigenschaftswert überschreibt. |
properties.resourceSelectors |
Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften. |
ResourceIdentityType
Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
Gibt an, dass der Ressource keine Identität zugeordnet ist oder dass die vorhandene Identität entfernt werden soll. |
SystemAssigned |
string |
Gibt an, dass der Ressource eine systemseitig zugewiesene Identität zugeordnet ist. |
UserAssigned |
string |
Gibt an, dass der Ressource eine systemseitig zugewiesene Identität zugeordnet ist. |
ResourceSelector
Der Ressourcenauswahlgeber zum Filtern von Richtlinien nach Ressourceneigenschaften.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name des Ressourcenauswahlors. |
selectors |
Selector[] |
Die Liste der Selektorausdrücke. |
Selector
Der Selektorausdruck.
Name | Typ | Beschreibung |
---|---|---|
in |
string[] |
Die Liste der zu filternden Werte. |
kind |
Die Selektorart. |
|
notIn |
string[] |
Die Liste der zu filternden Werte. |
SelectorKind
Die Selektorart.
Name | Typ | Beschreibung |
---|---|---|
policyDefinitionReferenceId |
string |
Die Selektorart zum Filtern von Richtlinien nach der Referenz-ID der Richtliniendefinition. |
resourceLocation |
string |
Die Selektorart zum Filtern von Richtlinien nach dem Ressourcenspeicherort. |
resourceType |
string |
Die Selektorart zum Filtern von Richtlinien nach dem Ressourcentyp. |
resourceWithoutLocation |
string |
Die Selektorart zum Filtern von Richtlinien nach der Ressource ohne Speicherort. |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
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}".
Name | Typ | Beschreibung |
---|---|---|
|