Policy Assignments - Update By Id

Service:

Policy

API Version:

2023-04-01

Updates een beleidstoewijzing.
Met deze bewerking wordt de beleidstoewijzing bijgewerkt met de opgegeven id. Beleidstoewijzingen voor een bereik zijn van toepassing op alle resources in dat bereik. Wanneer u bijvoorbeeld een beleid toewijst aan een resourcegroep, is dat beleid van toepassing op alle resources in de groep. Beleidstoewijzings-id's hebben deze indeling: {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}. Geldige bereiken zijn: beheergroep (indeling: /providers/Microsoft.Management/managementGroups/{managementGroup}), abonnement (indeling: '/subscriptions/{subscriptionId}'), resourcegroep (indeling: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', of resource (indeling: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PATCH https://management.azure.com/{policyAssignmentId}?api-version=2023-04-01

URI-parameters

Name	In	Vereist	Type	Description
policyAssignmentId	path	True	string	De id van de beleidstoewijzing die moet worden bijgewerkt. Gebruik de indeling {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
identity	Identity	De beheerde identiteit die is gekoppeld aan de beleidstoewijzing.
location	string	De locatie van de beleidstoewijzing. Alleen vereist bij het gebruik van een beheerde identiteit.
properties.overrides	Override[]	De waarde van de beleidseigenschap wordt overschreven.
properties.resourceSelectors	ResourceSelector[]	De lijst met resourcekiezers voor het filteren van beleid op resource-eigenschappen.

Antwoorden

Name	Type	Description
200 OK	PolicyAssignment	OK: retourneert informatie over de beleidstoewijzing.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update policy assignment with a managed identity by ID

Sample Request

HTTP

PATCH https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus"
}

Sample Response

Status code:

200

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

Definities

Name	Description
CloudError	Een foutreactie van een beleidsbewerking.
createdByType	Het type identiteit waarmee de resource is gemaakt.
enforcementMode	De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Default en DoNotEnforce.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
Identity	Identiteit voor de resource. Beleidstoewijzingen ondersteunen maximaal één identiteit. Dat is een door het systeem toegewezen identiteit of één door een gebruiker toegewezen identiteit.
NonComplianceMessage	Een bericht waarin wordt beschreven waarom een resource niet compatibel is met het beleid. Dit wordt weergegeven in foutberichten over weigeren en in de niet-compatibele nalevingsresultaten van de resource.
Override	De waarde van de beleidseigenschap wordt overschreven.
OverrideKind	De onderdrukking soort.
ParameterValuesValue	De waarde van een parameter.
PolicyAssignment	De beleidstoewijzing.
PolicyAssignmentUpdate	De beleidstoewijzing voor patchaanvraag.
ResourceIdentityType	Het identiteitstype. Dit is het enige vereiste veld bij het toevoegen van een door het systeem of de gebruiker toegewezen identiteit aan een resource.
ResourceSelector	De resourcekiezer voor het filteren van beleid op resource-eigenschappen.
Selector	De selectorexpressie.
SelectorKind	De selector soort.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
UserAssignedIdentities	De gebruikersidentiteit die is gekoppeld aan het beleid. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

CloudError

Een foutreactie van een beleidsbewerking.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Default en DoNotEnforce.

Name	Type	Description
Default	string	Het beleidseffect wordt afgedwongen tijdens maken of bijwerken van resources.
DoNotEnforce	string	Het beleidseffect wordt niet afgedwongen tijdens het maken of bijwerken van resources.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

Identity

Identiteit voor de resource. Beleidstoewijzingen ondersteunen maximaal één identiteit. Dat is een door het systeem toegewezen identiteit of één door een gebruiker toegewezen identiteit.

Name	Type	Description
principalId	string	De principal-id van de resource-id. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit
tenantId	string	De tenant-id van de resource-id. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit
type	ResourceIdentityType	Het identiteitstype. Dit is het enige vereiste veld bij het toevoegen van een door het systeem of de gebruiker toegewezen identiteit aan een resource.
userAssignedIdentities	UserAssignedIdentities	De gebruikersidentiteit die is gekoppeld aan het beleid. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

NonComplianceMessage

Een bericht waarin wordt beschreven waarom een resource niet compatibel is met het beleid. Dit wordt weergegeven in foutberichten over weigeren en in de niet-compatibele nalevingsresultaten van de resource.

Name	Type	Description
message	string	Een bericht waarin wordt beschreven waarom een resource niet compatibel is met het beleid. Dit wordt weergegeven in foutberichten over weigeren en in de niet-compatibele nalevingsresultaten van de resource.
policyDefinitionReferenceId	string	De referentie-id van de beleidsdefinitie binnen een beleidssetdefinitie waarvoor het bericht is bedoeld. Dit is alleen van toepassing als de beleidstoewijzing een definitie van een beleidsset toewijst. Als dit niet is opgegeven, is het bericht van toepassing op alle beleidsregels die zijn toegewezen door deze beleidstoewijzing.

Override

De waarde van de beleidseigenschap wordt overschreven.

Name	Type	Description
kind	OverrideKind	De onderdrukking soort.
selectors	Selector[]	De lijst met de selectorexpressies.
value	string	De waarde voor het overschrijven van de beleidseigenschap.

OverrideKind

De onderdrukking soort.

Name	Type	Description
policyEffect	string	Hiermee wordt het type beleidseffect overschreven.

ParameterValuesValue

De waarde van een parameter.

Name	Type	Description
value	object	De waarde van de parameter.

PolicyAssignment

De beleidstoewijzing.

Name	Type	Standaardwaarde	Description
id	string		De id van de beleidstoewijzing.
identity	Identity		De beheerde identiteit die is gekoppeld aan de beleidstoewijzing.
location	string		De locatie van de beleidstoewijzing. Alleen vereist bij het gebruik van een beheerde identiteit.
name	string		De naam van de beleidstoewijzing.
properties.description	string		Dit bericht maakt deel uit van het antwoord in geval van beleidsschending.
properties.displayName	string		De weergavenaam van de beleidstoewijzing.
properties.enforcementMode	enforcementMode	Default	De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Default en DoNotEnforce.
properties.metadata	object		De metagegevens van de beleidstoewijzing. Metagegevens zijn een open-eindobject en zijn meestal een verzameling sleutelwaardeparen.
properties.nonComplianceMessages	NonComplianceMessage[]		De berichten waarin wordt beschreven waarom een resource niet compatibel is met het beleid.
properties.notScopes	string[]		De uitgesloten bereiken van het beleid.
properties.overrides	Override[]		De waarde van de beleidseigenschap wordt overschreven.
properties.parameters	<string,  ParameterValuesValue>		De parameterwaarden voor de toegewezen beleidsregel. De sleutels zijn de parameternamen.
properties.policyDefinitionId	string		De id van de beleidsdefinitie of beleidssetdefinitie die wordt toegewezen.
properties.resourceSelectors	ResourceSelector[]		De lijst met resourcekiezers voor het filteren van beleid op resource-eigenschappen.
properties.scope	string		Het bereik voor de beleidstoewijzing.
systemData	systemData		De systeemmetagegevens met betrekking tot deze resource.
type	string		Het type van de beleidstoewijzing.

PolicyAssignmentUpdate

De beleidstoewijzing voor patchaanvraag.

Name	Type	Description
identity	Identity	De beheerde identiteit die is gekoppeld aan de beleidstoewijzing.
location	string	De locatie van de beleidstoewijzing. Alleen vereist bij het gebruik van een beheerde identiteit.
properties.overrides	Override[]	De waarde van de beleidseigenschap wordt overschreven.
properties.resourceSelectors	ResourceSelector[]	De lijst met resourcekiezers voor het filteren van beleid op resource-eigenschappen.

ResourceIdentityType

Het identiteitstype. Dit is het enige vereiste veld bij het toevoegen van een door het systeem of de gebruiker toegewezen identiteit aan een resource.

Name	Type	Description
None	string	Geeft aan dat er geen identiteit is gekoppeld aan de resource of dat de bestaande identiteit moet worden verwijderd.
SystemAssigned	string	Geeft aan dat een door het systeem toegewezen identiteit is gekoppeld aan de resource.
UserAssigned	string	Geeft aan dat een door het systeem toegewezen identiteit is gekoppeld aan de resource.

ResourceSelector

De resourcekiezer voor het filteren van beleid op resource-eigenschappen.

Name	Type	Description
name	string	De naam van de resourcekiezer.
selectors	Selector[]	De lijst met de selectorexpressies.

Selector

De selectorexpressie.

Name	Type	Description
in	string[]	De lijst met waarden om in te filteren.
kind	SelectorKind	De selector soort.
notIn	string[]	De lijst met waarden die moeten worden uitgefilterd.

SelectorKind

De selector soort.

Name	Type	Description
policyDefinitionReferenceId	string	De selector filtert beleidsregels op basis van de referentie-id van de beleidsdefinitie.
resourceLocation	string	Het type selector om beleid te filteren op de resourcelocatie.
resourceType	string	Het type selector voor het filteren van beleidsregels op resourcetype.
resourceWithoutLocation	string	De selector filtert beleidsregels op de resource zonder locatie.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAssignedIdentities

De gebruikersidentiteit die is gekoppeld aan het beleid. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Name	Type	Description