Audit - Query

Referencia

Servicio:: Purview

Versión de la API:: 2023-10-01-preview

Consulte los registros de auditoría de un recurso, glosarioTerm, classificationDef, etc.

POST {endpoint}/datamap/api/audit/query?api-version=2023-10-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Punto de conexión de mapa de datos de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com
api-version	query	True	string	La versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
category	AuditCategory	AuditCategory Categoría auditoría en la solicitud de consulta de registro de auditoría.
continuationToken	string	Token de continuación para recuperar la página siguiente.
endTime	string	Hora de finalización del registro de auditoría; Representación ISO-8601. El valor predeterminado es UTC ahora.
guid	string	GUID del recurso targe, el término del glosario o la definición de clasificación.
keywords	string	Cualquier palabra clave contenida en el valor antiguo del registro de auditoría o en la parte de nuevo valor.
operationType	AuditOperationType	AuditOperationType Tipo de operación de auditoría.
pageSize	integer	Número de elementos que esperamos devolver en una página. El valor máximo es 1000.
qualifiedName	string	Solo se aplica al recurso; especifica el nombre completo del recurso.
sortBy	string	Propiedad por la que se va a ordenar. El valor debe ser uno de los campos de esquema del registro de auditoría. Debe usarse con "SortOrder". Se sugiere CreationTime.
sortOrder	AuditSortOrder	AuditSortOrder Auditar el criterio de ordenación de los resultados de la consulta.
startTime	string	Hora de inicio del registro de auditoría; Representación ISO-8601. El valor predeterminado es 1970-01-01T00:00:00Z.
typeName	string	Solo se aplica al recurso; especifica el nombre del tipo de recurso.
userId	string	Nombre principal de usuario o identificador de objeto de entidad de servicio.

Respuestas

Nombre	Tipo	Description
200 OK	AuditLogQueryResponse	Aceptar. Si la búsqueda correcta de los registros de auditoría se realiza dentro de los criterios de búsqueda.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de 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	suplantación de su cuenta de usuario

Ejemplos

Audit_Query

Solicitud de ejemplo

HTTP

POST {endpoint}/datamap/api/audit/query?api-version=2023-10-01-preview

{
  "category": "Asset",
  "guid": "330bd2f1-cf28-4737-8d86-e6f6f6f60000",
  "userId": "contoso@microsoft.com",
  "operationType": "EntityUpdated",
  "keywords": "Tag1",
  "startTime": "2023-05-01T00:00:00.000Z",
  "endTime": "2023-05-30T00:00:00.000Z",
  "sortBy": "CreationTime",
  "sortOrder": "Descending",
  "pageSize": 10
}

Respuesta de muestra

status code:: 200

{
  "continuationToken": "<token>",
  "lastPage": true,
  "totalResultCount": 2,
  "recordCount": 2,
  "resultData": [
    {
      "workload": "PurviewDataMap",
      "recordType": 227,
      "id": "12ea3a18-3712-4417-a12d-7df936e327c9",
      "creationTime": "2023-05-06T08:27:05",
      "operation": "EntityUpdated",
      "organizationId": "4f1dc10a-df9b-4f93-be0c-504b04f6309d",
      "userType": 0,
      "userKey": "1715f5c5-c81d-489e-9ca1-8d40281ef0d8",
      "userId": "contoso@microsoft.com",
      "accountId": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0",
      "catalogId": "d8757510-c866-61ba-486f-1afca09f43b8",
      "changeRequestId": "34d2aa4a-d5bf-4bdf-a954-77df88d9c3df",
      "cloudType": "Azure",
      "serviceType": "[\"Azure Blob Storage\"]",
      "objectId": "330bd2f1-cf28-4737-8d86-e6f6f6f60000",
      "objectName": "Audit Log Test",
      "objectFullyQualifiedName": "https://contoso.blob.core.windows.net/testfolder1/auditlogtest.json",
      "objectType": "azure_blob_path",
      "oldValue": "{\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\":{\"attributes\":{\"name\":\"Audit Log Test\"},\"guid\":\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\",\"labels\":[\"Tag1\"]}}",
      "newValue": "{\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\":{\"attributes\":{\"name\":\"Audit Log Test\"},\"guid\":\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\",\"labels\":[]}}"
    },
    {
      "workload": "PurviewDataMap",
      "recordType": 227,
      "id": "6abb069e-aefc-4dff-97f4-f36b3d5ac2be",
      "creationTime": "2023-05-06T08:27:01",
      "operation": "EntityUpdated",
      "organizationId": "4f1dc10a-df9b-4f93-be0c-504b04f6309d",
      "userType": 0,
      "userKey": "1715f5c5-c81d-489e-9ca1-8d40281ef0d8",
      "userId": "contoso@microsoft.com",
      "accountId": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0",
      "catalogId": "d8757510-c866-61ba-486f-1afca09f43b8",
      "changeRequestId": "122a460f-9d87-47cd-9683-e27351a3dadd",
      "cloudType": "Azure",
      "serviceType": "[\"Azure Blob Storage\"]",
      "objectId": "330bd2f1-cf28-4737-8d86-e6f6f6f60000",
      "objectName": "Audit Log Test",
      "objectFullyQualifiedName": "https://contoso.blob.core.windows.net/testfolder1/auditlogtest.json",
      "objectType": "azure_blob_path",
      "oldValue": "{\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\":{\"attributes\":{\"name\":\"Audit Log Test\"},\"guid\":\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\",\"labels\":[\"Tag1\",\"Tag2\"]}}",
      "newValue": "{\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\":{\"attributes\":{\"name\":\"Audit Log Test\"},\"guid\":\"330bd2f1-cf28-4737-8d86-e6f6f6f60000\",\"labels\":[\"Tag1\"]}}"
    }
  ]
}

