Audit - Query

Dienst:: Purview

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

Abfragen von Überwachungsprotokollen für ein Objekt, glossaryTerm, classificationDef usw.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Der Datamap-Endpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Typ	Beschreibung
category	AuditCategory	AuditCategory Überwachungskategorie in Überwachungsprotokollabfrageanforderung.
continuationToken	string	Das Fortsetzungstoken zum Abrufen der nächsten Seite.
endTime	string	Endzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist jetzt UTC.
guid	string	GUID der Targe-Ressource, Glossarausdruck oder Klassifizierungsdefinition.
keywords	string	Alle Schlüsselwörter, die im Alten Oder neuen Wertteil des Überwachungsprotokolls enthalten sind.
operationType	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
pageSize	integer (int32)	Die Anzahl der Elemente, die auf einer Seite zurückgegeben werden sollen. Der Maximalwert ist 1000.
qualifiedName	string	Nur auf Vermögenswerte angewendet; Gibt den qualifizierten Objektnamen an.
sortBy	string	Eigenschaft, nach der sortiert werden soll. Der Wert sollte eins des Überwachungsprotokollschemafelds sein. Muss mit "SortOrder" verwendet werden. CreationTime wird vorgeschlagen.
sortOrder	AuditSortOrder	AuditSortOrder Sortierreihenfolge des Überwachungsabfrageergebnisses.
startTime	string	Startzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist 1970-01-01T00:00:00Z.
typeName	string	Nur auf Vermögenswerte angewendet; Gibt den Objekttypnamen an.
userId	string	Benutzerprinzipalname oder Objekt-ID des Dienstprinzipals.

Antworten

Name	Typ	Beschreibung
200 OK	AuditLogQueryResponse	OKAY. Bei erfolgreicher Suche nach Überwachungsprotokollen innerhalb der Suchkriterien.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Audit_Query

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:: 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\"]}}"
    }
  ]
}

Definitionen

Name	Beschreibung
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	Eine Fehlerantwort des Diensts

AuditCategory

Enumeration

AuditCategory

Wert	Beschreibung
Asset
GlossaryTerm
ClassificationDef

AuditLog

Objekt

AuditLog

Name	Typ	Beschreibung
accountId	string	Purview-Konto-ID.
catalogId	string	Purview-Katalog-ID.
changeRequestId	string	Korrelations-ID.
clientIP	string	Client-IP-Adresse.
cloudType	string	Cloudtyp, zu dem das Objekt gehört
creationTime	string	Zeitstempel beim Erstellen des Überwachungsprotokolls.
id	string	Protokoll-ID.
newValue	string	Neuer Datenwert.
objectCollectionId	string	Objektsammlungs-ID.
objectFullyQualifiedName	string	Vollqualifizierter Objektname.
objectId	string	GUID der Targe-Ressource, Glossarausdruck oder Klassifizierungsdefinition.
objectName	string	Objektname.
objectType	string	Objekttypname.
oldValue	string	Alter Datenwert.
operation	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
organizationId	string	Kundenmandanten-ID.
recordType	integer (int32)	Protokollmetadaten. Gibt den Datensatztyp des Überwachungsprotokolls an.
serviceType	string	Diensttyp, zu dem das Objekt gehört
userId	string	Benutzerprinzipalname.
userKey	string	Benutzeridentität.
userType	integer (int32)	Typ des Benutzers, der den Vorgang ausgeführt hat.
workload	string	Protokollmetadaten. Gibt den Workloadtyp des Überwachungsprotokolls an.

AuditLogQueryRequest

Objekt

AuditLogQueryRequest

Name	Typ	Beschreibung
category	AuditCategory	AuditCategory Überwachungskategorie in Überwachungsprotokollabfrageanforderung.
continuationToken	string	Das Fortsetzungstoken zum Abrufen der nächsten Seite.
endTime	string	Endzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist jetzt UTC.
guid	string	GUID der Targe-Ressource, Glossarausdruck oder Klassifizierungsdefinition.
keywords	string	Alle Schlüsselwörter, die im Alten Oder neuen Wertteil des Überwachungsprotokolls enthalten sind.
operationType	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
pageSize	integer (int32)	Die Anzahl der Elemente, die auf einer Seite zurückgegeben werden sollen. Der Maximalwert ist 1000.
qualifiedName	string	Nur auf Vermögenswerte angewendet; Gibt den qualifizierten Objektnamen an.
sortBy	string	Eigenschaft, nach der sortiert werden soll. Der Wert sollte eins des Überwachungsprotokollschemafelds sein. Muss mit "SortOrder" verwendet werden. CreationTime wird vorgeschlagen.
sortOrder	AuditSortOrder	AuditSortOrder Sortierreihenfolge des Überwachungsabfrageergebnisses.
startTime	string	Startzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist 1970-01-01T00:00:00Z.
typeName	string	Nur auf Vermögenswerte angewendet; Gibt den Objekttypnamen an.
userId	string	Benutzerprinzipalname oder Objekt-ID des Dienstprinzipals.

AuditLogQueryResponse

Objekt

AuditLogQueryResponse

Name	Typ	Beschreibung
continuationToken	string	Das Fortsetzungstoken zum Abrufen der nächsten Seite. Wenn "lastPage" falsch ist. Client verwendet dieses Token in der Abfragenutzlast, um die nächste Seite abzurufen.
lastPage	boolean	Gibt an, ob es sich um die letzte Seite handelt.
recordCount	integer (int32)	Die Anzahl der Elemente auf der aktuellen Seite.
resultData	AuditLog[]	Ein Array von Überwachungsprotokollen.
totalResultCount	integer (int32)	Die Anzahl der Gesamtelemente, die für die Suchkriterien qualifiziert sind.

AuditOperationType

Enumeration

AuditOperationType

Wert	Beschreibung
EntityCreated
EntityUpdated
EntityDeleted
ClassificationAdded
ClassificationUpdated
ClassificationDeleted
SensitivityLabelChanged
GlossaryTermAssigned
GlossaryTermDisassociated
ClassificationDefinitionCreated
ClassificationDefinitionUpdated
ClassificationDefinitionDeleted
GlossaryTermCreated
GlossaryTermUpdated
GlossaryTermDeleted

AuditSortOrder

Enumeration

AuditSortOrder

Wert	Beschreibung
Ascending
Descending

ErrorResponse

Objekt

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string	Die Anforderungs-ID.

Freigeben über

Audit - Query

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Audit_Query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AuditCategory

AuditLog

AuditLogQueryRequest

AuditLogQueryResponse

AuditOperationType

AuditSortOrder

ErrorResponse