Items - Update Eventstream Definition

Usługa:

Eventstream

Wersja API:

v1

Aktualizuje definicję określonego strumienia zdarzeń. Aktualizacja zastępuje bieżącą definicję.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aktualizowanie definicji strumienia zdarzeń nie ma wpływu na etykietę poufności.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla strumienia zdarzeń.

Wymagane zakresy delegowane

Eventstream.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition

Z opcjonalnymi parametrami:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
eventstreamId	path	True	string (uuid)	Identyfikator strumienia zdarzeń.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
updateMetadata	query		boolean	Czy zaktualizować metadane elementu, jeśli zostały podane w .platform pliku. True — zaktualizuj metadane, jeśli są podane w pliku w .platform ramach definicji, False — nie aktualizuj metadanych.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
definition	True	EventstreamDefinition	Obiekt definicji publicznej strumienia zdarzeń.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie.
202 Accepted		Zaakceptowano żądanie. Trwa aktualizowanie definicji. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu. CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update an eventstream definition example

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:

200

Kod statusu:

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

Definicje

Nazwa	Opis
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
EventstreamDefinition	Obiekt definicji publicznej strumienia zdarzeń.
EventstreamDefinitionPart	Obiekt części definicji strumienia zdarzeń.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateEventstreamDefinitionRequest	Aktualizowanie ładunku żądania definicji publicznej strumienia zdarzeń.

ErrorRelatedResource

Sprzeciwiać się

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Sprzeciwiać się

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

EventstreamDefinition

Sprzeciwiać się

Obiekt definicji publicznej strumienia zdarzeń.

Nazwa	Typ	Opis
format	string	Format definicji elementu.
parts	EventstreamDefinitionPart[]	Lista części definicji.

EventstreamDefinitionPart

Sprzeciwiać się

Obiekt części definicji strumienia zdarzeń.

Nazwa	Typ	Opis
path	string	Ścieżka części strumienia zdarzeń.
payload	string	Ładunek części strumienia zdarzeń.
payloadType	PayloadType	Typ ładunku.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

UpdateEventstreamDefinitionRequest

Sprzeciwiać się

Aktualizowanie ładunku żądania definicji publicznej strumienia zdarzeń.

Nazwa	Typ	Opis
definition	EventstreamDefinition	Obiekt definicji publicznej strumienia zdarzeń.