Policy Events - List

Servicio:

Purview

Versión de la API:

2023-01-01

Obtiene eventos de directiva para un ámbito determinado.

GET {endpoint}/pds/policy-events?scope={scope}&syncToken={syncToken}&api-version=2023-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com.
api-version	query	True	string	Versión de API del servicio.
scope	query	True	string	Identificador de cualquier recurso administrado por Purview.
syncToken	query	True	string	Este token de sincronización representa el punto de control más reciente de las directivas. El cliente debe pasar este valor al capturar los cambios diferenciales posteriores.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyEventsResponseUpdated	Éxito
Other Status Codes		No modificado
Other Status Codes	ErrorResponseModel	Error

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

PolicyEvents_List

Solicitud de ejemplo

HTTP

GET {endpoint}/pds/policy-events?scope=/subscriptions/30d9d527-c409-4507-b861-d60e7fe9e292/resourcegroups/pansharm-rg/providers/microsoft.sql/servers/pansharm-sql&syncToken=25251:0&api-version=2023-01-01

Respuesta de muestra

status code:

200

x-ms-correlation-request-id: f35b289b-7deb-467b-9976-a163926f981f

{
  "syncToken": "25258:0",
  "value": [
    {
      "eventType": "Microsoft.Purview/PolicyElements/Write",
      "id": "e870dcfa-d89d-4fc1-90a9-ef758d299e15",
      "scopes": [
        "/subscriptions/30d9d527-c409-4507-b861-d60e7fe9e292/resourcegroups/pansharm-rg"
      ],
      "kind": "PolicySet",
      "updatedAt": "2022-03-07T05:21:52.2823168Z",
      "version": 1,
      "elementJson": "{\"id\":\"e870dcfa-d89d-4fc1-90a9-ef758d299e15\",\"name\":\"e870dcfa-d89d-4fc1-90a9-ef758d299e15\",\"kind\":\"policyset\",\"version\":1,\"updatedAt\":\"2022-03-07T05:21:52.2823168Z\",\"preconditionRules\":[{\"dnfCondition\":[[{\"attributeName\":\"resource.azure.path\",\"attributeValueIncludedIn\":[\"/subscriptions/30d9d527-c409-4507-b861-d60e7fe9e292/resourcegroups/pansharm-rg/**\"]}]]}],\"policyRefs\":[\"5f448cc9-33cc-47de-910c-c2de1212cb2f\"]}"
    },
    {
      "eventType": "Microsoft.Purview/PolicyElements/Write",
      "id": "5f448cc9-33cc-47de-910c-c2de1212cb2f",
      "scopes": [
        "/subscriptions/30d9d527-c409-4507-b861-d60e7fe9e292/resourcegroups/pansharm-rg"
      ],
      "kind": "Policy",
      "updatedAt": "2022-06-02T17:05:43.0981228Z",
      "version": 9,
      "elementJson": "{\"id\":\"5f448cc9-33cc-47de-910c-c2de1212cb2f\",\"name\":\"test004\",\"kind\":\"policy\",\"version\":9,\"updatedAt\":\"2022-06-02T17:05:43.0981228Z\",\"decisionRules\":[{\"kind\":\"decisionrule\",\"effect\":\"Permit\",\"id\":\"3ef47a19-55ab-4c3e-bfe4-b274489555da\",\"updatedAt\":\"06/02/2022 17:05:43\",\"cnfCondition\":[[{\"attributeName\":\"resource.azure.path\",\"attributeValueIncludedIn\":[\"/subscriptions/30d9d527-c409-4507-b861-d60e7fe9e292/resourcegroups/pansharm-rg/providers/Microsoft.AzureArcData/SqlServerInstances/pansharm-sql/**\"]}],[{\"attributeName\":\"principal.microsoft.id\",\"attributeValueIncludedIn\":[\"ca4709b3-1fdd-4032-9844-3039025e8ee0\"]}],[{\"fromRule\":\"purviewdatarole_builtin_sqlperfmonitor\",\"attributeName\":\"derived.purview.role\",\"attributeValueIncludes\":\"purviewdatarole_builtin_sqlperfmonitor\"}]]}]}"
    }
  ]
}

status code:

304

x-ms-correlation-request-id: f35b289b-7deb-467b-9976-a163926f981f

status code:

default

x-ms-correlation-request-id: f35b289b-7deb-467b-9976-a163926f981f

{
  "error": {
    "code": "1001",
    "message": "Simple error message.",
    "target": "Detailed message or error trace.",
    "details": []
  }
}

Definiciones

Nombre	Description
ErrorModel	Modelo de error predeterminado.
ErrorResponseModel	Modelo de respuesta de error predeterminado.
PolicyElementEventModelUpdated	Representa el modelo de eventos de elemento de directiva.
PolicyElementKind	Representa el tipo de elemento de directiva.
PolicyEventsResponseUpdated	Modelo de respuesta para la API de captura diferencial de directivas.

ErrorModel

Object

Modelo de error predeterminado.

Nombre	Tipo	Description
code	string minLength: 1	Código de error.
details	ErrorModel[]	Detalles del error.
message	string minLength: 1	Mensaje de error.
target	string	Descripción del error.

ErrorResponseModel

Object

Modelo de respuesta de error predeterminado.

Nombre	Tipo	Description
error	ErrorModel	Modelo de error predeterminado.

PolicyElementEventModelUpdated

Object

Representa el modelo de eventos de elemento de directiva.

Nombre	Tipo	Description
elementJson	string	Carga json serializada del elemento policy.
eventType	string minLength: 1	Tipo de evento. Formato://. Por ejemplo: Microsoft.Purview/PolicyElements/Delete.
id	string minLength: 1	Identificador del elemento de directiva.
kind	PolicyElementKind	Representa el tipo de elemento de directiva.
scopes	string[]	Lista de ámbitos incluidos en esta directiva.
updatedAt	string (date-time)	Hora en la que se actualizó por última vez este elemento de directiva.
version	integer (int64)	Versión actual del elemento de directiva. Esto se incrementa automáticamente con cada cambio. Comienza con 1.

PolicyElementKind

Enumeración

Representa el tipo de elemento de directiva.

Valor	Description
AttributeRule
Policy
PolicySet

PolicyEventsResponseUpdated

Object

Modelo de respuesta para la API de captura diferencial de directivas.

Nombre	Tipo	Description
syncToken	string minLength: 1	Este token de sincronización representa el punto de control más reciente de las directivas. El cliente debe pasar este valor al capturar los cambios diferenciales posteriores.
value	PolicyElementEventModelUpdated[]	Lista de elementos de directiva.