Definiciones

Nombre	Description
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	Respuesta de error del servicio

AuditCategory

Nombre	Tipo	Description
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

Nombre	Tipo	Description
accountId	string	Identificador de cuenta de Purview.
catalogId	string	Identificador del catálogo de Purview.
changeRequestId	string	Id. de correlación.
clientIP	string	Dirección IP del cliente.
cloudType	string	Tipo de nube al que pertenece el objeto
creationTime	string	Marca de tiempo cuando se creó el registro de auditoría.
id	string	Id. de registro.
newValue	string	Nuevo valor de datos.
objectCollectionId	string	Id. de colección de objetos.
objectFullyQualifiedName	string	Nombre completo del objeto.
objectId	string	GUID del recurso targe, el término del glosario o la definición de clasificación.
objectName	string	Nombre de objeto.
objectType	string	Nombre del tipo de objeto.
oldValue	string	Valor de datos antiguo.
operation	AuditOperationType	AuditOperationType Tipo de operación de auditoría.
organizationId	string	Id. de inquilino del cliente.
recordType	integer	Metadatos de registro. Indica el tipo de registro de auditoría.
serviceType	string	Tipo de servicio al que pertenece el objeto
userId	string	Nombre principal de usuario.
userKey	string	Identidad del usuario.
userType	integer	Tipo de usuario que realizó la operación.
workload	string	Metadatos de registro. Indica el tipo de carga de trabajo del registro de auditoría.

AuditLogQueryRequest

Nombre	Tipo	Description
category	AuditCategory	AuditCategory Categoría auditoría en la solicitud de consulta de registro de auditoría.
continuationToken	string	Token de continuación para recuperar la página siguiente.
endTime	string	Hora de finalización del registro de auditoría; Representación ISO-8601. El valor predeterminado es UTC ahora.
guid	string	GUID del recurso targe, el término del glosario o la definición de clasificación.
keywords	string	Cualquier palabra clave contenida en el valor antiguo del registro de auditoría o en la parte de nuevo valor.
operationType	AuditOperationType	AuditOperationType Tipo de operación de auditoría.
pageSize	integer	Número de elementos que esperamos devolver en una página. El valor máximo es 1000.
qualifiedName	string	Solo se aplica al recurso; especifica el nombre completo del recurso.
sortBy	string	Propiedad por la que se va a ordenar. El valor debe ser uno de los campos de esquema del registro de auditoría. Debe usarse con "SortOrder". Se sugiere CreationTime.
sortOrder	AuditSortOrder	AuditSortOrder Auditar el criterio de ordenación de los resultados de la consulta.
startTime	string	Hora de inicio del registro de auditoría; Representación ISO-8601. El valor predeterminado es 1970-01-01T00:00:00Z.
typeName	string	Solo se aplica al recurso; especifica el nombre del tipo de recurso.
userId	string	Nombre principal de usuario o identificador de objeto de entidad de servicio.

AuditLogQueryResponse

Nombre	Tipo	Description
continuationToken	string	Token de continuación para recuperar la página siguiente. Cuando "lastPage" es false. El cliente usa este token en la carga de consulta para recuperar la página siguiente.
lastPage	boolean	Indica si es la última página.
recordCount	integer	Número de elementos de la página actual.
resultData	AuditLog[]	Matriz de registros de auditoría.
totalResultCount	integer	Número de elementos totales que se calificaron para los criterios de búsqueda.

AuditOperationType

Nombre	Tipo	Description
ClassificationAdded	string
ClassificationDefinitionCreated	string
ClassificationDefinitionDeleted	string
ClassificationDefinitionUpdated	string
ClassificationDeleted	string
ClassificationUpdated	string
EntityCreated	string
EntityDeleted	string
EntityUpdated	string
GlossaryTermAssigned	string
GlossaryTermCreated	string
GlossaryTermDeleted	string
GlossaryTermDisassociated	string
GlossaryTermUpdated	string
SensitivityLabelChanged	string

AuditSortOrder

Nombre	Tipo	Description
Ascending	string
Descending	string

ErrorResponse

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	El mensaje de error.
requestId	string	El identificador de solicitud.

Compartir a través de