Partilhar 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.
Esta API suporta operações de longa duração (LRO).

A atualização da definição de fluxo de eventos não afeta seu rótulo de sensibilidade.

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 suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

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

Interfaz

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 do URI

Name Em Necessário Tipo Description
eventstreamId
 path True

string (uuid)

A ID do fluxo de eventos.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
updateMetadata
 query

boolean

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

Corpo do Pedido

Name Necessário Tipo Description
definition True

EventstreamDefinition

Objeto de definição pública de fluxo de eventos.

Respostas

Name Tipo Description
200 OK

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. 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 não suportada para o item solicitado.

  • CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Update an eventstream definition example

Pedido de amostra

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 da amostra

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

Name 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 de fluxo de eventos.
EventstreamDefinitionPart

Objeto de parte de definição de fluxo de eventos.
PayloadType

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
UpdateEventstreamDefinitionRequest

Atualize a carga útil da solicitação de definição pública do fluxo de eventos.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

EventstreamDefinition

Object

Objeto de definição pública de fluxo de eventos.

Name Tipo Description
format

string

O formato da definição do item.
parts

EventstreamDefinitionPart[]

Uma lista de partes de definição.

EventstreamDefinitionPart

Object

Objeto de parte de definição de fluxo de eventos.

Name Tipo Description
path

string

O caminho da parte do fluxo de eventos.
payload

string

A carga útil da parte do fluxo de eventos.
payloadType

PayloadType

O tipo de carga útil.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.

UpdateEventstreamDefinitionRequest

Object

Atualize a carga útil da solicitação de definição pública do fluxo de eventos.

Name Tipo Description
definition

EventstreamDefinition

Objeto de definição pública de fluxo de eventos.