Udostępnij za pośrednictwem

Policy Assignments - Get

  • Odwołanie
Usługa:
Policy
Wersja interfejsu API:
2023-04-01

Pobiera przypisanie zasad.
Ta operacja pobiera pojedyncze przypisanie zasad, biorąc pod uwagę jego nazwę i zakres, na który został utworzony.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
policyAssignmentName
 path True

string

Nazwa przypisania zasad do pobrania.

Wzorzec wyrażenia regularnego: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

Zakres przypisania zasad. Prawidłowe zakresy to: grupa zarządzania (format: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), subskrypcja (format: "/subscriptions/{subscriptionId}"), grupa zasobów (format: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", lub zasób (format: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.
$expand
 query

string

Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi. Obsługiwane wartości to "LatestDefinitionVersion, EffectiveDefinitionVersion".

Odpowiedzi

Nazwa Typ Opis
200 OK

PolicyAssignment

OK — zwraca informacje o przypisaniu zasad.
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
}

Definicje

Nazwa Opis
CloudError

Odpowiedź na błąd z operacji zasad.
createdByType

Typ tożsamości, która utworzyła zasób.
enforcementMode

Tryb wymuszania przypisania zasad. Możliwe wartości to Default i DoNotEnforce.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse

Odpowiedź na błąd
Identity

Tożsamość zasobu. Przypisania zasad obsługują maksymalnie jedną tożsamość. Jest to tożsamość przypisana przez system lub tożsamość przypisana przez jednego użytkownika.
NonComplianceMessage

Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.
Override

Wartość właściwości zasad zastępuje.
OverrideKind

Rodzaj przesłonięcia.
ParameterValuesValue

Wartość parametru.
PolicyAssignment

Przypisanie zasad.
ResourceIdentityType

Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu.
ResourceSelector

Selektor zasobów do filtrowania zasad według właściwości zasobów.
Selector

Wyrażenie selektora.
SelectorKind

Rodzaj selektora.
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentities

Tożsamość użytkownika skojarzona z zasadami. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Odpowiedź na błąd z operacji zasad.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

Tryb wymuszania przypisania zasad. Możliwe wartości to Default i DoNotEnforce.

Nazwa Typ Opis
Default

string

Efekt zasad jest wymuszany podczas tworzenia lub aktualizowania zasobów.
DoNotEnforce

string

Efekt zasad nie jest wymuszany podczas tworzenia ani aktualizowania zasobów.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorResponse[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

Identity

Tożsamość zasobu. Przypisania zasad obsługują maksymalnie jedną tożsamość. Jest to tożsamość przypisana przez system lub tożsamość przypisana przez jednego użytkownika.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system
tenantId

string

Identyfikator dzierżawy tożsamości zasobu. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system
type

ResourceIdentityType

Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu.
userAssignedIdentities

UserAssignedIdentities

Tożsamość użytkownika skojarzona z zasadami. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.

Nazwa Typ Opis
message

string

Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu.
policyDefinitionReferenceId

string

Identyfikator odwołania definicji zasad w definicji zestawu zasad, dla których jest przeznaczony komunikat. Ma to zastosowanie tylko wtedy, gdy przypisanie zasad przypisuje definicję zestawu zasad. Jeśli nie zostanie podany komunikat dotyczy wszystkich zasad przypisanych przez to przypisanie zasad.

Override

Wartość właściwości zasad zastępuje.

Nazwa Typ Opis
kind

OverrideKind

Rodzaj przesłonięcia.
selectors

Selector[]

Lista wyrażeń selektora.
value

string

Wartość, aby zastąpić właściwość zasad.

OverrideKind

Rodzaj przesłonięcia.

Nazwa Typ Opis
policyEffect

string

Zastąpi typ efektu zasad.

ParameterValuesValue

Wartość parametru.

Nazwa Typ Opis
value

object

Wartość parametru.

PolicyAssignment

Przypisanie zasad.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator przypisania zasad.
identity

Identity

Tożsamość zarządzana skojarzona z przypisaniem zasad.
location

string

Lokalizacja przypisania zasad. Wymagane tylko w przypadku korzystania z tożsamości zarządzanej.
name

string

Nazwa przypisania zasad.
properties.definitionVersion

string

Wersja definicji zasad do użycia.
properties.description

string

Ten komunikat będzie częścią odpowiedzi w przypadku naruszenia zasad.
properties.displayName

string

Nazwa wyświetlana przypisania zasad.
properties.effectiveDefinitionVersion

string

Obowiązująca wersja definicji zasad w użyciu. Jest to obecne tylko w przypadku żądania za pośrednictwem parametru zapytania $expand.
properties.enforcementMode

enforcementMode

Default

Tryb wymuszania przypisania zasad. Możliwe wartości to Default i DoNotEnforce.
properties.latestDefinitionVersion

string

Dostępna jest najnowsza wersja definicji zasad. Jest to obecne tylko w przypadku żądania za pośrednictwem parametru zapytania $expand.
properties.metadata

object

Metadane przypisania zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość.
properties.nonComplianceMessages

NonComplianceMessage[]

Komunikaty opisujące, dlaczego zasób jest niezgodny z zasadami.
properties.notScopes

string[]

Wykluczone zakresy zasad.
properties.overrides

Override[]

Wartość właściwości zasad zastępuje.
properties.parameters

<string,  ParameterValuesValue>

Wartości parametrów dla przypisanej reguły zasad. Klucze są nazwami parametrów.
properties.policyDefinitionId

string

Identyfikator przypisanej definicji zasad lub definicji zestawu zasad.
properties.resourceSelectors

ResourceSelector[]

Lista selektorów zasobów do filtrowania zasad według właściwości zasobów.
properties.scope

string

Zakres przypisania zasad.
systemData

systemData

Metadane systemowe odnoszące się do tego zasobu.
type

string

Typ przypisania zasad.

ResourceIdentityType

Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu.

Nazwa Typ Opis
None

string

Wskazuje, że żadna tożsamość nie jest skojarzona z zasobem lub że istniejąca tożsamość powinna zostać usunięta.
SystemAssigned

string

Wskazuje, że tożsamość przypisana przez system jest skojarzona z zasobem.
UserAssigned

string

Wskazuje, że tożsamość przypisana przez system jest skojarzona z zasobem.

ResourceSelector

Selektor zasobów do filtrowania zasad według właściwości zasobów.

Nazwa Typ Opis
name

string

Nazwa selektora zasobów.
selectors

Selector[]

Lista wyrażeń selektora.

Selector

Wyrażenie selektora.

Nazwa Typ Opis
in

string[]

Lista wartości do filtrowania.
kind

SelectorKind

Rodzaj selektora.
notIn

string[]

Lista wartości do odfiltrowania.

SelectorKind

Rodzaj selektora.

Nazwa Typ Opis
policyDefinitionReferenceId

string

Rodzaj selektora do filtrowania zasad według identyfikatora odwołania definicji zasad.
resourceLocation

string

Rodzaj selektora do filtrowania zasad według lokalizacji zasobu.
resourceType

string

Typ selektora do filtrowania zasad według typu zasobu.
resourceWithoutLocation

string

Rodzaj selektora do filtrowania zasad według zasobu bez lokalizacji.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).
createdBy

string

Tożsamość, która utworzyła zasób.
createdByType

createdByType

Typ tożsamości, która utworzyła zasób.
lastModifiedAt

string

Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentities

Tożsamość użytkownika skojarzona z zasadami. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Nazwa Typ Opis