Audit - Query

Riferimento

Servizio:: Purview

Versione API:: 2023-10-01-preview

Eseguire query sui log di controllo per un asset, glossarioTerm, classificazioneDef e così via.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint della mappa dati dell'account Purview. Esempio: https://{accountName}.purview.azure.com
api-version	query	True	string	Versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
category	AuditCategory	AuditCategory Categoria di controllo nella richiesta di query del log di controllo.
continuationToken	string	Token di continuazione per recuperare la pagina successiva.
endTime	string	Ora di fine del log di controllo; Rappresentazione ISO-8601. Il valore predefinito è ora UTC.
guid	string	GUID dell'asset di targe, termine glossario o definizione di classificazione.
keywords	string	Qualsiasi parola chiave contenuta nel log di controllo valore precedente o nuova parte valore.
operationType	AuditOperationType	AuditOperationType Tipo di operazione di controllo.
pageSize	integer	Numero di elementi che si spera di restituire in una pagina. Il valore massimo è 1000.
qualifiedName	string	Applicato solo all'asset; specifica il nome qualificato dell'asset.
sortBy	string	Proprietà da ordinare. Il valore deve essere uno dei campi dello schema del log di controllo. Deve essere usato con "SortOrder". CreationTime è consigliato.
sortOrder	AuditSortOrder	AuditSortOrder Ordinamento dei risultati della query di controllo.
startTime	string	Ora di inizio del log di controllo; Rappresentazione ISO-8601. Il valore predefinito è 1970-01-01T00:00:00Z.
typeName	string	Applicato solo all'asset; specifica il nome del tipo di asset.
userId	string	NOME dell'entità utente o ID oggetto del principio di servizio.

Risposte

Nome	Tipo	Descrizione
200 OK	AuditLogQueryResponse	OK. In caso di esito positivo della ricerca dei log di controllo all'interno dei criteri di ricerca.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Audit_Query

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:: 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\"]}}"
    }
  ]
}

Definizioni

Nome	Descrizione
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	Risposta di errore dal servizio

AuditCategory

Nome	Tipo	Descrizione
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

Nome	Tipo	Descrizione
accountId	string	ID account Purview.
catalogId	string	ID catalogo Purview.
changeRequestId	string	ID correlazione.
clientIP	string	Indirizzo IP client.
cloudType	string	Tipo di cloud a cui appartiene l'oggetto
creationTime	string	Timestamp quando è stato creato il log di controllo.
id	string	ID log.
newValue	string	Nuovo valore di dati.
objectCollectionId	string	ID raccolta oggetti.
objectFullyQualifiedName	string	Nome completo dell'oggetto.
objectId	string	GUID dell'asset di targe, termine glossario o definizione di classificazione.
objectName	string	Nome dell'oggetto.
objectType	string	Nome del tipo di oggetto.
oldValue	string	Valore dati precedente.
operation	AuditOperationType	AuditOperationType Tipo di operazione di controllo.
organizationId	string	ID tenant del cliente.
recordType	integer	Metadati di log. Indica il tipo di record del log di controllo.
serviceType	string	Tipo di servizio a cui appartiene l'oggetto
userId	string	Nome dell'entità utente.
userKey	string	Identità utente.
userType	integer	Tipo di utente che ha eseguito l'operazione.
workload	string	Metadati di log. Indica il tipo di carico di lavoro del log di controllo.

AuditLogQueryRequest

Nome	Tipo	Descrizione
category	AuditCategory	AuditCategory Categoria di controllo nella richiesta di query del log di controllo.
continuationToken	string	Token di continuazione per recuperare la pagina successiva.
endTime	string	Ora di fine del log di controllo; Rappresentazione ISO-8601. Il valore predefinito è ora UTC.
guid	string	GUID dell'asset di targe, termine glossario o definizione di classificazione.
keywords	string	Qualsiasi parola chiave contenuta nel log di controllo valore precedente o nuova parte valore.
operationType	AuditOperationType	AuditOperationType Tipo di operazione di controllo.
pageSize	integer	Numero di elementi che si spera di restituire in una pagina. Il valore massimo è 1000.
qualifiedName	string	Applicato solo all'asset; specifica il nome qualificato dell'asset.
sortBy	string	Proprietà da ordinare. Il valore deve essere uno dei campi dello schema del log di controllo. Deve essere usato con "SortOrder". CreationTime è consigliato.
sortOrder	AuditSortOrder	AuditSortOrder Ordinamento dei risultati della query di controllo.
startTime	string	Ora di inizio del log di controllo; Rappresentazione ISO-8601. Il valore predefinito è 1970-01-01T00:00:00Z.
typeName	string	Applicato solo all'asset; specifica il nome del tipo di asset.
userId	string	NOME dell'entità utente o ID oggetto del principio di servizio.

AuditLogQueryResponse

Nome	Tipo	Descrizione
continuationToken	string	Token di continuazione per recuperare la pagina successiva. Quando "lastPage" è false. Il client usa questo token nel payload della query per recuperare la pagina successiva.
lastPage	boolean	Indica se è l'ultima pagina.
recordCount	integer	Numero di elementi nella pagina corrente.
resultData	AuditLog[]	Matrice di log di controllo.
totalResultCount	integer	Numero di elementi totali qualificati per i criteri di ricerca.

AuditOperationType

Nome	Tipo	Descrizione
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	Descrizione
Ascending	string
Descending	string

ErrorResponse

Risposta di errore dal servizio

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
errorMessage	string	Messaggio di errore.
requestId	string	ID richiesta.

Condividi tramite