Items - Get Variable Library Definition

Usługa:: VariableLibrary

Wersja interfejsu API:: v1

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

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

Uprawnienia

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

Wymagane zakresy delegowane

VariableLibrary.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy 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}/variableLibraries/{variableLibraryId}/getDefinition

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
variableLibraryId	path	True	string (uuid)	Identyfikator zmiennejLibrary.
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.
format	query		string	Format definicji publicznej VariableLibrary.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	VariableLibraryDefinitionResponse	Żą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 VariableLibrary public definition example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "variables.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "valueSets/valueSet1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "settings.json",
        "payload": "eyJleGVjdXRhYmxlRm..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

Nazwisko	Opis
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
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.
VariableLibraryDefinitionResponse	Odpowiedź definicji publicznej zmiennejLibrary.
VariableLibraryPublicDefinition	Obiekt definicji publicznej VariableLibrary. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji VariableLibrary.
VariableLibraryPublicDefinitionPart	Obiekt części definicji ZmiennejLibrary.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

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

Nazwisko	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.

Nazwisko	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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
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.

Nazwisko	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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
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.

VariableLibraryDefinitionResponse

Objekt

Odpowiedź definicji publicznej zmiennejLibrary.

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

VariableLibraryPublicDefinition

Objekt

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

Nazwisko	Typ	Opis
format	string	Format definicji biblioteki zmiennych. Obsługiwany format: `VariableLibraryV1`.
parts	VariableLibraryPublicDefinitionPart[]	Lista części definicji.

VariableLibraryPublicDefinitionPart

Objekt

Obiekt części definicji ZmiennejLibrary.

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