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

Items - Update Eventstream Definition

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

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

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

Разрешения

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

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

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

Идентификаторы, поддерживаемые Microsoft Entra

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition
С использованием необязательных параметров: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

Параметры URI

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

string (uuid)

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

string (uuid)

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

boolean

Следует ли обновлять метаданные элемента, если он указан в .platform файле. True. Обновите метаданные, если он указан в файле в .platform рамках определения, False — не обновляйте метаданные.

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

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

EventstreamDefinition

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

Ответы

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

Запрос успешно завершен.
202 Accepted

Запрос принят. Определение обновления выполняется.

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

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

  • OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

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

Примеры

Update an eventstream definition example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

Код состояния:
200
Код состояния:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Определения

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

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

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

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

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

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

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

Обновление полезных данных запроса общедоступного определения 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

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

EventstreamDefinition

Object

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

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

string

Формат определения элемента.
parts

EventstreamDefinitionPart[]

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

EventstreamDefinitionPart

Object

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

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

string

Путь к части eventstream.
payload

string

Полезные данные части eventstream.
payloadType

PayloadType

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

PayloadType

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

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

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

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

UpdateEventstreamDefinitionRequest

Object

Обновление полезных данных запроса общедоступного определения eventstream.

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

EventstreamDefinition

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