Items - Get User Data Function Definition

Usługa:: UserDataFunction

Wersja interfejsu API:: v1

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

Gdy uzyskasz publiczną definicję userDataFunction, etykieta poufności nie jest częścią definicji.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla funkcji UserDataFunction.

Wymagane zakresy delegowane

Element.Odczyt.Zapis.Wszystko

Microsoft Entra obsługiwane tożsamości

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

Tożsamość	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Nie.

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
userDataFunctionId	path	True	string (uuid)	Identyfikator UserDataFunction.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
format	query		string	Format definicji publicznej UserDataFunction.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UserDataFunctionDefinitionResponse	Żą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
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.

Przykłady

Get a UserDataFunction public definition example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "UserDataFunctionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "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.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UserDataFunctionDefinitionResponse	Odpowiedź definicji publicznej userDataFunction.
UserDataFunctionPublicDefinition	Obiekt definicji publicznej UserDataFunction. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji UserDataFunction.
UserDataFunctionPublicDefinitionPart	UserDataFunction, obiekt części definicji.

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.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
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

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.

PayloadType

Wyliczenie

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

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

UserDataFunctionDefinitionResponse

Objekt

Odpowiedź definicji publicznej userDataFunction.

Nazwa	Typ	Opis
definition	UserDataFunctionPublicDefinition	Obiekt definicji publicznej UserDataFunction. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji UserDataFunction.

UserDataFunctionPublicDefinition

Objekt

Obiekt definicji publicznej UserDataFunction. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji UserDataFunction.

Nazwa	Typ	Opis
format	string	Format definicji funkcji danych użytkownika.
parts	UserDataFunctionPublicDefinitionPart[]	Lista części definicji.

UserDataFunctionPublicDefinitionPart

Objekt

UserDataFunction, obiekt części definicji.

Nazwa	Typ	Opis
path	string	Ścieżka części definicji publicznej UserDataFunction.
payload	string	Ładunek części definicji publicznej UserDataFunction.
payloadType	PayloadType	Typ ładunku.