Udostępnij przez

Items - Get Notebook Definition

Usługa:
Notebook
Wersja interfejsu API:
v1

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

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

Uprawnienia

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

Wymagane zakresy delegowane

Notebook.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Ten interfejs API jest blokowany dla notesu 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}/notebooks/{notebookId}/getDefinition
Z parametrami opcjonalnymi: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
notebookId
 path True

string (uuid)

Identyfikator notesu.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
format
 query

string

Format definicji publicznej notesu. Obsługiwany format: ipynb i fabricGitSource. Jeśli nie podano żadnego formatu, fabricGitSource jest używany.

Odpowiedzi

Nazwa Typ Opis
200 OK

NotebookDefinitionResponse

Żą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 a notebook definition in fabricGitSource format example
Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "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

Get a notebook definition in ipynb format example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "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.
NotebookDefinition

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

Obiekt części definicji notesu.
NotebookDefinitionResponse

Odpowiedź na publiczną definicję notesu.
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.

NotebookDefinition

Objekt

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

Nazwa Typ Opis
format

string

Format definicji notesu. Obsługiwany format: ipynb i fabricGitSource. Jeśli nie podano żadnego formatu, fabricGitSource jest używany.
parts

NotebookDefinitionPart[]

Lista części definicji.

NotebookDefinitionPart

Objekt

Obiekt części definicji notesu.

Nazwa Typ Opis
path

string

Ścieżka części notesu. Obsługiwane rozszerzenia zawartości notesu: .ipynb dla ipynb formatu; .py, .scala, .r, .sql dla fabricGitSource formatu.
payload

string

Ładunek części notesu.
payloadType

PayloadType

Typ ładunku.

NotebookDefinitionResponse

Objekt

Odpowiedź na publiczną definicję notesu.

Nazwa Typ Opis
definition

NotebookDefinition

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

PayloadType

Wyliczanie

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

Wartość Opis
InlineBase64

Śródliniowa baza 64.