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

Items - Get Eventhouse Definition

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

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

Разрешения

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

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

Eventhouse.ReadWrite.All или Item.ReadWrite.All

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

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

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

Интерфейс

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

Параметры URI

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

string (uuid)

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

string (uuid)

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

string

Формат общедоступного определения eventhouse.

Ответы

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

EventhouseDefinitionResponse

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

Запрос принят. Получение определения выполняется.

Заголовки

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

ErrorResponse

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

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

Примеры

Get an eventhouse definition example

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

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

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

Код состояния:
200 
{
  "definition": {
    "parts": [
      {
        "path": "EventhouseProperties.json",
        "payload": "e30=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Код состояния:
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

Определения

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

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

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

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

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

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

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

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

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

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

EventhouseDefinition

Object

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

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

string

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

EventhouseDefinitionPart[]

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

EventhouseDefinitionPart

Object

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

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

string

Путь к части события.
payload

string

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

PayloadType

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

EventhouseDefinitionResponse

Object

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

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

EventhouseDefinition

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

PayloadType

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

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

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

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