Audit - Query

Ссылка

Служба:: Purview

Версия API:: 2023-10-01-preview

Журналы аудита запросов для ресурса, глоссарияTerm, 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	GUID ресурса targe, термина глоссария или определения классификации.
keywords	string	Любые ключевые слова, содержащиеся в старой или новой части значения журнала аудита.
operationType	AuditOperationType	AuditOperationType Тип операции аудита.
pageSize	integer (int32)	Количество элементов, которые мы надеемся вернуть на одной странице. Максимальное значение равно 1000.
qualifiedName	string	Применяется только к ресурсу; указывает полное имя ресурса.
sortBy	string	Свойство для сортировки. Значение должно быть одним из полей схемы журнала аудита. Должен использоваться с "SortOrder". Предлагается Время создания.
sortOrder	AuditSortOrder	AuditSortOrder Аудит порядка сортировки результатов запроса.
startTime	string	Время начала журнала аудита; Представление ISO-8601. Значение по умолчанию — 1970-01-01T00:00:00Z.
typeName	string	Применяется только к ресурсу; указывает имя типа ресурса.
userId	string	Имя субъекта-пользователя или идентификатор объекта субъекта-службы.

Ответы

Имя	Тип	Описание
200 OK	AuditLogQueryResponse	Все в порядке. При успешном поиске журналов аудита в рамках условий поиска.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: 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

Перечисление

AuditCategory

Значение	Описание
Asset
ClassificationDef
GlossaryTerm

AuditLog

Object

AuditLog

Имя	Тип	Описание
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	GUID ресурса targe, термина глоссария или определения классификации.
objectName	string	Имя объекта.
objectType	string	Имя типа объекта.
oldValue	string	Старое значение данных.
operation	AuditOperationType	AuditOperationType Тип операции аудита.
organizationId	string	Идентификатор клиента.
recordType	integer (int32)	Метаданные журнала. Указывает тип записи журнала аудита.
serviceType	string	Тип службы, к которой принадлежит объект
userId	string	Имя участника-пользователя.
userKey	string	Удостоверение пользователя.
userType	integer (int32)	Тип пользователя, который выполнил операцию.
workload	string	Метаданные журнала. Указывает тип рабочей нагрузки журнала аудита.

AuditLogQueryRequest

Object

AuditLogQueryRequest

Имя	Тип	Описание
category	AuditCategory	AuditCategory Категория аудита в запросе к журналу аудита.
continuationToken	string	Маркер продолжения для получения следующей страницы.
endTime	string	Время окончания журнала аудита; Представление ISO-8601. Сейчас значение по умолчанию — UTC.
guid	string	GUID ресурса targe, термина глоссария или определения классификации.
keywords	string	Любые ключевые слова, содержащиеся в старой или новой части значения журнала аудита.
operationType	AuditOperationType	AuditOperationType Тип операции аудита.
pageSize	integer (int32)	Количество элементов, которые мы надеемся вернуть на одной странице. Максимальное значение равно 1000.
qualifiedName	string	Применяется только к ресурсу; указывает полное имя ресурса.
sortBy	string	Свойство для сортировки. Значение должно быть одним из полей схемы журнала аудита. Должен использоваться с "SortOrder". Предлагается Время создания.
sortOrder	AuditSortOrder	AuditSortOrder Аудит порядка сортировки результатов запроса.
startTime	string	Время начала журнала аудита; Представление ISO-8601. Значение по умолчанию — 1970-01-01T00:00:00Z.
typeName	string	Применяется только к ресурсу; указывает имя типа ресурса.
userId	string	Имя субъекта-пользователя или идентификатор объекта субъекта-службы.

AuditLogQueryResponse

Object

AuditLogQueryResponse

Имя	Тип	Описание
continuationToken	string	Маркер продолжения для получения следующей страницы. Если "lastPage" имеет значение false. Клиент использует этот маркер в полезных данных запроса для получения следующей страницы.
lastPage	boolean	Указывает, является ли это последней страницей.
recordCount	integer (int32)	Количество элементов на текущей странице.
resultData	AuditLog[]	Массив журналов аудита.
totalResultCount	integer (int32)	Общее количество элементов, удовлетворяющих условиям поиска.

AuditOperationType

Перечисление

AuditOperationType

Значение	Описание
ClassificationAdded
ClassificationDefinitionCreated
ClassificationDefinitionDeleted
ClassificationDefinitionUpdated
ClassificationDeleted
ClassificationUpdated
EntityCreated
EntityDeleted
EntityUpdated
GlossaryTermAssigned
GlossaryTermCreated
GlossaryTermDeleted
GlossaryTermDisassociated
GlossaryTermUpdated
SensitivityLabelChanged

AuditSortOrder

Перечисление

AuditSortOrder

Значение	Описание
Ascending
Descending

ErrorResponse

Object

Ответ об ошибке от службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string	Идентификатор запроса.

Поделиться через

Audit - Query

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Audit_Query

Образец запроса

Пример ответа

Определения

AuditCategory

AuditLog

AuditLogQueryRequest

AuditLogQueryResponse

AuditOperationType

AuditSortOrder

ErrorResponse

Дополнительные ресурсы