Items - Get Eventhouse Definition

Servicio:

Eventhouse

Versión de la API:

v1

Devuelve la definición pública del centro de eventos especificado.
Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el centro de eventos.

Ámbitos delegados necesarios

Eventhouse.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses/{eventhouseId}/getDefinition

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
eventhouseId	path	True	string (uuid)	Identificador del centro de eventos.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
format	query		string	Formato de la definición pública del centro de eventos.

Respuestas

Nombre	Tipo	Description
200 OK	EventhouseDefinitionResponse	Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La recuperación de la definición está en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: OperationNotSupportedForItem: no se admite la operación para el elemento solicitado.

Ejemplos

Get an eventhouse definition example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "definition": {
    "parts": [
      {
        "path": "EventhouseProperties.json",
        "payload": "e30=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

status code:

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

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
EventhouseDefinition	Objeto de definición pública del centro de eventos.
EventhouseDefinitionPart	Objeto de parte de definición del centro de eventos.
EventhouseDefinitionResponse	Respuesta de definición pública del centro de eventos.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

EventhouseDefinition

Object

Objeto de definición pública del centro de eventos.

Nombre	Tipo	Description
format	string	Formato de la definición de elemento.
parts	EventhouseDefinitionPart[]	Lista de elementos de definición.

EventhouseDefinitionPart

Object

Objeto de parte de definición del centro de eventos.

Nombre	Tipo	Description
path	string	Ruta de acceso de la parte del centro de eventos.
payload	string	Carga útil de la parte del centro de eventos.
payloadType	PayloadType	Tipo de carga.

EventhouseDefinitionResponse

Object

Respuesta de definición pública del centro de eventos.

Nombre	Tipo	Description
definition	EventhouseDefinition	Objeto de definición pública del centro de eventos.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.