Dela via

Policy Assignments - Get

  • Referens
Tjänst:
Policy
API-version:
2023-04-01

Hämtar en principtilldelning.
Den här åtgärden hämtar en enskild principtilldelning med namnet och det omfång som den skapades på.

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

URI-parametrar

Name I Obligatorisk Typ Description
policyAssignmentName
 path True

string

Namnet på den principtilldelning som ska hämtas.

Reguljärt uttrycksmönster: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

Omfånget för principtilldelningen. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', eller resurs (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version
 query True

string

DEN API-version som ska användas för den här åtgärden.
$expand
 query

string

Kommaavgränsad lista över ytterligare egenskaper som ska ingå i svaret. Värden som stöds är "LatestDefinitionVersion, EffectiveDefinitionVersion".

Svar

Name Typ Description
200 OK

PolicyAssignment

OK – Returnerar information om principtilldelningen.
Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
CloudError

Ett felsvar från en principåtgärd.
createdByType

Den typ av identitet som skapade resursen.
enforcementMode

Tvingande läge för principtilldelning. Möjliga värden är Standard och DoNotEnforce.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorResponse

Felsvar
Identity

Identitet för resursen. Principtilldelningar stöder högst en identitet. Det är antingen en systemtilldelad identitet eller en enda användartilldelad identitet.
NonComplianceMessage

Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.
Override

Åsidosättning av principegenskapsvärdet.
OverrideKind

Åsidosättningstyp.
ParameterValuesValue

Värdet för en parameter.
PolicyAssignment

Principtilldelningen.
ResourceIdentityType

Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.
ResourceSelector

Resursväljaren som filtrerar principer efter resursegenskaper.
Selector

Väljarens uttryck.
SelectorKind

Väljarens typ.
systemData

Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentities

Användaridentiteten som är associerad med principen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CloudError

Ett felsvar från en principåtgärd.

Name Typ Description
error

ErrorResponse

Felsvar
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.)

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

Tvingande läge för principtilldelning. Möjliga värden är Standard och DoNotEnforce.

Name Typ Description
Default

string

Principeffekten framtvingas när resursen skapas eller uppdateras.
DoNotEnforce

string

Principeffekten tillämpas inte när resursen skapas eller uppdateras.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorResponse

Felsvar

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorResponse[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

Identity

Identitet för resursen. Principtilldelningar stöder högst en identitet. Det är antingen en systemtilldelad identitet eller en enda användartilldelad identitet.

Name Typ Description
principalId

string

Resursidentitetens huvud-ID. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet
tenantId

string

Klientorganisations-ID för resursidentiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet
type

ResourceIdentityType

Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.
userAssignedIdentities

UserAssignedIdentities

Användaridentiteten som är associerad med principen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.

Name Typ Description
message

string

Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.
policyDefinitionReferenceId

string

Referens-ID:t för principdefinitionen i en principuppsättningsdefinition som meddelandet är avsett för. Detta gäller endast om principtilldelningen tilldelar en principuppsättningsdefinition. Om detta inte anges gäller meddelandet för alla principer som tilldelats av den här principtilldelningen.

Override

Åsidosättning av principegenskapsvärdet.

Name Typ Description
kind

OverrideKind

Åsidosättningstyp.
selectors

Selector[]

Listan över väljarens uttryck.
value

string

Värdet för att åsidosätta principegenskapen.

OverrideKind

Åsidosättningstyp.

Name Typ Description
policyEffect

string

Den åsidosätter principeffekttypen.

ParameterValuesValue

Värdet för en parameter.

Name Typ Description
value

object

Värdet för parametern.

PolicyAssignment

Principtilldelningen.

Name Typ Standardvärde Description
id

string

ID för principtilldelningen.
identity

Identity

Den hanterade identitet som är associerad med principtilldelningen.
location

string

Platsen för principtilldelningen. Krävs endast vid användning av hanterad identitet.
name

string

Namnet på principtilldelningen.
properties.definitionVersion

string

Den version av principdefinitionen som ska användas.
properties.description

string

Det här meddelandet är en del av svaret i händelse av principöverträdelse.
properties.displayName

string

Visningsnamnet för principtilldelningen.
properties.effectiveDefinitionVersion

string

Den effektiva versionen av principdefinitionen som används. Detta finns bara om det begärs via frågeparametern $expand.
properties.enforcementMode

enforcementMode

Default

Tvingande läge för principtilldelning. Möjliga värden är Standard och DoNotEnforce.
properties.latestDefinitionVersion

string

Den senaste versionen av den tillgängliga principdefinitionen. Detta finns bara om det begärs via frågeparametern $expand.
properties.metadata

object

Metadata för principtilldelning. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
properties.nonComplianceMessages

NonComplianceMessage[]

Meddelandena som beskriver varför en resurs inte är kompatibel med principen.
properties.notScopes

string[]

Principens undantagna omfång.
properties.overrides

Override[]

Åsidosättning av principegenskapsvärdet.
properties.parameters

<string,  ParameterValuesValue>

Parametervärdena för den tilldelade principregeln. Nycklarna är parameternamnen.
properties.policyDefinitionId

string

ID:t för den principdefinition eller principuppsättningsdefinition som tilldelas.
properties.resourceSelectors

ResourceSelector[]

Listan över resursväljare för att filtrera principer efter resursegenskaper.
properties.scope

string

Omfånget för principtilldelningen.
systemData

systemData

Systemmetadata för den här resursen.
type

string

Typen av principtilldelning.

ResourceIdentityType

Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.

Name Typ Description
None

string

Anger att ingen identitet är associerad med resursen eller att den befintliga identiteten ska tas bort.
SystemAssigned

string

Anger att en systemtilldelad identitet är associerad med resursen.
UserAssigned

string

Anger att en systemtilldelad identitet är associerad med resursen.

ResourceSelector

Resursväljaren som filtrerar principer efter resursegenskaper.

Name Typ Description
name

string

Namnet på resursväljaren.
selectors

Selector[]

Listan över väljarens uttryck.

Selector

Väljarens uttryck.

Name Typ Description
in

string[]

Listan med värden som ska filtreras in.
kind

SelectorKind

Väljarens typ.
notIn

string[]

Listan med värden som ska filtreras bort.

SelectorKind

Väljarens typ.

Name Typ Description
policyDefinitionReferenceId

string

Väljarens typ för att filtrera principer efter principdefinitionens referens-ID.
resourceLocation

string

Väljarens typ för att filtrera principer efter resursplatsen.
resourceType

string

Väljarens typ för att filtrera principer efter resurstyp.
resourceWithoutLocation

string

Väljarens typ för att filtrera principer efter resursen utan plats.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAssignedIdentities

Användaridentiteten som är associerad med principen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Typ Description