Policy Assignments - Get

Service:

Policy

API-versie:

2023-04-01

Hiermee haalt u een beleidstoewijzing op.
Met deze bewerking wordt één beleidstoewijzing opgehaald, op basis van de naam en het bereik waarvoor deze is gemaakt.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
policyAssignmentName	path	True	string	De naam van de beleidstoewijzing die moet worden opgehaald. Regex-patroon: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope	path	True	string	Het bereik van de beleidstoewijzing. 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}'
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$expand	query		string	Door komma's gescheiden lijst met aanvullende eigenschappen die moeten worden opgenomen in het antwoord. Ondersteunde waarden zijn 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

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

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Retrieve a policy assignment

Retrieve a policy assignment with a system assigned identity

Retrieve a policy assignment with a user assigned identity

Retrieve a policy assignment with overrides

Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Voorbeeldrespons

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"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a system assigned identity

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Voorbeeldrespons

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": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a user assigned identity

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

Voorbeeldrespons

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": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with overrides

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

Voorbeeldrespons

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

Retrieve a policy assignment with resource selectors

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Een foutbericht van een beleidsbewerking.
createdByType	Het type identiteit waarmee de resource is gemaakt.
enforcementMode	De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Standaard 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 'weigeren' en in de niet-compatibele nalevingsresultaten van de resource.
Override	De waarde van de beleidseigenschap wordt overschreven.
OverrideKind	Het onderdrukkingstype.
ParameterValuesValue	De waarde van een parameter.
PolicyAssignment	De beleidstoewijzing.
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 selector-expressie.
SelectorKind	De soort selector.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentities	De gebruikersidentiteit die is gekoppeld aan het beleid. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

CloudError

Een foutbericht van een beleidsbewerking.

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

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 Standaard en DoNotEnforce.

Name	Type	Description
Default	string	Het beleidseffect wordt afgedwongen tijdens het 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 extra informatietype.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat 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 de gebruiker toegewezen identiteit.

Name	Type	Description
principalId	string	De principal-id van de resource-id. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit
tenantId	string	De tenant-id van de resource-id. Deze eigenschap wordt alleen verstrekt 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 voor 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 '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 '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 aan de beleidstoewijzing een beleidssetdefinitie wordt toegewezen. Als dit niet is opgegeven, is het bericht van toepassing op alle beleidsregels die door deze beleidstoewijzing zijn toegewezen.

Override

De waarde van de beleidseigenschap wordt overschreven.

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

OverrideKind

Het onderdrukkingstype.

Name	Type	Description
policyEffect	string	Het beleidseffecttype wordt overschreven.

ParameterValuesValue

De waarde van een parameter.

Name	Type	Description
value	object	De waarde van de parameter.

PolicyAssignment

De beleidstoewijzing.

Name	Type	Default value	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 beheerde identiteit.
name	string		De naam van de beleidstoewijzing.
properties.definitionVersion	string		De versie van de te gebruiken beleidsdefinitie.
properties.description	string		Dit bericht maakt deel uit van het antwoord in het geval van een schending van het beleid.
properties.displayName	string		De weergavenaam van de beleidstoewijzing.
properties.effectiveDefinitionVersion	string		De effectieve versie van de gebruikte beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
properties.enforcementMode	enforcementMode	Default	De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Standaard en DoNotEnforce.
properties.latestDefinitionVersion	string		De nieuwste versie van de beschikbare beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
properties.metadata	object		De metagegevens van de beleidstoewijzing. Metagegevens zijn een geopend object en zijn meestal een verzameling sleutel-waardeparen.
properties.nonComplianceMessages	NonComplianceMessage[]		De berichten die beschrijven waarom een resource niet compatibel is met het beleid.
properties.notScopes	string[]		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 om beleidsregels te filteren 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.

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

Selector

De selector-expressie.

Name	Type	Description
in	string[]	De lijst met waarden waarin u wilt filteren.
kind	SelectorKind	De soort selector.
notIn	string[]	De lijst met waarden die moeten worden gefilterd.

SelectorKind

De soort selector.

Name	Type	Description
policyDefinitionReferenceId	string	Het type selector om beleid te filteren op basis van 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 beleidsregels te filteren op het resourcetype.
resourceWithoutLocation	string	Het type selector om beleidsregels te filteren op de resource zonder locatie.

systemData

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

Name	Type	Description
createdAt	string	De 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 voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentities

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

Name	Type	Description