Audit - Query

Service:: Purview

Version d'API:: 2023-10-01-preview

Interroger des journaux d’audit pour une ressource, glossaireTerm, classificationDef, etc.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Point de terminaison de carte de données de votre compte Purview. Exemple : https://{accountName}.purview.azure.com
api-version	query	True	string	Version de l’API.

Corps de la demande

Nom	Type	Description
category	AuditCategory	AuditCategory Catégorie d’audit dans la requête de requête du journal d’audit.
continuationToken	string	Jeton de continuation pour récupérer la page suivante.
endTime	string	Heure de fin du journal d’audit ; Représentation ISO-8601. La valeur par défaut est UTC maintenant.
guid	string	GUID de la ressource targe, du terme de glossaire ou de la définition de classification.
keywords	string	Tous les mots clés contenus dans l’ancienne valeur du journal d’audit ou la nouvelle partie de valeur.
operationType	AuditOperationType	AuditOperationType Type d’opération d’audit.
pageSize	integer (int32)	Nombre d’éléments que nous espérons retourner dans une page. La valeur maximale est 1000.
qualifiedName	string	Appliqué uniquement à la ressource ; spécifie le nom qualifié de la ressource.
sortBy	string	Propriété à trier par. La valeur doit être l’un des champs de schéma du journal d’audit. Doit être utilisé avec « SortOrder ». CreationTime est suggéré.
sortOrder	AuditSortOrder	AuditSortOrder Auditer l’ordre de tri des résultats de la requête.
startTime	string	Heure de début du journal d’audit ; Représentation ISO-8601. La valeur par défaut est 1970-01-01T00:00:00Z.
typeName	string	Appliqué uniquement à la ressource ; spécifie le nom du type de ressource.
userId	string	Nom d’utilisateur principal ou ID d’objet principal du service.

Réponses

Nom	Type	Description
200 OK	AuditLogQueryResponse	D’ACCORD. Sur la recherche réussie des journaux d’audit dans les critères de recherche.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Audit_Query

Exemple de requête

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
}

Exemple de réponse

Code d’état:: 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\"]}}"
    }
  ]
}

Définitions

Nom	Description
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	Réponse d’erreur du service

AuditCategory

Énumération

AuditCategory

Valeur	Description
Asset
GlossaryTerm
ClassificationDef

AuditLog

Object

AuditLog

Nom	Type	Description
accountId	string	ID de compte Purview.
catalogId	string	ID du catalogue Purview.
changeRequestId	string	ID de corrélation.
clientIP	string	Adresse IP du client.
cloudType	string	Type de cloud auquel appartient l’objet
creationTime	string	Horodatage lors de la création du journal d’audit.
id	string	ID de journal.
newValue	string	Nouvelle valeur de données.
objectCollectionId	string	ID de collection d’objets.
objectFullyQualifiedName	string	Nom complet de l’objet.
objectId	string	GUID de la ressource targe, du terme de glossaire ou de la définition de classification.
objectName	string	Nom de l’objet.
objectType	string	Nom du type d’objet.
oldValue	string	Ancienne valeur de données.
operation	AuditOperationType	AuditOperationType Type d’opération d’audit.
organizationId	string	ID de locataire du client.
recordType	integer (int32)	Métadonnées du journal. Indique le type d’enregistrement du journal d’audit.
serviceType	string	Type de service auquel appartient l’objet
userId	string	Nom d’utilisateur principal.
userKey	string	Identité de l’utilisateur.
userType	integer (int32)	Type d’utilisateur qui a effectué l’opération.
workload	string	Métadonnées du journal. Indique le type de charge de travail du journal d’audit.

AuditLogQueryRequest

Object

AuditLogQueryRequest

Nom	Type	Description
category	AuditCategory	AuditCategory Catégorie d’audit dans la requête de requête du journal d’audit.
continuationToken	string	Jeton de continuation pour récupérer la page suivante.
endTime	string	Heure de fin du journal d’audit ; Représentation ISO-8601. La valeur par défaut est UTC maintenant.
guid	string	GUID de la ressource targe, du terme de glossaire ou de la définition de classification.
keywords	string	Tous les mots clés contenus dans l’ancienne valeur du journal d’audit ou la nouvelle partie de valeur.
operationType	AuditOperationType	AuditOperationType Type d’opération d’audit.
pageSize	integer (int32)	Nombre d’éléments que nous espérons retourner dans une page. La valeur maximale est 1000.
qualifiedName	string	Appliqué uniquement à la ressource ; spécifie le nom qualifié de la ressource.
sortBy	string	Propriété à trier par. La valeur doit être l’un des champs de schéma du journal d’audit. Doit être utilisé avec « SortOrder ». CreationTime est suggéré.
sortOrder	AuditSortOrder	AuditSortOrder Auditer l’ordre de tri des résultats de la requête.
startTime	string	Heure de début du journal d’audit ; Représentation ISO-8601. La valeur par défaut est 1970-01-01T00:00:00Z.
typeName	string	Appliqué uniquement à la ressource ; spécifie le nom du type de ressource.
userId	string	Nom d’utilisateur principal ou ID d’objet principal du service.

AuditLogQueryResponse

Object

AuditLogQueryResponse

Nom	Type	Description
continuationToken	string	Jeton de continuation pour récupérer la page suivante. Lorsque « lastPage » a la valeur false. Le client utilise ce jeton dans la charge utile de requête pour récupérer la page suivante.
lastPage	boolean	Indique s’il s’agit de la dernière page.
recordCount	integer (int32)	Nombre d’éléments dans la page active.
resultData	AuditLog[]	Tableau de journaux d’audit.
totalResultCount	integer (int32)	Nombre total d’éléments qualifiés pour les critères de recherche.

AuditOperationType

Énumération

AuditOperationType

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

AuditSortOrder

Énumération

AuditSortOrder

Valeur	Description
Ascending
Descending

ErrorResponse

Object

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d’erreur.
errorMessage	string	Message d’erreur.
requestId	string	ID de demande.

Partager via

Audit - Query

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Audit_Query

Exemple de requête

Exemple de réponse

Définitions

AuditCategory

AuditLog

AuditLogQueryRequest

AuditLogQueryResponse

AuditOperationType

AuditSortOrder

ErrorResponse