Items - Get Eventstream Definition

Служба:: Eventstream

Версия API:: v1

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

При получении общедоступного определения eventstream метка конфиденциальности не является частью определения.

Разрешения

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

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

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

Ограничения

Этот API заблокирован для потока событий с зашифрованной меткой конфиденциальности.

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

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

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

Интерфейс

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

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	EventstreamDefinitionResponse	Запрос успешно завершен.
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 an eventstream definition example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/eventstreams/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

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

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
EventstreamDefinition	Объект общедоступного определения Eventstream. Дополнительные сведения о структуре определения Eventstream см. в этой статье .
EventstreamDefinitionPart	Объект части определения eventstream.
EventstreamDefinitionResponse	Ответ общедоступного определения eventstream.
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	Сведения об ошибках, связанных с ресурсом.

EventstreamDefinition

Объект

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

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

EventstreamDefinitionPart

Объект

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

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

EventstreamDefinitionResponse

Объект

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

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

PayloadType

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

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

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