Compartilhar via

Items - Update Eventstream Definition

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

Atualiza a definição de um fluxo de eventos especificado. A atualização substitui a definição atual.
Essa API dá suporte a LRO (operações de execução longa).

Atualizar a definição de fluxo de eventos não afeta seu rótulo de confidencialidade.

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

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}/updateDefinition
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

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.
updateMetadata
 query

boolean

Se os metadados do item serão atualizados se forem fornecidos no .platform arquivo. True - Atualize os metadados se ele for fornecido no .platform arquivo como parte da definição, False – Não atualize os metadados.

Corpo da solicitação

Nome Obrigatório Tipo Description
definition True

EventstreamDefinition

Objeto de definição pública eventstream.

Respostas

Nome Tipo Description
200 OK

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

Solicitação aceita. A definição de atualizaçã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.

  • CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Update an eventstream definition example

Solicitação de exemplo

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"
      }
    ]
  }
}

Resposta de exemplo

Código de status:
200
Código de status:
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

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.
PayloadType

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

Atualizar o conteúdo da solicitação de definição pública eventstream.

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.

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.

UpdateEventstreamDefinitionRequest

Objeto

Atualizar o conteúdo da solicitação de definição pública eventstream.

Nome Tipo Description
definition

EventstreamDefinition

Objeto de definição pública eventstream.