Items - Create Eventstream

Ссылка

Служба:: Eventstream

Версия API:: v1

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

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

Разрешения

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

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

Eventstream.ReadWrite.All или Item.ReadWrite.All

Ограничения

Чтобы создать поток событий, рабочая область должна находиться в поддерживаемой емкости Fabric. Дополнительные сведения см. в статье типов лицензий Microsoft Fabric.

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

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

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

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string uuid	Идентификатор рабочей области.

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

Имя	Обязательно	Тип	Описание
displayName	True	string	Отображаемое имя потока событий. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
definition		EventstreamDefinition	Общедоступное определение eventstream.
description		string	Описание потока событий. Максимальная длина — 256 символов.

Ответы

Имя	Тип	Описание
201 Created	Eventstream	Успешно создано
202 Accepted		Запрос принят, подготовка потока событий выполняется Заголовки Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: InvalidItemType — тип элемента недопустим ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется. Поврежденный Payload — предоставленные полезные данные повреждены.

Имя

Тип

Описание

201 Created

Eventstream

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

202 Accepted

Запрос принят, подготовка потока событий выполняется

Заголовки

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

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

InvalidItemType — тип элемента недопустим
ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.
Поврежденный Payload — предоставленные полезные данные повреждены.

Примеры

Create an eventstream example

Create an eventstream with public definition example

Create an eventstream example

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

HTTP

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

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description."
}

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

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

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an eventstream with public definition example

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

HTTP

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

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "definition": {
    "format": "eventstream",
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

{
  "displayName": "Eventstream_1",
  "description": "Eventstream_1 description.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Определения

Имя	Описание
CreateEventstreamRequest	Создайте полезные данные запроса eventstream.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
Eventstream	Объект eventstream.
EventstreamDefinition	Объект общедоступного определения Eventstream.
EventstreamDefinitionPart	Объект части определения eventstream.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

CreateEventstreamRequest

Object

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

Имя	Тип	Описание
definition	EventstreamDefinition	Общедоступное определение eventstream.
description	string	Описание потока событий. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя потока событий. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

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

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

ErrorResponseDetails

Object

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

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

Eventstream

Object

Объект eventstream.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
id	string uuid	Идентификатор элемента.
type	ItemType	Тип элемента.
workspaceId	string uuid	Идентификатор рабочей области.

EventstreamDefinition

Object

Объект общедоступного определения Eventstream.

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

EventstreamDefinitionPart

Object

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

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

ItemType

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

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

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
DataPipeline	Конвейер данных.
Datamart	Datamart PowerBI.
Environment	Среда.
Eventhouse	Хранилище событий.
Eventstream	Поток событий.
GraphQLApi	API для элемента GraphQL.
KQLDashboard	Панель мониторинга KQL.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
Lakehouse	Озеро.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
MirroredDatabase	Зеркальная база данных.
MirroredWarehouse	Зеркальный склад.
MountedDataFactory	ПодключеннаяdataFactory.
Notebook	Записная книжка.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Reflex	Рефлекс.
Report	Отчет PowerBI.
SQLDatabase	База данных SQLDatabase.
SQLEndpoint	Конечная точка SQL.
SemanticModel	Семантическая модель PowerBI.
SparkJobDefinition	Определение задания Spark.
Warehouse	Склад.

PayloadType

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

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

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

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

Items - Create Eventstream

Разрешения

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

Ограничения

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

Интерфейс

Параметры URI

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

Ответы

Примеры

Create an eventstream example

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

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

Create an eventstream with public definition example

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

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

Определения

CreateEventstreamRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Eventstream

EventstreamDefinition

EventstreamDefinitionPart

ItemType

PayloadType

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