Items - Get Warehouse Definition

Usługa:: Warehouse

Wersja interfejsu API:: v1

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

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

Permissions

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

Wymagane zakresy delegowane

Warehouse.ReadWrite.All lub Item.ReadWrite.All

Limitations

Aby pobrać definicję elementu magazynu chronionego przez zaszyfrowaną etykietę poufności, obiekt wywołujący musi mieć wystarczające prawa użytkowania, aby usunąć etykietę zgodnie z konfiguracją w Microsoft Purview.

Tożsamości obsługiwane przez Microsoft Entra

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

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/getDefinition

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
warehouseId	path	True	string (uuid)	Identyfikator magazynu.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
format	query		WarehouseDefinitionFormat	Format definicji publicznej magazynu. Obsługiwane formaty: `dacpac` i `sqlproj`. Jeśli nie podano żadnego formatu, `sqlproj` jest używany. Dodatkowe formaty definicji magazynu mogą być dodawane w czasie.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	WarehouseDefinitionResponse	Żą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 warehouse public definition in DACPAC format example

Get a warehouse public definition in SQL project format example

Get a warehouse public definition in DACPAC format example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
        "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

Get a warehouse public definition in SQL project format example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "sqldw.sqlproj",
        "payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dbo/Tables/Table1.sql",
        "payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".sharedqueries/query.sql",
        "payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
        "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

Nazwisko	Opis
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym 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.
WarehouseDefinition	Obiekt definicji publicznej magazynu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji magazynu.
WarehouseDefinitionFormat	Format definicji publicznej magazynu. Obsługiwane formaty: `dacpac` i `sqlproj`. Jeśli nie podano żadnego formatu, `sqlproj` jest używany. Dodatkowe formaty definicji magazynu mogą być dodawane w czasie.
WarehouseDefinitionPart	Obiekt części definicji magazynu.
WarehouseDefinitionResponse	Odpowiedź definicji publicznej magazynu.

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ółowych informacji o zasobie związanym z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

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.

WarehouseDefinition

Objekt

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

Nazwisko	Typ	Opis
format	string	Format definicji magazynu. Obsługiwane formaty: `dacpac` i `sqlproj`. Jeśli nie podano żadnego formatu, `sqlproj` jest używany.
parts	WarehouseDefinitionPart[]	Lista części definicji.

WarehouseDefinitionFormat

Wyliczenie

Format definicji publicznej magazynu. Obsługiwane formaty: dacpac i sqlproj. Jeśli nie podano żadnego formatu, sqlproj jest używany. Dodatkowe formaty definicji magazynu mogą być dodawane w czasie.

Wartość	Opis
dacpac	Definicja magazynu w formacie DACPAC.
sqlproj	Definicja magazynu w formacie projektu SQL.

WarehouseDefinitionPart

Objekt

Obiekt części definicji magazynu.

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

WarehouseDefinitionResponse

Objekt

Odpowiedź definicji publicznej magazynu.

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