Compartir a través de

Policy Assignments - Get

  • Referencia
Servicio:
Policy
Versión de la API:
2023-04-01

Recupera una asignación de directiva.
Esta operación recupera una sola asignación de directiva, dada su nombre y el ámbito en el que se creó.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
policyAssignmentName
 path True

string

Nombre de la asignación de directiva que se va a obtener.

Patrón de Regex: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

Ámbito de la asignación de directiva. Los ámbitos válidos son: grupo de administración (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', o recurso (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version
 query True

string

Versión de la API que se va a usar para esta operación.
$expand
 query

string

Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores admitidos son "LatestDefinitionVersion, EffectiveDefinitionVersion".

Respuestas

Nombre Tipo Description
200 OK

PolicyAssignment

Aceptar: devuelve información sobre la asignación de directiva.
Other Status Codes

CloudError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}

Definiciones

Nombre Description
CloudError

Respuesta de error de una operación de directiva.
createdByType

Tipo de identidad que creó el recurso.
enforcementMode

Modo de cumplimiento de asignación de directivas. Los valores posibles son Default y DoNotEnforce.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorResponse

Respuesta de error
Identity

Identidad del recurso. Las asignaciones de directivas admiten un máximo de una identidad. Es una identidad asignada por el sistema o una única identidad asignada por el usuario.
NonComplianceMessage

Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.
Override

Invalidación del valor de la propiedad de directiva.
OverrideKind

Tipo de invalidación.
ParameterValuesValue

Valor de un parámetro.
PolicyAssignment

Asignación de directiva.
ResourceIdentityType

Tipo de identidad. Este es el único campo obligatorio al agregar una identidad asignada por el sistema o el usuario a un recurso.
ResourceSelector

Selector de recursos para filtrar las directivas por propiedades de recursos.
Selector

Expresión del selector.
SelectorKind

Tipo de selector.
systemData

Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentities

Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CloudError

Respuesta de error de una operación de directiva.

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

Modo de cumplimiento de asignación de directivas. Los valores posibles son Default y DoNotEnforce.

Nombre Tipo Description
Default

string

El efecto de la directiva se aplica durante la creación o actualización de recursos.
DoNotEnforce

string

El efecto de la directiva no se aplica durante la creación o actualización de recursos.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorResponse[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

Identity

Identidad del recurso. Las asignaciones de directivas admiten un máximo de una identidad. Es una identidad asignada por el sistema o una única identidad asignada por el usuario.

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad de la identidad del recurso. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId

string

Identificador de inquilino de la identidad del recurso. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type

ResourceIdentityType

Tipo de identidad. Este es el único campo obligatorio al agregar una identidad asignada por el sistema o el usuario a un recurso.
userAssignedIdentities

UserAssignedIdentities

Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NonComplianceMessage

Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.

Nombre Tipo Description
message

string

Mensaje que describe por qué un recurso no es compatible con la directiva. Esto se muestra en los mensajes de error "deny" y en los resultados de cumplimiento no compatibles del recurso.
policyDefinitionReferenceId

string

Identificador de referencia de definición de directiva dentro de una definición de conjunto de directivas para el que está destinado el mensaje. Esto solo es aplicable si la asignación de directiva asigna una definición de conjunto de directivas. Si no se proporciona, el mensaje se aplica a todas las directivas asignadas por esta asignación de directiva.

Override

Invalidación del valor de la propiedad de directiva.

Nombre Tipo Description
kind

OverrideKind

Tipo de invalidación.
selectors

Selector[]

Lista de las expresiones del selector.
value

string

Valor que se va a invalidar la propiedad de directiva.

OverrideKind

Tipo de invalidación.

Nombre Tipo Description
policyEffect

string

Invalidará el tipo de efecto de directiva.

ParameterValuesValue

Valor de un parámetro.

Nombre Tipo Description
value

object

Valor del parámetro .

PolicyAssignment

Asignación de directiva.

Nombre Tipo Valor predeterminado Description
id

string

Identificador de la asignación de directiva.
identity

Identity

Identidad administrada asociada a la asignación de directiva.
location

string

Ubicación de la asignación de directiva. Solo es necesario al usar la identidad administrada.
name

string

Nombre de la asignación de directiva.
properties.definitionVersion

string

Versión de la definición de directiva que se va a usar.
properties.description

string

Este mensaje formará parte de la respuesta en caso de infracción de directiva.
properties.displayName

string

Nombre para mostrar de la asignación de directiva.
properties.effectiveDefinitionVersion

string

Versión efectiva de la definición de directiva en uso. Esto solo está presente si se solicita a través del parámetro de consulta $expand.
properties.enforcementMode

enforcementMode

Default

Modo de cumplimiento de asignación de directivas. Los valores posibles son Default y DoNotEnforce.
properties.latestDefinitionVersion

string

La versión más reciente de la definición de directiva disponible. Esto solo está presente si se solicita a través del parámetro de consulta $expand.
properties.metadata

object

Metadatos de asignación de directiva. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor.
properties.nonComplianceMessages

NonComplianceMessage[]

Los mensajes que describen por qué un recurso no es compatible con la directiva.
properties.notScopes

string[]

Ámbitos excluidos de la directiva.
properties.overrides

Override[]

Invalidación del valor de la propiedad de directiva.
properties.parameters

<string,  ParameterValuesValue>

Valores de parámetro para la regla de directiva asignada. Las claves son los nombres de parámetro.
properties.policyDefinitionId

string

Identificador de la definición de directiva o definición del conjunto de directivas que se asigna.
properties.resourceSelectors

ResourceSelector[]

Lista del selector de recursos para filtrar las directivas por propiedades de recursos.
properties.scope

string

Ámbito de la asignación de directiva.
systemData

systemData

Metadatos del sistema relacionados con este recurso.
type

string

Tipo de la asignación de directiva.

ResourceIdentityType

Tipo de identidad. Este es el único campo obligatorio al agregar una identidad asignada por el sistema o el usuario a un recurso.

Nombre Tipo Description
None

string

Indica que no hay ninguna identidad asociada al recurso o que se debe quitar la identidad existente.
SystemAssigned

string

Indica que una identidad asignada por el sistema está asociada al recurso.
UserAssigned

string

Indica que una identidad asignada por el sistema está asociada al recurso.

ResourceSelector

Selector de recursos para filtrar las directivas por propiedades de recursos.

Nombre Tipo Description
name

string

Nombre del selector de recursos.
selectors

Selector[]

Lista de las expresiones del selector.

Selector

Expresión del selector.

Nombre Tipo Description
in

string[]

Lista de valores en los que se va a filtrar.
kind

SelectorKind

Tipo de selector.
notIn

string[]

Lista de valores que se van a filtrar.

SelectorKind

Tipo de selector.

Nombre Tipo Description
policyDefinitionReferenceId

string

Tipo de selector para filtrar las directivas por el identificador de referencia de definición de directiva.
resourceLocation

string

Tipo de selector para filtrar las directivas por la ubicación del recurso.
resourceType

string

Tipo de selector para filtrar las directivas por el tipo de recurso.
resourceWithoutLocation

string

Tipo de selector para filtrar las directivas por el recurso sin ubicación.

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentities

Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nombre Tipo Description