Audit - Query

참조

서비스:: Purview

API 버전:: 2023-10-01-preview

자산, 용어집Term, classificationDef 등에 대한 감사 로그를 쿼리합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	Purview 계정의 데이터맵 엔드포인트입니다. 예: https://{accountName}.purview.azure.com
api-version	query	True	string	API 버전입니다.

요청 본문

Name	형식	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	사용자 계정 이름 또는 서비스 주체 개체 ID입니다.

응답

Name	형식	Description
200 OK	AuditLogQueryResponse	OK. 검색 조건 내에서 감사 로그를 성공적으로 조회합니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

정의

Name	Description
AuditCategory	AuditCategory
AuditLog	AuditLog
AuditLogQueryRequest	AuditLogQueryRequest
AuditLogQueryResponse	AuditLogQueryResponse
AuditOperationType	AuditOperationType
AuditSortOrder	AuditSortOrder
ErrorResponse	서비스의 오류 응답

AuditCategory

Name	형식	Description
Asset	string
ClassificationDef	string
GlossaryTerm	string

AuditLog

Name	형식	Description
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	사용자 ID.
userType	integer	작업을 수행한 사용자 유형입니다.
workload	string	로그 메타데이터. 감사 로그의 워크로드 유형을 나타냅니다.

AuditLogQueryRequest

Name	형식	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	사용자 계정 이름 또는 서비스 주체 개체 ID입니다.

AuditLogQueryResponse

Name	형식	Description
continuationToken	string	다음 페이지를 검색할 연속 토큰입니다. "lastPage"가 false인 경우 클라이언트는 쿼리 페이로드에서 이 토큰을 사용하여 다음 페이지를 검색합니다.
lastPage	boolean	마지막 페이지인지 여부를 나타냅니다.
recordCount	integer	현재 페이지의 항목 수입니다.
resultData	AuditLog[]	감사 로그의 배열입니다.
totalResultCount	integer	검색 조건에 적합한 총 항목 수입니다.

AuditOperationType

Name	형식	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

Name	형식	Description
Ascending	string
Descending	string

ErrorResponse

서비스의 오류 응답

Name	형식	Description
errorCode	string	오류 코드입니다.
errorMessage	string	오류 메시지입니다.
requestId	string	요청 ID입니다.

다음을 통해 공유

Audit - Query

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Audit_Query

샘플 요청

샘플 응답

정의

AuditCategory

AuditLog

AuditLogQueryRequest

AuditLogQueryResponse

AuditOperationType

AuditSortOrder

ErrorResponse

추가 리소스