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

Items - Update Eventstream

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

Обновляет свойства указанного потока событий.

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

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

string (uuid)

Идентификатор потока событий.
workspaceId
 path True

string (uuid)

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

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

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

string

Описание потока событий. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя потока событий. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

Ответы

Имя Тип Описание
200 OK

Eventstream

Запрос успешно завершен.
Other Status Codes

ErrorResponse

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

  • ItemNotFound — запрошенный элемент не найден.

  • InvalidRequest — недопустимый запрос на обновление.

Примеры

Update an eventstream example

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Eventstream_New_Name",
  "description": "A new description for eventstream."
}

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

Код состояния:
200 
{
  "displayName": "Eventstream_New_Name",
  "description": "A new description for eventstream.",
  "type": "Eventstream",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Определения

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

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

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

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

Объект eventstream.
ItemTag

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

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

Обновление запроса eventstream.

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

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

string (uuid)

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

string (uuid)

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

ItemTag[]

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

ItemType

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

string (uuid)

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

ItemTag

Object

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

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

string

Имя тега.
id

string (uuid)

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

ItemType

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

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

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

An ApacheAirflowJob.
CopyJob

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

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

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

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

Datamart PowerBI.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

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

Среда.
Eventhouse

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

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

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

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

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

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

Озеро.
MLExperiment

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

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

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

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

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

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

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

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

Рефлекс.
Report

Отчет PowerBI.
SQLDatabase

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

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

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

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

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

Склад.
WarehouseSnapshot

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

UpdateEventstreamRequest

Object

Обновление запроса eventstream.

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

string

Описание потока событий. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя потока событий. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.