Compartir a través de


Component Policy States - List Query Results For Policy Definition

Consulta los estados de la directiva de componentes para la definición de directiva de nivel de suscripción.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
authorizationNamespace
path True

AuthorizationNamespaceType

Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization".

componentPolicyStatesResource
path True

ComponentPolicyStatesResource

Recurso virtual en el tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.

policyDefinitionName
path True

string

Nombre de definición de directiva.

Regex pattern: ^[^<>%&:\\?/#]*$

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 a solo las solicitadas, por ejemplo, "$select=PolicyAssignmentId, ResourceId".

$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

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

Respuestas

Nombre Tipo Description
200 OK

ComponentPolicyStatesQueryResults

Resultados de la consulta.

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo 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

Query latest component policy states at subscription level policy definition scope

Sample Request

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01

Sample Response

{
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "d9da7e80af6344ab9d342aa7",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "d9da7e80af6344ab9d342aa7",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Definiciones

Nombre Description
AuthorizationNamespaceType

Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization".

ComponentExpressionEvaluationDetails

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

ComponentPolicyEvaluationDetails

Detalles de evaluación de directivas.

ComponentPolicyState

Registro de estado de la directiva de componentes.

ComponentPolicyStatesQueryResults

Resultados de la consulta.

ComponentPolicyStatesResource

Recurso virtual en el tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.

ErrorDefinition

Definición de error.

ErrorResponse

Respuesta de error.

TypedErrorInfo

Detalles de error específicos del escenario.

AuthorizationNamespaceType

Espacio de nombres para el proveedor de recursos de autorización de Microsoft; solo se permite "Microsoft.Authorization".

Nombre Tipo Description
Microsoft.Authorization

string

ComponentExpressionEvaluationDetails

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.

ComponentPolicyEvaluationDetails

Detalles de evaluación de directivas.

Nombre Tipo Description
evaluatedExpressions

ComponentExpressionEvaluationDetails[]

Detalles de las expresiones evaluadas.

reason

string

Motivo textual adicional del resultado de la evaluación.

ComponentPolicyState

Registro de estado de la directiva de componentes.

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 de componentes no tienen un identificador de entidad.

complianceState

string

Estado de cumplimiento del recurso.

componentId

string

Id. de componente.

componentName

string

component_name

componentType

string

Tipo de componente.

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 definición 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

ComponentPolicyEvaluationDetails

Detalles de evaluación de directivas. Esto solo se incluye en la respuesta si la solicitud contiene $expand=PolicyEvaluationDetails.

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 del recurso.

resourceLocation

string

Ubicación del recurso

resourceType

string

Tipo de recurso.

subscriptionId

string

Id. de suscripción.

timestamp

string

Marca de tiempo para el registro de estado de la directiva de componentes.

ComponentPolicyStatesQueryResults

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

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

value

ComponentPolicyState[]

Resultados de la consulta.

ComponentPolicyStatesResource

Recurso virtual en el tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.

Nombre Tipo Description
latest

string

ErrorDefinition

Definición de error.

Nombre Tipo Description
additionalInfo

TypedErrorInfo[]

Detalles adicionales del error específico del escenario.

code

string

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

details

ErrorDefinition[]

Detalles internos del error.

message

string

Descripción del error.

target

string

Destino del error.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error

ErrorDefinition

Los detalles del error.

TypedErrorInfo

Detalles de error específicos del escenario.

Nombre Tipo Description
info

Detalles de error específicos del escenario.

type

string

Tipo de detalles de error incluidos.