Compartilhar via

Items - Get Eventstream Definition

Serviço:
Eventstream
Versão da API:
v1

Retorna a definição pública de fluxo de eventos especificada.
Essa API dá suporte a LRO (operações de execução longa).

Quando você obtém uma definição pública eventstream, o rótulo de confidencialidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para o fluxo de eventos.

Escopos delegados necessários

Eventstream.ReadWrite.All ou Item.ReadWrite.All

Limitações

Essa API é bloqueada para um fluxo de eventos com um rótulo de confidencialidade criptografado.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades gerenciadas Sim

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
eventstreamId
 path True

string (uuid)

A ID do fluxo de eventos.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.
format
 query

string

O formato da definição pública do eventstream.

Respostas

Nome Tipo Description
200 OK

EventstreamDefinitionResponse

Solicitação concluída com êxito.
202 Accepted

Solicitação aceita. A recuperação da definição está em andamento.

Cabeçalhos

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

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem – Operação sem suporte para o item solicitado.

Exemplos

Get an eventstream definition example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
      }
    ]
  }
}
Código de status:
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

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
EventstreamDefinition

Objeto de definição pública eventstream.
EventstreamDefinitionPart

Objeto de parte de definição eventstream.
EventstreamDefinitionResponse

Resposta de definição pública eventstream.
PayloadType

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

EventstreamDefinition

Objeto

Objeto de definição pública eventstream.

Nome Tipo Description
format

string

O formato da definição do item.
parts

EventstreamDefinitionPart[]

Uma lista de partes de definição.

EventstreamDefinitionPart

Objeto

Objeto de parte de definição eventstream.

Nome Tipo Description
path

string

O caminho da parte do fluxo de eventos.
payload

string

O conteúdo da parte eventstream part.
payloadType

PayloadType

O tipo de conteúdo.

EventstreamDefinitionResponse

Objeto

Resposta de definição pública eventstream.

Nome Tipo Description
definition

EventstreamDefinition

Objeto de definição pública eventstream.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor Description
InlineBase64

Base 64 embutida.