Audit - Query

Référence

Service:: Purview

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

Interroger les journaux d’audit d’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 datamap 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 demande de requête de 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 ou la nouvelle partie valeur du journal d’audit.
operationType	AuditOperationType	AuditOperationType Type d’opération d’audit.
pageSize	integer	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. 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 Ordre de tri des résultats de la requête d’audit.
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 du principe de service.

Réponses

Nom	Type	Description
200 OK	AuditLogQueryResponse	OK. Lors de la recherche réussie des journaux d’audit dans les critères de recherche.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

Nom	Type	Description
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

Nom	Type	Description
accountId	string	ID de compte Purview.
catalogId	string	ID de catalogue Purview.
changeRequestId	string	ID de corrélation.
clientIP	string	Adresse IP du client.
cloudType	string	Type de cloud auquel l’objet appartient
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 d’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 client.
recordType	integer	Métadonnées de journal. Indique le type d’enregistrement du journal d’audit.
serviceType	string	Type de service auquel l’objet appartient
userId	string	Nom d’utilisateur principal.
userKey	string	Identité de l’utilisateur.
userType	integer	Type d’utilisateur qui a effectué l’opération.
workload	string	Métadonnées de journal. Indique le type de charge de travail du journal d’audit.

AuditLogQueryRequest

Nom	Type	Description
category	AuditCategory	AuditCategory Catégorie d’audit dans la demande de requête de 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 ou la nouvelle partie valeur du journal d’audit.
operationType	AuditOperationType	AuditOperationType Type d’opération d’audit.
pageSize	integer	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. 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 Ordre de tri des résultats de la requête d’audit.
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 du principe de service.

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	Nombre d’éléments dans la page active.
resultData	AuditLog[]	Tableau de journaux d’audit.
totalResultCount	integer	Nombre total d’éléments qualifiés pour les critères de recherche.

AuditOperationType

Nom	Type	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

Nom	Type	Description
Ascending	string
Descending	string

ErrorResponse

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