Policy Assignments - Update
Ez a művelet frissíti a szabályzat-hozzárendelést a megadott hatókörrel és névvel. A szabályzat-hozzárendelések a hatókörükben található összes erőforrásra vonatkoznak. Ha például erőforráscsoport-hatókörhöz rendel egy szabályzatot, az a csoport összes erőforrására érvényes.
PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
policy
|
path | True |
string |
A szabályzat-hozzárendelés neve. Regex pattern: |
scope
|
path | True |
string |
A szabályzat-hozzárendelés hatóköre. Érvényes hatókörök: felügyeleti csoport (formátum: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), előfizetés (formátum: "/subscriptions/{subscriptionId}"), erőforráscsoport (formátum: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", vagy erőforrás (formátum: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}" |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
identity |
A szabályzat-hozzárendeléshez társított felügyelt identitás. |
|
location |
string |
A szabályzat-hozzárendelés helye. Csak felügyelt identitás használatakor szükséges. |
properties.overrides |
Override[] |
A szabályzattulajdonság értékének felülbírálása. |
properties.resourceSelectors |
Az erőforrás-választó lista, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK – A szabályzat-hozzárendeléssel kapcsolatos információkat adja vissza. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
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"
}
Definíciók
Name | Description |
---|---|
Cloud |
Egy szabályzatművelet hibaválasza. |
created |
Az erőforrást létrehozó identitás típusa. |
enforcement |
A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Default és DoNotEnforce. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
Identity |
Az erőforrás identitása. A szabályzat-hozzárendelések legfeljebb egy identitást támogatnak. Ez vagy egy rendszer által hozzárendelt identitás, vagy egy felhasználó által hozzárendelt identitás. |
Non |
Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "megtagadás" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg. |
Override |
A szabályzattulajdonság értékének felülbírálása. |
Override |
A felülbírálás típusa. |
Parameter |
Egy paraméter értéke. |
Policy |
A szabályzat-hozzárendelés. |
Policy |
A javítási kérelem szabályzat-hozzárendelése. |
Resource |
Az identitás típusa. Ez az egyetlen kötelező mező, amikor rendszer- vagy felhasználó által hozzárendelt identitást ad hozzá egy erőforráshoz. |
Resource |
Az erőforrás-választó, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat. |
Selector |
A választókifejezés. |
Selector |
A választó típusa. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
User |
A szabályzathoz társított felhasználói identitás. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
CloudError
Egy szabályzatművelet hibaválasza.
Name | Típus | Description |
---|---|---|
error |
Hibaválasz |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
enforcementMode
A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Default és DoNotEnforce.
Name | Típus | Description |
---|---|---|
Default |
string |
A szabályzathatás kényszerítve van az erőforrás-létrehozás vagy -frissítés során. |
DoNotEnforce |
string |
A szabályzat hatása nem lesz kényszerítve az erőforrás létrehozása vagy frissítése során. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
Identity
Az erőforrás identitása. A szabályzat-hozzárendelések legfeljebb egy identitást támogatnak. Ez vagy egy rendszer által hozzárendelt identitás, vagy egy felhasználó által hozzárendelt identitás.
Name | Típus | Description |
---|---|---|
principalId |
string |
Az erőforrás-identitás egyszerű azonosítója. Ez a tulajdonság csak rendszer által hozzárendelt identitáshoz lesz megadva |
tenantId |
string |
Az erőforrás-identitás bérlőazonosítója. Ez a tulajdonság csak rendszer által hozzárendelt identitáshoz lesz megadva |
type |
Az identitás típusa. Ez az egyetlen kötelező mező, amikor rendszer- vagy felhasználó által hozzárendelt identitást ad hozzá egy erőforráshoz. |
|
userAssignedIdentities |
A szabályzathoz társított felhasználói identitás. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
NonComplianceMessage
Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "megtagadás" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg.
Name | Típus | Description |
---|---|---|
message |
string |
Üzenet, amely leírja, hogy egy erőforrás miért nem felel meg a szabályzatnak. Ez a "megtagadás" hibaüzenetekben és az erőforrás nem megfelelő megfelelőségi eredményeiben jelenik meg. |
policyDefinitionReferenceId |
string |
A szabályzatdefiníció hivatkozási azonosítója egy szabályzatkészlet-definícióban, amelynek az üzenetet szánták. Ez csak akkor alkalmazható, ha a szabályzat-hozzárendelés hozzárendel egy szabályzatkészlet-definíciót. Ha ez nem jelenik meg, az üzenet a szabályzat-hozzárendelés által hozzárendelt összes szabályzatra vonatkozik. |
Override
A szabályzattulajdonság értékének felülbírálása.
Name | Típus | Description |
---|---|---|
kind |
A felülbírálás típusa. |
|
selectors |
Selector[] |
A választókifejezések listája. |
value |
string |
A szabályzattulajdonság felülbírálásához használni kívánt érték. |
OverrideKind
A felülbírálás típusa.
Name | Típus | Description |
---|---|---|
policyEffect |
string |
Felülbírálja a szabályzateffektus típusát. |
ParameterValuesValue
Egy paraméter értéke.
Name | Típus | Description |
---|---|---|
value |
object |
A paraméter értéke. |
PolicyAssignment
A szabályzat-hozzárendelés.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
id |
string |
A szabályzat-hozzárendelés azonosítója. |
|
identity |
A szabályzat-hozzárendeléshez társított felügyelt identitás. |
||
location |
string |
A szabályzat-hozzárendelés helye. Csak felügyelt identitás használatakor szükséges. |
|
name |
string |
A szabályzat-hozzárendelés neve. |
|
properties.description |
string |
Ez az üzenet a szabályzat megsértése esetén a válasz része lesz. |
|
properties.displayName |
string |
A szabályzat-hozzárendelés megjelenítendő neve. |
|
properties.enforcementMode | Default |
A szabályzat-hozzárendelés kényszerítési módja. Lehetséges értékek: Default és DoNotEnforce. |
|
properties.metadata |
object |
A szabályzat-hozzárendelés metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye. |
|
properties.nonComplianceMessages |
Azokat az üzeneteket, amelyek azt írják le, hogy egy erőforrás miért nem felel meg a szabályzatnak. |
||
properties.notScopes |
string[] |
A szabályzat kizárt hatókörei. |
|
properties.overrides |
Override[] |
A szabályzattulajdonság értékének felülbírálása. |
|
properties.parameters |
<string,
Parameter |
A hozzárendelt szabályzatszabály paraméterértékei. A kulcsok a paraméternevek. |
|
properties.policyDefinitionId |
string |
A hozzárendelt szabályzatdefiníció vagy szabályzatkészlet-definíció azonosítója. |
|
properties.resourceSelectors |
Az erőforrás-választó lista, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat. |
||
properties.scope |
string |
A szabályzat-hozzárendelés hatóköre. |
|
systemData |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
||
type |
string |
A szabályzat-hozzárendelés típusa. |
PolicyAssignmentUpdate
A javítási kérelem szabályzat-hozzárendelése.
Name | Típus | Description |
---|---|---|
identity |
A szabályzat-hozzárendeléshez társított felügyelt identitás. |
|
location |
string |
A szabályzat-hozzárendelés helye. Csak felügyelt identitás használatakor szükséges. |
properties.overrides |
Override[] |
A szabályzattulajdonság értékének felülbírálása. |
properties.resourceSelectors |
Az erőforrás-választó lista, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat. |
ResourceIdentityType
Az identitás típusa. Ez az egyetlen kötelező mező, amikor rendszer- vagy felhasználó által hozzárendelt identitást ad hozzá egy erőforráshoz.
Name | Típus | Description |
---|---|---|
None |
string |
Azt jelzi, hogy nincs identitás társítva az erőforráshoz, vagy hogy a meglévő identitást el kell távolítani. |
SystemAssigned |
string |
Azt jelzi, hogy egy rendszer által hozzárendelt identitás van társítva az erőforráshoz. |
UserAssigned |
string |
Azt jelzi, hogy egy rendszer által hozzárendelt identitás van társítva az erőforráshoz. |
ResourceSelector
Az erőforrás-választó, amely erőforrás-tulajdonságok alapján szűri a szabályzatokat.
Name | Típus | Description |
---|---|---|
name |
string |
Az erőforrás-választó neve. |
selectors |
Selector[] |
A választókifejezések listája. |
Selector
A választókifejezés.
Name | Típus | Description |
---|---|---|
in |
string[] |
A szűrni kívánt értékek listája. |
kind |
A választó típusa. |
|
notIn |
string[] |
A kiszűrni kívánt értékek listája. |
SelectorKind
A választó típusa.
Name | Típus | Description |
---|---|---|
policyDefinitionReferenceId |
string |
A szabályzatok szabályzatdefiníció referencia-azonosító alapján történő szűrésére szolgáló választótípus. |
resourceLocation |
string |
A szabályzatok erőforráshely szerinti szűrésére vonatkozó választótípus. |
resourceType |
string |
A szabályzatok erőforrástípus szerinti szűrésére vonatkozó választótípus. |
resourceWithoutLocation |
string |
A választó típusa a szabályzatok hely nélküli erőforrás szerinti szűréséhez. |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az erőforrást utoljára módosító identitás. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |
UserAssignedIdentities
A szabályzathoz társított felhasználói identitás. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
Name | Típus | Description |
---|---|---|
|