你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Audit - Query

参考

服务:: Purview

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

查询资产、术语表术语表、classificationDef 等的审核日志。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	Purview 帐户的数据映射终结点。示例：https://{accountName}.purview.azure.com
api-version	query	True	string	API 的版本。

请求正文

名称	类型	说明
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	用户主体名称或服务主体对象 ID。

响应

名称	类型	说明
200 OK	AuditLogQueryResponse	没问题。成功查找搜索条件中的审核日志时。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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\"]}}"
    }
  ]
}

定义

名称	说明
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	来自服务的错误响应

AuditCategory

名称	类型	说明
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

名称	类型	说明
accountId	string	Purview 帐户 ID。
catalogId	string	Purview 目录 ID。
changeRequestId	string	相关性 ID。
clientIP	string	客户端 IP 地址。
cloudType	string	对象所属的云类型
creationTime	string	创建审核日志时的时间戳。
id	string	日志 ID。
newValue	string	新数据值。
objectCollectionId	string	对象集合 ID。
objectFullyQualifiedName	string	对象完全限定的名称。
objectId	string	targe 资产、术语表术语或分类定义的 GUID。
objectName	string	对象名称。
objectType	string	对象类型名称。
oldValue	string	旧数据值。
operation	AuditOperationType	AuditOperationType 审核操作类型。
organizationId	string	客户租户 ID。
recordType	integer	日志元数据。指示审核日志的记录类型。
serviceType	string	对象所属的服务类型
userId	string	用户主体名称。
userKey	string	用户标识。
userType	integer	执行操作的用户的类型。
workload	string	日志元数据。指示审核日志的工作负荷类型。

AuditLogQueryRequest

名称	类型	说明
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	用户主体名称或服务主体对象 ID。

AuditLogQueryResponse

名称	类型	说明
continuationToken	string	用于检索下一页的继续标记。当“lastPage”为 false 时。客户端在查询有效负载中使用此令牌来检索下一页。
lastPage	boolean	指示它是否为最后一页。
recordCount	integer	当前页中的项数。
resultData	AuditLog[]	审核日志的数组。
totalResultCount	integer	符合搜索条件的总项数。

AuditOperationType

名称	类型	说明
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

名称	类型	说明
Ascending	string
Descending	string

ErrorResponse

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string	请求 ID。

通过