Delen via


Policy Assignments - List For Resource Group

Hiermee worden alle beleidstoewijzingen opgehaald die van toepassing zijn op een resourcegroep.
Met deze bewerking wordt de lijst opgehaald met alle beleidstoewijzingen die zijn gekoppeld aan de opgegeven resourcegroep in het opgegeven abonnement die overeenkomen met de optionele opgegeven $filter. Geldige waarden voor $filter zijn: 'atScope()', 'atExactScope()' of 'policyDefinitionId eq '{value}'. Als $filter niet is opgegeven, bevat de niet-gefilterde lijst alle beleidstoewijzingen die zijn gekoppeld aan de resourcegroep, met inbegrip van toewijzingen die rechtstreeks van toepassing zijn of die van toepassing zijn vanuit bereiken, evenals alle toewijzingen die worden toegepast op resources in de resourcegroep. Als $filter=atScope() is opgegeven, bevat de geretourneerde lijst alle beleidstoewijzingen die van toepassing zijn op de resourcegroep. Dit is alles in de niet-gefilterde lijst, behalve de toewijzingen die worden toegepast op resources in de resourcegroep. Als $filter=atExactScope() wordt opgegeven, bevat de geretourneerde lijst alleen alle beleidstoewijzingen in de resourcegroep. Als $filter=policyDefinitionId eq {value} is opgegeven, bevat de geretourneerde lijst alle beleidstoewijzingen van de beleidsdefinitie met de id {value} die van toepassing zijn op de resourcegroep.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$top={$top}&api-version=2023-04-01

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep die beleidstoewijzingen bevat.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

uuid

De id van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

$filter
query

string

Het filter dat moet worden toegepast op de bewerking. Geldige waarden voor $filter zijn: 'atScope()', 'atExactScope()' of 'policyDefinitionId eq '{value}'. Als $filter niet is opgegeven, wordt er geen filter uitgevoerd. Als $filter=atScope() wordt opgegeven, bevat de geretourneerde lijst alleen alle beleidstoewijzingen die van toepassing zijn op het bereik. Dit is alles in de niet-gefilterde lijst, met uitzondering van de toewijzingen die worden toegepast op subbereiken in het opgegeven bereik. Als $filter=atExactScope() is opgegeven, bevat de geretourneerde lijst alleen alle beleidstoewijzingen voor het opgegeven bereik. Als $filter=policyDefinitionId eq {value} is opgegeven, bevat de geretourneerde lijst alle beleidstoewijzingen van de beleidsdefinitie met de id {value}.

$top
query

integer

int32

Maximum aantal records dat moet worden geretourneerd. Wanneer het $top filter niet is opgegeven, worden 500 records geretourneerd.

Antwoorden

Name Type Description
200 OK

PolicyAssignmentListResult

OK: retourneert een matrix met beleidstoewijzingen.

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

List policy assignments that apply to a resource group

Sample Request

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&api-version=2023-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestCostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestTagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup",
        "notScopes": []
      }
    }
  ]
}

Definities

Name Description
CloudError

Een foutreactie van een beleidsbewerking.

createdByType

Het type identiteit waarmee de resource is gemaakt.

enforcementMode

De afdwingingsmodus voor beleidstoewijzingen. 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 de 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 overschrijft.

OverrideKind

Het soort onderdrukking.

ParameterValuesValue

De waarde van een parameter.

PolicyAssignment

De beleidstoewijzing.

PolicyAssignmentListResult

Lijst met beleidstoewijzingen.

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 resourceselector voor het filteren van beleidsregels op resource-eigenschappen.

Selector

De selectorexpressie.

SelectorKind

Het type selector.

systemData

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

UserAssignedIdentities

De gebruikersidentiteit die aan het beleid is gekoppeld. 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 OData-foutreactieindeling.)

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

De afdwingingsmodus voor beleidstoewijzingen. 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[]

Aanvullende informatie over de fout.

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 de 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 aan het beleid is gekoppeld. 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 overschrijft.

Name Type Description
kind

OverrideKind

Het soort onderdrukking.

selectors

Selector[]

De lijst met de selector-expressies.

value

string

De waarde voor het overschrijven van de beleidseigenschap.

OverrideKind

Het soort onderdrukking.

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 beleidstoewijzingen. Mogelijke waarden zijn Default en DoNotEnforce.

properties.metadata

object

De metagegevens van de beleidstoewijzing. Metagegevens zijn een open-ended object 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 overschrijft.

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 beleidsregels op resource-eigenschappen.

properties.scope

string

Het bereik voor de beleidstoewijzing.

systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.

type

string

Het type beleidstoewijzing.

PolicyAssignmentListResult

Lijst met beleidstoewijzingen.

Name Type Description
nextLink

string

De URL die moet worden gebruikt om de volgende set resultaten op te halen.

value

PolicyAssignment[]

Een matrix van beleidstoewijzingen.

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 resourceselector voor het filteren van beleidsregels op resource-eigenschappen.

Name Type Description
name

string

De naam van de resourcekiezer.

selectors

Selector[]

De lijst met de selector-expressies.

Selector

De selectorexpressie.

Name Type Description
in

string[]

De lijst met waarden om in te filteren.

kind

SelectorKind

Het type selector.

notIn

string[]

De lijst met waarden die moeten worden uitgefilterd.

SelectorKind

Het type selector.

Name Type Description
policyDefinitionReferenceId

string

Het type selector om beleidsregels te filteren op de referentie-id van de beleidsdefinitie.

resourceLocation

string

Het type selector voor het filteren van beleidsregels op de resourcelocatie.

resourceType

string

Het type selector om beleid te filteren op resourcetype.

resourceWithoutLocation

string

Het type selector voor het filteren van beleidsregels op de resource zonder locatie.

systemData

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

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

De 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 aan het beleid is gekoppeld. 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