Notebook - Get Notebooks By Workspace

Odwołanie

Service:: Synapse

API Version:: 2020-12-01

Listy Notesy.

GET {endpoint}/notebooks?api-version=2020-12-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy programowania obszaru roboczego, na przykład `https://myworkspace.dev.azuresynapse.net`.
api-version	query	True	string	Wersja interfejsu API klienta usługi Synapse.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NotebookListResponse	OK.
Other Status Codes	CloudError	Odpowiedź o błędzie odebrana z usługi Azure Synapse.

Przykłady

Notebooks_ListByWorkspace

Sample Request

HTTP

GET exampleWorkspace.dev.azuresynapse.net/notebooks?api-version=2020-12-01

Sample Response

Status code:: 200

Date: Sat, 16 Jun 2018 00:37:41 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
x-ms-correlation-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264

Response Body

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
      "name": "exampleNotebook",
      "type": "Microsoft.Synapse/workspaces/Notebooks",
      "properties": {
        "description": "A sample Notebook",
        "nbformat": 4,
        "nbformat_minor": 2,
        "bigDataPool": {
          "referenceName": "exampleBigDataPoolName",
          "type": "BigDataPoolReference"
        },
        "sessionProperties": {
          "driverMemory": "28g",
          "driverCores": 4,
          "executorMemory": "28g",
          "executorCores": 4,
          "numExecutors": 1
        },
        "metadata": {
          "language_info": {
            "name": "python"
          },
          "kernelspec": {
            "name": "exampleName",
            "display_name": "exampleDisplayName"
          }
        },
        "cells": [
          {
            "cell_type": "code",
            "metadata": {},
            "source": [
              "def my_function():\n",
              " print(\"Hello from a function\")\n",
              "\n",
              "my_function()"
            ],
            "attachments": {},
            "outputs": [
              {
                "execution_count": 3,
                "output_type": "execute_result",
                "data": {
                  "text/plain": "Hello from a function"
                },
                "metadata": {}
              }
            ]
          }
        ]
      },
      "etag": "1500504f-0000-0200-0000-5cbe090f0000"
    }
  ]
}

Definicje

Nazwa	Opis
BigDataPoolReference	Dokumentacja puli danych big data.
BigDataPoolReferenceType	Typ odwołania puli danych big data.
CellOutputType	Wykonywanie, wyświetlanie lub przesyłanie strumieniowe danych wyjściowych.
CloudError	Obiekt, który definiuje strukturę odpowiedzi Azure Synapse błędu.
Folder	Folder, w ramach którego znajduje się ten notes. Jeśli nie zostanie określony, ten notes będzie wyświetlany na poziomie głównym.
Notebook	Notebook.
NotebookCell	Komórka notesu.
NotebookCellOutputItem	Element danych wyjściowych wykonywania komórki notesu.
NotebookKernelSpec	Informacje o jądrze.
NotebookLanguageInfo	Informacje o języku.
NotebookListResponse	Lista zasobów notesu.
NotebookMetadata	Metadane na poziomie głównym notesu.
NotebookResource	Typ zasobu notesu.
NotebookSessionProperties	Właściwości sesji.
SparkConfigurationReference	Dokumentacja konfiguracji platformy Spark.
SparkConfigurationReferenceType	Typ odniesienia konfiguracji platformy Spark.

BigDataPoolReference

Dokumentacja puli danych big data.

Nazwa	Typ	Opis
referenceName	string	Odwołanie do nazwy puli danych big data.
type	BigDataPoolReferenceType	Typ odwołania puli danych big data.

BigDataPoolReferenceType

Typ odwołania puli danych big data.

Nazwa	Typ	Opis
BigDataPoolReference	string

CellOutputType

Wykonywanie, wyświetlanie lub przesyłanie strumieniowe danych wyjściowych.

Nazwa	Typ	Opis
display_data	string
error	string
execute_result	string
stream	string

CloudError

Obiekt, który definiuje strukturę odpowiedzi Azure Synapse błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudError[]	Tablica z dodatkowymi szczegółami błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Nazwa/ścieżka właściwości w żądaniu skojarzonym z błędem.

Folder

Folder, w ramach którego znajduje się ten notes. Jeśli nie zostanie określony, ten notes będzie wyświetlany na poziomie głównym.

