Audit - Query

Referência

Serviço:: Purview

Versão da API:: 2023-10-01-preview

Consultar logs de auditoria para um ativo, glossaryTerm, classificationDef etc.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	O ponto de extremidade do mapa de dados da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com
api-version	query	True	string	A versão da API.

Corpo da solicitação

Nome	Tipo	Description
category	AuditCategory	AuditCategory Categoria de auditoria na solicitação de consulta do log de auditoria.
continuationToken	string	O token de continuação para recuperar a próxima página.
endTime	string	Hora de término do log de auditoria; Representação ISO-8601. O valor padrão agora é UTC.
guid	string	GUID do ativo targe, termo do glossário ou definição de classificação.
keywords	string	Todas as palavras-chave contidas no valor antigo do log de auditoria ou na nova parte de valor.
operationType	AuditOperationType	AuditOperationType Tipo de operação de auditoria.
pageSize	integer	O número de itens que esperamos retornar em uma página. O valor máximo é 1000.
qualifiedName	string	Aplicado somente ao ativo; especifica o nome qualificado do ativo.
sortBy	string	Propriedade pela qual classificar. O valor deve ser um dos campos de esquema de log de auditoria. Deve ser usado com "SortOrder". CreationTime é sugerido.
sortOrder	AuditSortOrder	AuditSortOrder Ordem de classificação do resultado da consulta de auditoria.
startTime	string	Hora de início do log de auditoria; Representação ISO-8601. O valor padrão é 1970-01-01T00:00:00Z.
typeName	string	Aplicado somente ao ativo; especifica o nome do tipo de ativo.
userId	string	ID do objeto de entidade de serviço ou nome principal do usuário.

Respostas

Nome	Tipo	Description
200 OK	AuditLogQueryResponse	OK. Na pesquisa bem-sucedida de logs de auditoria dentro dos critérios de pesquisa.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Audit_Query

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:: 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\"]}}"
    }
  ]
}

Definições

Nome	Description
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	Uma resposta de erro do serviço

AuditCategory

Nome	Tipo	Description
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

Nome	Tipo	Description
accountId	string	ID da conta do Purview.
catalogId	string	ID do catálogo do Purview.
changeRequestId	string	ID de correlação.
clientIP	string	Endereço IP do cliente.
cloudType	string	Tipo de nuvem ao qual o objeto pertence
creationTime	string	Carimbo de data/hora quando o log de auditoria foi criado.
id	string	ID do log.
newValue	string	Novo valor de dados.
objectCollectionId	string	ID da coleção de objetos.
objectFullyQualifiedName	string	Nome totalmente qualificado do objeto.
objectId	string	GUID do ativo targe, termo do glossário ou definição de classificação.
objectName	string	Nome do objeto.
objectType	string	Nome do tipo de objeto.
oldValue	string	Valor de dados antigo.
operation	AuditOperationType	AuditOperationType Tipo de operação de auditoria.
organizationId	string	ID do locatário do cliente.
recordType	integer	Metadados de log. Indica o tipo de registro do log de auditoria.
serviceType	string	Tipo de serviço ao qual o objeto pertence
userId	string	Nome do usuário principal.
userKey	string	Identidade do usuário.
userType	integer	Tipo de usuário que executou a operação.
workload	string	Metadados de log. Indica o tipo de carga de trabalho do log de auditoria.

AuditLogQueryRequest

Nome	Tipo	Description
category	AuditCategory	AuditCategory Categoria de auditoria na solicitação de consulta do log de auditoria.
continuationToken	string	O token de continuação para recuperar a próxima página.
endTime	string	Hora de término do log de auditoria; Representação ISO-8601. O valor padrão agora é UTC.
guid	string	GUID do ativo targe, termo do glossário ou definição de classificação.
keywords	string	Todas as palavras-chave contidas no valor antigo do log de auditoria ou na nova parte de valor.
operationType	AuditOperationType	AuditOperationType Tipo de operação de auditoria.
pageSize	integer	O número de itens que esperamos retornar em uma página. O valor máximo é 1000.
qualifiedName	string	Aplicado somente ao ativo; especifica o nome qualificado do ativo.
sortBy	string	Propriedade pela qual classificar. O valor deve ser um dos campos de esquema de log de auditoria. Deve ser usado com "SortOrder". CreationTime é sugerido.
sortOrder	AuditSortOrder	AuditSortOrder Ordem de classificação do resultado da consulta de auditoria.
startTime	string	Hora de início do log de auditoria; Representação ISO-8601. O valor padrão é 1970-01-01T00:00:00Z.
typeName	string	Aplicado somente ao ativo; especifica o nome do tipo de ativo.
userId	string	ID do objeto de entidade de serviço ou nome principal do usuário.

AuditLogQueryResponse

Nome	Tipo	Description
continuationToken	string	O token de continuação para recuperar a próxima página. Quando "lastPage" é false. O cliente usa esse token no conteúdo da consulta para recuperar a próxima página.
lastPage	boolean	Indica se é a última página.
recordCount	integer	O número de itens na página atual.
resultData	AuditLog[]	Uma matriz de logs de auditoria.
totalResultCount	integer	O número total de itens qualificados para os critérios de pesquisa.

AuditOperationType

Nome	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

Nome	Tipo	Description
Ascending	string
Descending	string

ErrorResponse

Uma resposta de erro do serviço

Nome	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string	A ID da solicitação.

Compartilhar via