Items - Get KQL Queryset Definition

Служба:

KQLQueryset

Версия API:

v1

Возвращает указанное общедоступное определение набора запросов KQL.
Этот API поддерживает длительные операции (LRO).

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для набора запросов KQL.

Обязательные делегированные области

KQLQueryset.ReadWrite.All или Item.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
учетные записи службы и управляемые удостоверения	Да

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition

С использованием необязательных параметров:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition?format={format}

Параметры URI

Имя	В	Обязательно	Тип	Описание
kqlQuerysetId	path	True	string (uuid)	Идентификатор набора запросов KQL.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения набора запросов KQL.

Ответы

Имя	Тип	Описание
200 OK	KQLQuerysetDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a KQL queryset definition example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/314fff62-7c47-4225-9a6c-1a2220f4ce32/kqlQuerysets/9b7de20c-a62f-470e-931d-e7e53f373c0c/getDefinition

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

Код состояния:

200

{
  "definition": {
    "parts": [
      {
        "path": "RealTimeQueryset.json",
        "payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIktRTFF1ZXJ5c2V0IiwKICAgICJkaXNwbGF5TmFtZSI6ICJjeHp2ZWFyZ2giLAogICAgImRlc2NyaXB0aW9uIjogImN4enZlYXJnaCIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
KQLQuerysetDefinition	Объект общедоступного определения набора запросов KQL. Дополнительные сведения о структуре определения набора запросов KQL см. в этой статье .
KQLQuerysetDefinitionPart	Объект части определения набора запросов KQL.
KQLQuerysetDefinitionResponse	Ответ открытого определения набора запросов KQL.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

KQLQuerysetDefinition

Объект

Объект общедоступного определения набора запросов KQL. Дополнительные сведения о структуре определения набора запросов KQL см. в этой статье .

Имя	Тип	Описание
format	string	Формат определения элемента.
parts	KQLQuerysetDefinitionPart[]	Список частей определения.

KQLQuerysetDefinitionPart

Объект

Объект части определения набора запросов KQL.

Имя	Тип	Описание
path	string	Путь к набору запросов KQL.
payload	string	Полезные данные набора запросов KQL.
payloadType	PayloadType	Тип полезных данных.

KQLQuerysetDefinitionResponse

Объект

Ответ открытого определения набора запросов KQL.

Имя	Тип	Описание
definition	KQLQuerysetDefinition	Объект общедоступного определения набора запросов KQL. Дополнительные сведения о структуре определения набора запросов KQL см. в этой статье .

PayloadType

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

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.