Notebook - Get Notebooks By Workspace

Wyświetla listę notesów.

GET {endpoint}/notebooks?api-version=2019-06-01-preview

Parametry identyfikatora URI

Name In Required Type Description
endpoint
path True
  • string

Na przykład punkt końcowy tworzenia obszaru roboczego https://myworkspace.dev.azuresynapse.net .

api-version
query True
  • string

Wersja interfejsu API klienta Synapse.

Odpowiedzi

Name Type Description
200 OK

OK.

Other Status Codes

Odebrano odpowiedź na błąd z usługi Azure Synapse.

Przykłady

Notebooks_ListByWorkspace

Sample Request

GET exampleWorkspace.dev.azuresynapse.net/notebooks?api-version=2019-06-01-preview

Sample Response

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
{
  "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

BigDataPoolReference

Odwołanie do puli danych Big Data.

BigDataPoolReferenceType

Typ odwołania do puli danych Big Data.

CellOutputType

Wyniki wykonywania, wyświetlania lub przesyłania strumieniowego.

CloudError

Obiekt definiujący strukturę odpowiedzi na błąd usługi Azure Synapse.

Notebook

Notesu.

NotebookCell

Komórka notesu.

NotebookCellOutputItem

Element danych wyjściowych wykonania komórki notesu.

NotebookKernelSpec

Informacje o jądrze.

NotebookLanguageInfo

Informacje o języku.

NotebookListResponse

Lista zasobów notesu.

NotebookMetadata

Metadane poziomu głównego notesu.

NotebookResource

Typ zasobu notesu.

NotebookSessionProperties

Właściwości sesji.

BigDataPoolReference

Odwołanie do puli danych Big Data.

Name Type Description
referenceName
  • string

Nazwa puli danych Big Data.

type

Typ odwołania do puli danych Big Data.

BigDataPoolReferenceType

Typ odwołania do puli danych Big Data.

Name Type Description
BigDataPoolReference
  • string

CellOutputType

Wyniki wykonywania, wyświetlania lub przesyłania strumieniowego.

Name Type Description
display_data
  • string
error
  • string
execute_result
  • string
stream
  • string

CloudError

Obiekt definiujący strukturę odpowiedzi na błąd usługi Azure Synapse.

Name Type Description
error.code
  • string

Kod błędu.

error.details

Tablica z dodatkowymi szczegółami błędu.

error.message
  • string

Komunikat o błędzie.

error.target
  • string

Nazwa właściwości/ścieżka w żądaniu skojarzona z błędem.

Notebook

Notesu.

Name Type Description
bigDataPool

Odwołanie do puli danych Big Data.

cells

Tablica komórek bieżącego notesu.

description
  • string

Opis notesu.

metadata

Metadane poziomu głównego notesu.

nbformat
  • integer

Format notesu (numer główny). Zwiększa się między wstecz niezgodne zmiany w formacie notesu.

nbformat_minor
  • integer

Format notesu (numer pomocniczy). Zwiększa się w celu zapewnienia zgodności z poprzednimi wersjami w formacie notesu.

sessionProperties

Właściwości sesji.

NotebookCell

Komórka notesu.

Name Type Description
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

Elementy wyjściowe na poziomie komórki.

source
  • string[]

Zawartość komórki reprezentowana jako tablica wierszy.

NotebookCellOutputItem

Element danych wyjściowych wykonania komórki notesu.

Name Type Description
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 dla elementu danych wyjściowych.

name
  • string

Dla output_type = Stream określa nazwę strumienia (stdout/stderr).

output_type

Wyniki wykonywania, wyświetlania lub przesyłania strumieniowego.

text

Dla output_type = Stream, wyjście tekstu strumienia, reprezentowane jako ciąg lub tablica ciągów.

NotebookKernelSpec

Informacje o jądrze.

Name Type Description
display_name
  • string

Nazwa, która ma być wyświetlana w interfejsie użytkownika.

name
  • string

Nazwa specyfikacji jądra.

NotebookLanguageInfo

Informacje o języku.

Name Type Description
codemirror_mode
  • string

Tryb codemirror, który ma być używany dla kodu w tym języku.

name
  • string

Język programowania, w którym działa to jądro.

NotebookListResponse

Lista zasobów notesu.

Name Type Description
nextLink
  • string

Łącze do następnej strony wyników, jeśli istnieją wszystkie pozostałe wyniki.

value

Lista notesów.

NotebookMetadata

Metadane poziomu głównego notesu.

Name Type Description
kernelspec

Informacje o jądrze.

language_info

Informacje o języku.

NotebookResource

Typ zasobu notesu.

Name Type Description
etag
  • string

Element ETag zasobu.

id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu. /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nazwa zasobu

properties

Właściwości notesu.

type
  • string

Typ zasobu. Ex-Microsoft. COMPUTE/virtualMachines lub Microsoft. Storage/storageAccounts.

NotebookSessionProperties

Właściwości sesji.

Name Type Description
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 wykonawcy.

executorMemory
  • string

Ilość pamięci do użycia na proces wykonawczy.

numExecutors
  • integer

Liczba uruchomień do uruchomienia dla tej sesji.