Policy Assignments - List For Resource
Recupera todas las asignaciones de directiva que se aplican a un recurso.
Esta operación recupera la lista de todas las asignaciones de directiva asociadas al recurso especificado en el grupo de recursos y la suscripción especificados que coinciden con el $filter opcional especificado. Los valores válidos para $filter son: 'atScope()', 'atExactScope()' o 'policyDefinitionId eq '{value}'. Si no se proporciona $filter, la lista sin filtrar incluye todas las asignaciones de directiva asociadas al recurso, incluidas las que se aplican directamente o desde todos los ámbitos que contienen, así como cualquier aplicación a los recursos incluidos en el recurso. Si se proporciona $filter=atScope(), la lista devuelta incluye todas las asignaciones de directiva que se aplican al recurso, que es todo lo que hay en la lista sin filtrar, excepto las que se aplican a los recursos contenidos en el recurso. Si se proporciona $filter=atExactScope(), la lista devuelta solo incluye todas las asignaciones de directiva que están en el nivel de recurso. Si se proporciona $filter=policyDefinitionId eq '{value}', la lista devuelta incluye todas las asignaciones de directiva de la definición de directiva cuyo identificador es {value} que se aplica al recurso. Se usan tres parámetros más el nombre del recurso para identificar un recurso específico. Si el recurso no forma parte de un recurso primario (el caso más común), no se debe proporcionar la ruta de acceso del recurso primario (o proporcionarse como ""). Por ejemplo, una aplicación web podría especificarse como ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Si el recurso forma parte de un recurso primario, se deben proporcionar todos los parámetros. Por ejemplo, un nombre DNS de máquina virtual podría especificarse como ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Una alternativa conveniente para proporcionar el espacio de nombres y el nombre de tipo por separado es proporcionar ambos en el parámetro {resourceType}, formato: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$top={$top}&api-version=2023-04-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
parent
|
path | True |
string |
Ruta de acceso del recurso primario. Use una cadena vacía si no hay ninguna. |
resource
|
path | True |
string |
Nombre del grupo de recursos que contiene el recurso. Regex pattern: |
resource
|
path | True |
string |
Nombre del recurso. Regex pattern: |
resource
|
path | True |
string |
Espacio de nombres del proveedor de recursos. Por ejemplo, el espacio de nombres de una máquina virtual es Microsoft.Compute (de Microsoft.Compute/virtualMachines) |
resource
|
path | True |
string |
Nombre del tipo de recurso. Por ejemplo, el nombre de tipo de una aplicación web es "sites" (de Microsoft.Web/sites). |
subscription
|
path | True |
string uuid |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
$filter
|
query |
string |
Filtro que se va a aplicar en la operación. Los valores válidos para $filter son: 'atScope()', 'atExactScope()' o 'policyDefinitionId eq '{value}'. Si no se proporciona $filter, no se realiza ningún filtrado. Si se proporciona $filter=atScope(), la lista devuelta solo incluye todas las asignaciones de directiva que se aplican al ámbito, que es todo lo que hay en la lista sin filtrar, excepto las que se aplican a los sub ámbitos contenidos en el ámbito especificado. Si se proporciona $filter=atExactScope(), la lista devuelta solo incluye todas las asignaciones de directiva que están en el ámbito especificado. Si se proporciona $filter=policyDefinitionId eq '{value}', la lista devuelta incluye todas las asignaciones de directiva de la definición de directiva cuyo identificador es {value}. |
|
$top
|
query |
integer int32 |
Número máximo de registros que se van a devolver. Cuando no se proporcione el filtro $top, devolverá 500 registros. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar: devuelve una matriz de asignaciones de directivas. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
List all policy assignments that apply to a resource
Sample Request
GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/domainNames/MyTestComputer.cloudapp.net/providers/Microsoft.Authorization/policyAssignments?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": "VM 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/vmSkus",
"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": []
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Cloud |
Respuesta de error de una operación de directiva. |
created |
Tipo de identidad que creó el recurso. |
enforcement |
Modo de aplicación de asignación de directivas. Los valores posibles son Default y DoNotEnforce. |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
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. |
Non |
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. |
Override |
Tipo de invalidación. |
Parameter |
Valor de un parámetro. |
Policy |
Asignación de directiva. |
Policy |
Lista de asignaciones de directivas. |
Resource |
Tipo de identidad. Este es el único campo necesario al agregar una identidad asignada por el sistema o el usuario a un recurso. |
Resource |
Selector de recursos para filtrar las directivas por propiedades de recursos. |
Selector |
Expresión del selector. |
Selector |
Tipo de selector. |
system |
Metadatos relacionados con la creación y la última modificación del recurso. |
User |
Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso 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 |
Respuesta de error |
createdByType
Tipo de identidad que creó el recurso.
Nombre | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
enforcementMode
Modo de aplicación 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 |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El 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 |
Tipo de identidad. Este es el único campo necesario al agregar una identidad asignada por el sistema o el usuario a un recurso. |
|
userAssignedIdentities |
Identidad de usuario asociada a la directiva. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso 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á pensado 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 |
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 |
Identidad administrada asociada a la asignación de directiva. |
||
location |
string |
Ubicación de la asignación de directiva. Solo es necesario cuando se usa la identidad administrada. |
|
name |
string |
Nombre de la asignación de directiva. |
|
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.enforcementMode | Default |
Modo de aplicación de asignación de directivas. Los valores posibles son Default y DoNotEnforce. |
|
properties.metadata |
object |
Metadatos de asignación de directiva. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor. |
|
properties.nonComplianceMessages |
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,
Parameter |
Los valores de parámetro de 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 |
Lista del selector de recursos para filtrar las directivas por propiedades de recursos. |
||
properties.scope |
string |
Ámbito de la asignación de directiva. |
|
systemData |
Metadatos del sistema relacionados con este recurso. |
||
type |
string |
Tipo de asignación de directiva. |
PolicyAssignmentListResult
Lista de asignaciones de directivas.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Dirección URL que se va a usar para obtener el siguiente conjunto de resultados. |
value |
Matriz de asignaciones de directivas. |
ResourceIdentityType
Tipo de identidad. Este es el único campo necesario 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 |
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 tipo de recurso. |
resourceWithoutLocation |
string |
Tipo de selector para filtrar las directivas por el recurso sin ubicación. |
systemData
Metadatos relacionados con la creación y la ú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 |
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 |
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 identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Nombre | Tipo | Description |
---|---|---|
|