Compartir a través de

Policy States - List Query Results For Resource Group

  • Referencia
Servicio:
Policy
Versión de la API:
2019-10-01

Consulta los estados de directiva de los recursos del grupo de recursos.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
Con parámetros opcionales: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
policyStatesResource
 path True

PolicyStatesResource

Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva.
resourceGroupName
 path True

string

Nombre del grupo de recursos.
subscriptionId
 path True

string

Identificador de suscripción de Microsoft Azure.
api-version
 query True

string

Versión de api de cliente.
$apply
 query

string

OData aplica expresión para agregaciones.
$filter
 query

string

Expresión de filtro de OData.
$from
 query

string (date-time)

Marca de tiempo con formato ISO 8601 que especifica la hora de inicio del intervalo que se va a consultar. Cuando no se especifica, el servicio usa ($to - 1 día).
$orderby
 query

string

Expresión de ordenación mediante notación OData. Uno o varios nombres de columna separados por comas con un "desc" opcional (el valor predeterminado) o "asc", por ejemplo"$orderby=PolicyAssignmentId, ResourceId asc".
$select
 query

string

Seleccione expresión mediante notación OData. Limita las columnas de cada registro solo a las solicitadas, por ejemplo, "$select=PolicyAssignmentId, ResourceId".
$skiptoken
 query

string

Skiptoken solo se proporciona si una respuesta anterior devolvió un resultado parcial como parte del elemento nextLink.
$to
 query

string (date-time)

Marca de tiempo con formato ISO 8601 que especifica la hora de finalización del intervalo que se va a consultar. Cuando no se especifica, el servicio usa el tiempo de solicitud.
$top
 query

integer (int32)

minimum: 0

Número máximo de registros que se van a devolver.

Respuestas

Nombre Tipo Description
200 OK

PolicyStatesQueryResults

Resultados de la consulta.
Other Status Codes

QueryFailure

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

Query latest at resource group scope
Query latest at resource group scope with next link

Query latest at resource group scope

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01

Respuesta de muestra

status code:
200 
{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD

Respuesta de muestra

status code:
200 
{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    }
  ]
}

Definiciones

Nombre Description
ComponentStateDetails

Detalles del estado del componente.
Error

Definición de error.
ExpressionEvaluationDetails

Detalles de evaluación de expresiones de lenguaje de directiva.
IfNotExistsEvaluationDetails

Detalles de evaluación del efecto IfNotExists.
PolicyEvaluationDetails

Detalles de evaluación de directivas.
PolicyState

Registro de estado de la directiva.
PolicyStatesQueryResults

Resultados de la consulta.
PolicyStatesResource

Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva.
QueryFailure

Respuesta de error.

ComponentStateDetails

Object

Detalles del estado del componente.

Nombre Tipo Description
complianceState

string

Estado de cumplimiento de componentes.
id

string

Id. de componente.
name

string

Nombre del componente.
timestamp

string (date-time)

Marca de tiempo de evaluación de cumplimiento de componentes.
type

string

Tipo de componente.

Error

Object

Definición de error.

Nombre Tipo Description
code

string

Código de error específico del servicio que actúa como subestado para el código de error HTTP.
message

string

Descripción del error.

ExpressionEvaluationDetails

Object

Detalles de evaluación de expresiones de lenguaje de directiva.

Nombre Tipo Description
expression

string

Expresión evaluada.
expressionKind

string

El tipo de expresión que se evaluó.
expressionValue

object

Valor de la expresión.
operator

string

Operador para comparar el valor de expresión y el valor de destino.
path

string

Ruta de acceso de propiedad si la expresión es un campo o un alias.
result

string

Resultado de la evaluación.
targetValue

object

Valor de destino que se va a comparar con el valor de expresión.

IfNotExistsEvaluationDetails

Object

Detalles de evaluación del efecto IfNotExists.

Nombre Tipo Description
resourceId

string

Identificador del último recurso evaluado para el efecto IfNotExists.
totalResources

