Udostępnij przez

Items - Get Eventhouse Definition

Usługa:
Eventhouse
Wersja interfejsu API:
v1

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

Uprawnienia

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

Wymagane zakresy delegowane

Eventhouse.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}/eventhouses/{eventhouseId}/getDefinition
Z parametrami opcjonalnymi: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventhouses/{eventhouseId}/getDefinition?format={format}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
eventhouseId
 path True

string (uuid)

Identyfikator magazynu zdarzeń.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
format
 query

string

Format definicji publicznej magazynu zdarzeń.

Odpowiedzi

Nazwa Typ Opis
200 OK

EventhouseDefinitionResponse

Żą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 eventhouse definition example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventhouses/5b218778-e7a5-4d73-8187-f10824047715/getDefinition

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "EventhouseProperties.json",
        "payload": "e30=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
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.
EventhouseDefinition

Obiekt definicji publicznej usługi Eventhouse.
EventhouseDefinitionPart

Obiekt części definicji usługi Eventhouse.
EventhouseDefinitionResponse

Odpowiedź na publiczną definicję usługi Eventhouse.
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.

EventhouseDefinition

Objekt

Obiekt definicji publicznej usługi Eventhouse.

Nazwa Typ Opis
format

string

Format definicji elementu.
parts

EventhouseDefinitionPart[]

Lista części definicji.

EventhouseDefinitionPart

Objekt

Obiekt części definicji usługi Eventhouse.

Nazwa Typ Opis
path

string

Ścieżka części magazynu zdarzeń.
payload

string

Ładunek części magazynu zdarzeń.
payloadType

PayloadType

Typ ładunku.

EventhouseDefinitionResponse

Objekt

Odpowiedź na publiczną definicję usługi Eventhouse.

Nazwa Typ Opis
definition

EventhouseDefinition

Obiekt definicji publicznej usługi Eventhouse.

PayloadType

Wyliczanie

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

Wartość Opis
InlineBase64

Śródliniowa baza 64.