Audit - Query

Referenz

Dienst:: Purview

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

Abfragen von Überwachungsprotokollen für ein Medienobjekt, 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 der Abfrageanforderung des Überwachungsprotokolls.
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, des Glossarbegriffs oder der Klassifizierungsdefinition.
keywords	string	Alle Schlüsselwörter, die im Überwachungsprotokoll des alten Werts oder neuen Wertteils enthalten sind.
operationType	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
pageSize	integer	Die Anzahl der Elemente, die auf einer Seite zurückgegeben werden sollen. Der Maximalwert ist 1000.
qualifiedName	string	Gilt nur für Das Medienobjekt; gibt den qualifizierten Namen des Medienobjekts an.
sortBy	string	Zu sortierende Eigenschaft. Der Wert sollte eines des Überwachungsprotokollschemafelds sein. Muss mit "SortOrder" verwendet werden. CreationTime wird vorgeschlagen.
sortOrder	AuditSortOrder	AuditSortOrder Sortierreihenfolge des Abfrageergebnisses überwachen.
startTime	string	Startzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist 1970-01-01T00:00:00Z.
typeName	string	Gilt nur für Das Medienobjekt; gibt den Namen des Medienobjekttyps an.
userId	string	Benutzerprinzipalname oder Dienstprinzipalobjekt-ID.

Antworten

Name	Typ	Beschreibung
200 OK	AuditLogQueryResponse	OK. Bei erfolgreicher Suche von Überwachungsprotokollen innerhalb der Suchkriterien.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Name	Typ	Beschreibung
Asset	string
ClassificationDef	string
GlossaryTerm	string

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 Name des Objekts.
objectId	string	GUID der Targe-Ressource, des Glossarbegriffs oder der Klassifizierungsdefinition.
objectName	string	Objektname
objectType	string	Objekttypname.
oldValue	string	Alter Datenwert.
operation	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
organizationId	string	Kundenmandanten-ID.
recordType	integer	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	Typ des Benutzers, der den Vorgang ausgeführt hat.
workload	string	Protokollmetadaten. Gibt den Workloadtyp des Überwachungsprotokolls an.

AuditLogQueryRequest

Name	Typ	Beschreibung
category	AuditCategory	AuditCategory Überwachungskategorie in der Abfrageanforderung des Überwachungsprotokolls.
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, des Glossarbegriffs oder der Klassifizierungsdefinition.
keywords	string	Alle Schlüsselwörter, die im Überwachungsprotokoll des alten Werts oder neuen Wertteils enthalten sind.
operationType	AuditOperationType	AuditOperationType Überwachungsvorgangstyp.
pageSize	integer	Die Anzahl der Elemente, die auf einer Seite zurückgegeben werden sollen. Der Maximalwert ist 1000.
qualifiedName	string	Gilt nur für Das Medienobjekt; gibt den qualifizierten Namen des Medienobjekts an.
sortBy	string	Zu sortierende Eigenschaft. Der Wert sollte eines des Überwachungsprotokollschemafelds sein. Muss mit "SortOrder" verwendet werden. CreationTime wird vorgeschlagen.
sortOrder	AuditSortOrder	AuditSortOrder Sortierreihenfolge des Abfrageergebnisses überwachen.
startTime	string	Startzeit des Überwachungsprotokolls; ISO-8601-Darstellung. Der Standardwert ist 1970-01-01T00:00:00Z.
typeName	string	Gilt nur für Das Medienobjekt; gibt den Namen des Medienobjekttyps an.
userId	string	Benutzerprinzipalname oder Dienstprinzipalobjekt-ID.

AuditLogQueryResponse

Name	Typ	Beschreibung
continuationToken	string	Das Fortsetzungstoken zum Abrufen der nächsten Seite. Wenn "lastPage" auf false festgelegt ist. Der 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	Die Anzahl der Elemente auf der aktuellen Seite.
resultData	AuditLog[]	Ein Array von Überwachungsprotokollen.
totalResultCount	integer	Die Anzahl der Gesamtelemente, die für die Suchkriterien qualifiziert sind.

AuditOperationType

Name	Typ	Beschreibung
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

Name	Typ	Beschreibung
Ascending	string
Descending	string

ErrorResponse

Eine Fehlerantwort des Diensts

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

Freigeben über