Nazwa	Typ	Opis
name	string	Nazwa folderu, w ramach którego znajduje się ten notes.

Notebook

Notebook.

Nazwa	Typ	Opis
bigDataPool	BigDataPoolReference	Dokumentacja puli danych big data.
cells	NotebookCell[]	Tablica komórek bieżącego notesu.
description	string	Opis notesu.
folder	Folder	Folder, w ramach którego znajduje się ten notes. Jeśli nie zostanie określony, ten notes będzie wyświetlany na poziomie głównym.
metadata	NotebookMetadata	Metadane na poziomie głównym notesu.
nbformat	integer	Format notesu (numer główny). Przyrostowy między poprzednimi niezgodnymi zmianami w formacie notesu.
nbformat_minor	integer	Format notesu (liczba pomocnicza). Przyrostowe zmiany w formacie notesu zgodne z poprzednimi wersjami.
sessionProperties	NotebookSessionProperties	Właściwości sesji.
targetSparkConfiguration	SparkConfigurationReference	Konfiguracja platformy Spark zadania platformy Spark.

NotebookCell

Komórka notesu.

Nazwa	Typ	Opis
attachments	object	Załączniki skojarzone z komórką.
cell_type	string	Ciąg identyfikujący typ komórki.
metadata	object	Metadane na poziomie komórki.
outputs	NotebookCellOutputItem[]	Elementy wyjściowe na poziomie komórki.
source	string[]	Zawartość komórki reprezentowana jako tablica wierszy.

NotebookCellOutputItem

Element danych wyjściowych wykonywania komórki notesu.

Nazwa	Typ	Opis
data	object	Dane wyjściowe. Użyj typu MIME jako klucza i zawartości jako wartości.
execution_count	integer	Numer sekwencji wykonywania.
metadata	object	Metadane elementu wyjściowego.
name	string	W przypadku output_type=stream określa nazwę strumienia (stdout / stderr).
output_type	CellOutputType	Wykonywanie, wyświetlanie lub przesyłanie strumieniowe danych wyjściowych.
text		W przypadku output_type=stream dane wyjściowe tekstu strumienia reprezentowane jako ciąg lub tablica ciągów.

NotebookKernelSpec

Informacje o jądrze.

Nazwa	Typ	Opis
display_name	string	Nazwa wyświetlana w interfejsie użytkownika.
name	string	Nazwa specyfikacji jądra.

NotebookLanguageInfo

Informacje o języku.

Nazwa	Typ	Opis
codemirror_mode	string	Tryb codemirror do użycia dla kodu w tym języku.
name	string	Język programowania uruchamiany przez to jądro.

NotebookListResponse

Lista zasobów notesu.

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony wyników, jeśli istnieją jakiekolwiek pozostałe wyniki.
value	NotebookResource[]	Lista notesów.

NotebookMetadata

Metadane na poziomie głównym notesu.

Nazwa	Typ	Opis
kernelspec	NotebookKernelSpec	Informacje o jądrze.
language_info	NotebookLanguageInfo	Informacje o języku.

NotebookResource

Typ zasobu notesu.

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	Notebook	Właściwości notesu.
type	string	Typ zasobu. Ex- Microsoft.Compute/virtualMachines lub Microsoft.Storage/storageAccounts.

NotebookSessionProperties

Właściwości sesji.

Nazwa	Typ	Opis
driverCores	integer	Liczba rdzeni do użycia dla sterownika.
driverMemory	string	Ilość pamięci do użycia w procesie sterownika.
executorCores	integer	Liczba rdzeni do użycia dla każdego modułu wykonawczego.
executorMemory	string	Ilość pamięci do użycia na proces wykonawcy.
numExecutors	integer	Liczba funkcji wykonawczych do uruchomienia dla tej sesji.

SparkConfigurationReference

Dokumentacja konfiguracji platformy Spark.

Nazwa	Typ	Opis
referenceName	string	Odwołanie do nazwy konfiguracji platformy Spark.
type	SparkConfigurationReferenceType	Typ odniesienia konfiguracji platformy Spark.

SparkConfigurationReferenceType

Typ odniesienia konfiguracji platformy Spark.

Nazwa	Typ	Opis
SparkConfigurationReference	string