Items - Create KQL Queryset

Служба:
KQLQueryset
Версия API:
v1

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

Чтобы создать набор запросов KQL с определением, ознакомьтесь с статьей о определении набора запросов KQL.

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

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

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя набора запросов KQL. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
definition

KQLQuerysetDefinition

Общедоступное определение набора запросов KQL.
description

string

Описание набора запросов KQL. Максимальная длина — 256 символов.
folderId

string (uuid)

Идентификатор папки. Если не указано или значение NULL, набор запросов KQL создается с рабочей областью в качестве папки.
sensitivityLabelSettings

SensitivityLabelSettings

Параметры метки конфиденциальности для набора запросов KQL.

Ответы

Имя Тип Описание
201 Created

KQLQueryset

Успешно создано
202 Accepted

Запрос принят, выполняется создание набора запросов KQL

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • InvalidItemType — тип элемента недопустим

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.

  • Поврежденный Payload — предоставленные полезные данные повреждены.

  • WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a KQL queryset example
Create a KQL queryset with definition example

Create a KQL queryset example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlQuerysets

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description"
}

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

Код состояния:
201 
{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "type": "KQLQueryset",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Create a KQL queryset with definition example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlQuerysets

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "definition": {
    "format": null,
    "parts": [
      {
        "path": "RealTimeQueryset.json",
        "payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

Код состояния:
201 
{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "type": "KQLQueryset",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Определения

Имя Описание
CreateKQLQuerysetRequest

Создайте полезные данные запроса KQL.
EntireTenantPrincipal

Представляет субъект клиента
ErrorRelatedResource

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

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

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

Группировка конкретных сведений. Применимо, если тип субъекта Group.
GroupPrincipal

Представляет группу безопасности.
GroupType

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

Представляет тег, примененный к элементу.
ItemType

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

Объект набора запросов KQL.
KQLQuerysetDefinition

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

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

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

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

Представляет метку конфиденциальности, примененную к элементу.
SensitivityLabelApplyStrategy

Стратегия применения метки конфиденциальности. Значением по умолчанию является ApplyOrFail. С течением времени могут добавляться дополнительные типы.
SensitivityLabelSettings

Параметры метки конфиденциальности.
ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
ServicePrincipalPrincipal

Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Представляет профиль субъекта-службы.
UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.
UserPrincipal

Представляет субъект пользователя Microsoft Entra.

CreateKQLQuerysetRequest

Объект

Создайте полезные данные запроса KQL.

Имя Тип Описание
definition

KQLQuerysetDefinition

Общедоступное определение набора запросов KQL.
description

string

Описание набора запросов KQL. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя набора запросов KQL. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId

string (uuid)

Идентификатор папки. Если не указано или значение NULL, набор запросов KQL создается с рабочей областью в качестве папки.
sensitivityLabelSettings

SensitivityLabelSettings

Параметры метки конфиденциальности для набора запросов KQL.

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

EntireTenant

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

ErrorRelatedResource

Объект

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

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

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

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя Тип Описание
groupType

GroupType

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

GroupPrincipal

Объект

Представляет группу безопасности.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
groupDetails

GroupDetails

Группировка конкретных сведений. Применимо, если тип субъекта Group.
id

string (uuid)

Идентификатор субъекта.
type string:

Group

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

GroupType

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

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

Значение Описание
Unknown

Тип основной группы неизвестен.
SecurityGroup

Субъект — это группа безопасности.
DistributionList

Субъект — это список рассылки.

ItemTag

Объект

Представляет тег, примененный к элементу.

Имя Тип Описание
displayName

string

Имя тега.
id

string (uuid)

Идентификатор тега.

ItemType

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

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

Значение Описание
Dashboard

Панель мониторинга PowerBI.
Report

Отчет PowerBI.
SemanticModel

Семантическая модель PowerBI.
PaginatedReport

Отчет с разбивкой на страницы PowerBI.
Datamart

Datamart PowerBI.
Lakehouse

Озеро.
Eventhouse

Хранилище событий.
Environment

Среда.
KQLDatabase

База данных KQL.
KQLQueryset

Набор запросов KQL.
KQLDashboard

Панель мониторинга KQL.
DataPipeline

Конвейер данных.
Notebook

Записная книжка.
SparkJobDefinition

Определение задания Spark.
MLExperiment

Эксперимент машинного обучения.
MLModel

Модель машинного обучения.
Warehouse

Склад.
Eventstream

Поток событий.
SQLEndpoint

Конечная точка SQL.
MirroredWarehouse

Зеркальный склад.
MirroredDatabase

Зеркальная база данных.
Reflex

Рефлекс.
GraphQLApi

API для элемента GraphQL.
MountedDataFactory

ПодключеннаяdataFactory.
SQLDatabase

База данных SQLDatabase.
CopyJob

Задание копирования.
VariableLibrary

ПеременнаяLibrary.
Dataflow

Поток данных.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Моментальный снимок хранилища.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog

Зеркальный каталог azure databricks.
Map

Карта.
AnomalyDetector

Детектор аномалий.
UserDataFunction

Функция данных пользователя.
GraphModel

A GraphModel.
GraphQuerySet

Набор запросов Graph.
SnowflakeDatabase

База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

База данных Cosmos DB.
Ontology

An Ontology.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

ЗеркальныйCatalog.

KQLQueryset

Объект

Объект набора запросов KQL.

Имя Тип Описание
defaultIdentity Principal:

Удостоверение элемента по умолчанию.
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
folderId

string (uuid)

Идентификатор папки.
id

string (uuid)

Идентификатор элемента.
sensitivityLabel

SensitivityLabel

Метка конфиденциальности элементов.
tags

ItemTag[]

Список примененных тегов.
type

ItemType

Тип элемента.
workspaceId

string (uuid)

Идентификатор рабочей области.

KQLQuerysetDefinition

Объект

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

Имя Тип Описание
format

string

Формат определения набора запросов KQL.
parts

KQLQuerysetDefinitionPart[]

Список частей определения.

KQLQuerysetDefinitionPart

Объект

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

Имя Тип Описание
path

string

Путь к набору запросов KQL.
payload

string

Полезные данные набора запросов KQL.
payloadType

PayloadType

Тип полезных данных.

PayloadType

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

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

Значение Описание
InlineBase64

Встроенная база 64.

PrincipalType

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

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

Значение Описание
User

Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal

Субъект является субъектом-службой Microsoft Entra.
Group

Субъект — это группа безопасности.
ServicePrincipalProfile

Субъект — это профиль субъекта-службы.
EntireTenant

Субъект представляет всех пользователей клиента.

SensitivityLabel

Объект

Представляет метку конфиденциальности, примененную к элементу.

Имя Тип Описание
id

string (uuid)

Идентификатор метки конфиденциальности.

SensitivityLabelApplyStrategy

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

Стратегия применения метки конфиденциальности. Значением по умолчанию является ApplyOrFail. С течением времени могут добавляться дополнительные типы.

Значение Описание
ApplyOrFail

Примените метку конфиденциальности или сбой операции, если она не может быть применена.
Ignore

Игнорируйте метку конфиденциальности, если ее нельзя применить и продолжить операцию без применения метки.

SensitivityLabelSettings

Объект

Параметры метки конфиденциальности.

Имя Тип Описание
labelId

string (uuid)

Идентификатор метки конфиденциальности.
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Стратегия применения метки конфиденциальности.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя Тип Описание
aadAppId

string (uuid)

Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalDetails

ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
type string:

ServicePrincipal

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

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя Тип Описание
parentPrincipal Principal:

Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
type string:

ServicePrincipalProfile

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

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя Тип Описание
userPrincipalName

string

Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

User

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

UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.