integer

Número total de recursos a los que se aplica la condición de existencia.

PolicyEvaluationDetails

Object

Detalles de evaluación de directivas.

Nombre Tipo Description
evaluatedExpressions

ExpressionEvaluationDetails[]

Detalles de las expresiones evaluadas.
ifNotExistsDetails

IfNotExistsEvaluationDetails

Detalles de evaluación del efecto IfNotExists.

PolicyState

Object

Registro de estado de la directiva.

Nombre Tipo Description
@odata.context

string

Cadena de contexto de OData; que usan los clientes de OData para resolver la información de tipos en función de los metadatos.
@odata.id

string

Id. de entidad de OData; siempre se establece en NULL, ya que los registros de estado de la directiva no tienen un identificador de entidad.
complianceState

string

Estado de cumplimiento del recurso.
components

ComponentStateDetails[]

Los registros de cumplimiento de estado de los componentes se rellenan solo cuando la dirección URL contiene $expand=cláusula components.
effectiveParameters

string

Parámetros efectivos para la asignación de directivas.
isCompliant

boolean

Marca que indica si el recurso es compatible con la asignación de directiva con la que se evaluó. Esta propiedad está en desuso; Use ComplianceState en su lugar.
managementGroupIds

string

Lista separada por comas de identificadores de grupo de administración, que representan la jerarquía de los grupos de administración en los que se encuentra el recurso.
policyAssignmentId

string

Identificador de asignación de directiva.
policyAssignmentName

string

Nombre de asignación de directiva.
policyAssignmentOwner

string

Propietario de la asignación de directiva.
policyAssignmentParameters

string

Parámetros de asignación de directivas.
policyAssignmentScope

string

Ámbito de asignación de directiva.
policyAssignmentVersion

string

Versión de asignación de directiva evaluada.
policyDefinitionAction

string

Acción de definición de directiva, es decir, efecto.
policyDefinitionCategory

string

Categoría de definición de directiva.
policyDefinitionGroupNames

string[]

Nombres de grupo de definiciones de directiva.
policyDefinitionId

string

Identificador de definición de directiva.
policyDefinitionName

string

Nombre de definición de directiva.
policyDefinitionReferenceId

string

Identificador de referencia de la definición de directiva dentro del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policyDefinitionVersion

string

Versión de definición de directiva evaluada.
policyEvaluationDetails

PolicyEvaluationDetails

Detalles de evaluación de directivas.
policySetDefinitionCategory

string

Categoría de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionId

string

Identificador de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionName

string

Nombre de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionOwner

string

Propietario de la definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionParameters

string

Parámetros de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionVersion

string

Versión de definición del conjunto de directivas evaluada.
resourceGroup

string

Nombre del grupo de recursos.
resourceId

string

Identificador de recurso.
resourceLocation

string

Ubicación del recurso.
resourceTags

string

Lista de etiquetas de recursos.
resourceType

string

Tipo de recurso.
subscriptionId

string

Id. de suscripción.
timestamp

string (date-time)

Marca de tiempo del registro de estado de la directiva.

PolicyStatesQueryResults

Object

Resultados de la consulta.

Nombre Tipo Description
@odata.context

string

Cadena de contexto de OData; que usan los clientes de OData para resolver la información de tipos en función de los metadatos.
@odata.count

integer (int32)

minimum: 0

Recuento de entidades de OData; representa el número de registros de estado de directiva devueltos.
@odata.nextLink

string

Vínculo siguiente de Odata; Dirección URL para obtener el siguiente conjunto de resultados.
value

PolicyState[]

Resultados de la consulta.

PolicyStatesResource

Enumeración

Recurso virtual en El tipo de recurso PolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva más recientes, mientras que "default" representa todos los estados de directiva.

Valor Description
default
latest

QueryFailure

Object

Respuesta de error.

Nombre Tipo Description
error

Error

Definición de error.