Audit - Query

參考

服務:: Purview

API 版本:: 2023-10-01-preview

查詢資產、詞彙Term、classificationDef 等的稽核記錄。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	Purview 帳戶的 datamap 端點。範例：https://{accountName}.purview.azure.com
api-version	query	True	string	API 的版本。

要求本文

名稱	類型	Description
category	AuditCategory	AuditCategory 稽核記錄查詢要求中的稽核類別。
continuationToken	string	要擷取下一頁的接續令牌。
endTime	string	稽核記錄的結束時間;ISO-8601 表示法。預設值為UTC。
guid	string	targe 資產、詞彙或分類定義的 GUID。
keywords	string	稽核記錄舊值或新值部分中包含的任何關鍵詞。
operationType	AuditOperationType	AuditOperationType 稽核作業類型。
pageSize	integer	我們希望在單頁中傳回的項目數。最大值為 1000。
qualifiedName	string	僅套用至資產;指定資產限定名稱。
sortBy	string	排序依據的屬性。此值應該是其中一個稽核記錄架構欄位。必須與「SortOrder」搭配使用。建議使用 CreationTime。
sortOrder	AuditSortOrder	AuditSortOrder 稽核查詢結果排序順序。
startTime	string	稽核記錄的開始時間;ISO-8601 表示法。默認值為 1970-01-01T00：00：00Z。
typeName	string	僅套用至資產;指定資產類型名稱。
userId	string	用戶主體名稱或服務主體物件標識碼。

回應

名稱	類型	Description
200 OK	AuditLogQueryResponse	正常。在搜尋準則內成功查閱稽核記錄時。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Audit_Query

範例要求

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
}

範例回覆

狀態碼:: 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\"]}}"
    }
  ]
}

定義

名稱	Description
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	來自服務的錯誤回應

AuditCategory

名稱	類型	Description
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

名稱	類型	Description
accountId	string	Purview 帳戶標識碼。
catalogId	string	Purview 目錄標識碼。
changeRequestId	string	相互關連識別碼。
clientIP	string	用戶端IP位址。
cloudType	string	物件所屬的雲端類型
creationTime	string	建立稽核記錄時的時間戳。
id	string	記錄標識碼。
newValue	string	新的數據值。
objectCollectionId	string	物件集合標識碼。
objectFullyQualifiedName	string	物件完整名稱。
objectId	string	targe 資產、詞彙或分類定義的 GUID。
objectName	string	物件名稱。
objectType	string	物件類型名稱。
oldValue	string	舊數據值。
operation	AuditOperationType	AuditOperationType 稽核作業類型。
organizationId	string	客戶租用戶標識碼。
recordType	integer	記錄元數據。指出稽核記錄的記錄類型。
serviceType	string	物件所屬的服務類型
userId	string	使用者主體名稱。
userKey	string	使用者身分識別。
userType	integer	執行作業的用戶類型。
workload	string	記錄元數據。指出稽核記錄的工作負載類型。

AuditLogQueryRequest

名稱	類型	Description
category	AuditCategory	AuditCategory 稽核記錄查詢要求中的稽核類別。
continuationToken	string	要擷取下一頁的接續令牌。
endTime	string	稽核記錄的結束時間;ISO-8601 表示法。預設值為UTC。
guid	string	targe 資產、詞彙或分類定義的 GUID。
keywords	string	稽核記錄舊值或新值部分中包含的任何關鍵詞。
operationType	AuditOperationType	AuditOperationType 稽核作業類型。
pageSize	integer	我們希望在單頁中傳回的項目數。最大值為 1000。
qualifiedName	string	僅套用至資產;指定資產限定名稱。
sortBy	string	排序依據的屬性。此值應該是其中一個稽核記錄架構欄位。必須與「SortOrder」搭配使用。建議使用 CreationTime。
sortOrder	AuditSortOrder	AuditSortOrder 稽核查詢結果排序順序。
startTime	string	稽核記錄的開始時間;ISO-8601 表示法。默認值為 1970-01-01T00：00：00Z。
typeName	string	僅套用至資產;指定資產類型名稱。
userId	string	用戶主體名稱或服務主體物件標識碼。

AuditLogQueryResponse

名稱	類型	Description
continuationToken	string	要擷取下一頁的接續令牌。當「lastPage」為 false 時。用戶端會在查詢承載中使用這個令牌來擷取下一頁。
lastPage	boolean	指出是否為最後一頁。
recordCount	integer	目前頁面中的項目數。
resultData	AuditLog[]	稽核記錄的陣列。
totalResultCount	integer	符合搜尋準則的項目總數。

AuditOperationType

名稱	類型	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

名稱	類型	Description
Ascending	string
Descending	string

ErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

共用方式為

Audit - Query

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Audit_Query

範例要求

範例回覆

定義

AuditCategory

AuditLog

AuditLogQueryRequest

AuditLogQueryResponse

AuditOperationType

AuditSortOrder

ErrorResponse

其他資源