Items - Get Eventstream Definition

Usługa:

Eventstream

Wersja interfejsu API:

v1

Zwraca określoną definicję publiczną strumienia zdarzeń.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Po otrzymaniu definicji publicznej strumienia zdarzeń etykieta poufności nie jest częścią definicji.

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

Ograniczenia

Ten interfejs API jest blokowany dla strumienia zdarzeń z zaszyfrowaną etykietą poufności.

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}/getDefinition

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
eventstreamId	path	True	string (uuid)	Identyfikator strumienia zdarzeń.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
format	query		string	Format definicji publicznej strumienia zdarzeń.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EventstreamDefinitionResponse	Żądanie zostało ukończone pomyślnie.
202 Accepted		Zaakceptowano żądanie. Pobieranie definicji jest w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get an eventstream definition example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

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ń.
EventstreamDefinitionResponse	Odpowiedź na publiczną definicję strumienia zdarzeń.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

ErrorRelatedResource

Objekt

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

Objekt

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	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

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

Objekt

Obiekt definicji publicznej strumienia zdarzeń.

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

EventstreamDefinitionPart

Objekt

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.

EventstreamDefinitionResponse

Objekt

Odpowiedź na publiczną definicję strumienia zdarzeń.

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

PayloadType

Wyliczanie

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

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