Notebook - Get Notebooks By Workspace

A jegyzetfüzetek felsorolása.

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

URI-paraméterek

Name In Required Type Description
endpoint
path True
  • string

A munkaterület-fejlesztési végpont, például: https://myworkspace.dev.azuresynapse.net .

api-version
query True
  • string

A szinapszis-ügyfél API-verziója.

Válaszok

Name Type Description
200 OK

OK gombra.

Other Status Codes

Az Azure szinapszis szolgáltatástól kapott hibaüzenet.

Példák

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"
    }
  ]
}

Definíciók

BigDataPoolReference

Nagyméretű adatkészletek referenciája.

BigDataPoolReferenceType

Nagyméretű adatkészletek hivatkozási típusa

CellOutputType

Végrehajtás, megjelenítés vagy stream kimenetek.

CloudError

Az Azure szinapszis-hiba felépítését meghatározó objektum.

Notebook

Notebook.

NotebookCell

Jegyzetfüzet-cella.

NotebookCellOutputItem

A jegyzetfüzet-cella végrehajtási kimenetének egy eleme.

NotebookKernelSpec

Kernel-információk.

NotebookLanguageInfo

Nyelvi információ.

NotebookListResponse

A notebook-erőforrások listája.

NotebookMetadata

Jegyzetfüzet gyökérszintű metaadatai.

NotebookResource

Jegyzetfüzet típusú erőforrástípus.

NotebookSessionProperties

Munkamenet tulajdonságai

BigDataPoolReference

Nagyméretű adatkészletek referenciája.

Name Type Description
referenceName
  • string

Hivatkozás big data a készlet neve.

type

Nagyméretű adatkészletek hivatkozási típusa

BigDataPoolReferenceType

Nagyméretű adatkészletek hivatkozási típusa

Name Type Description
BigDataPoolReference
  • string

CellOutputType

Végrehajtás, megjelenítés vagy stream kimenetek.

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

CloudError

Az Azure szinapszis-hiba felépítését meghatározó objektum.

Name Type Description
error.code
  • string

Hibakód.

error.details

Tömb további hiba részleteivel.

error.message
  • string

Hibaüzenet.

error.target
  • string

A tulajdonság neve/elérési útja a hibához társítva.

Notebook

Notebook.

Name Type Description
bigDataPool

Nagyméretű adatkészletek referenciája.

cells

Az aktuális jegyzetfüzetből származó cellák tömbje.

description
  • string

A jegyzetfüzet leírása.

metadata

Jegyzetfüzet gyökérszintű metaadatai.

nbformat
  • integer

Jegyzetfüzet formátuma (fő szám). Megnövelve a jegyzetfüzet formátumának visszafelé nem kompatibilis módosításai között.

nbformat_minor
  • integer

Jegyzetfüzet formátuma (másodlagos szám). Megnövelve a notebook formátumának visszamenőlegesen kompatibilis módosításaival.

sessionProperties

Munkamenet tulajdonságai

NotebookCell

Jegyzetfüzet-cella.

Name Type Description
attachments
  • object

A cellához tartozó mellékletek.

cell_type
  • string

A cella típusát azonosító sztring.

metadata
  • object

Cella szintű metaadatok.

outputs

Cella szintű kimeneti elemek.

source
  • string[]

A cella tartalma sorok tömbje ábrázolva.

NotebookCellOutputItem

A jegyzetfüzet-cella végrehajtási kimenetének egy eleme.

Name Type Description
data
  • object

Kimeneti adatokat. Használja a MIME-típust kulcsként, a tartalmat pedig értékként.

execution_count
  • integer

Végrehajtási sorszám.

metadata
  • object

A kimeneti tétel metaadatai.

name
  • string

Output_type = stream esetében meghatározza a stream nevét (StdOut/stderr).

output_type

Végrehajtás, megjelenítés vagy stream kimenetek.

text

A output_type = stream esetében az adatfolyam szöveges kimenete karakterláncként vagy karakterláncok tömbje formájában jelenik meg.

NotebookKernelSpec

Kernel-információk.

Name Type Description
display_name
  • string

A felhasználói felületen megjelenítendő név.

name
  • string

A kernel-specifikáció neve.

NotebookLanguageInfo

Nyelvi információ.

Name Type Description
codemirror_mode
  • string

A kódban használt codemirror mód ezen a nyelven.

name
  • string

A rendszermag által futtatott programozási nyelv.

NotebookListResponse

A notebook-erőforrások listája.

Name Type Description
nextLink
  • string

Az eredmények következő oldalára mutató hivatkozás, ha a fennmaradó eredmények léteznek.

value

Jegyzetfüzetek listája.

NotebookMetadata

Jegyzetfüzet gyökérszintű metaadatai.

Name Type Description
kernelspec

Kernel-információk.

language_info

Nyelvi információ.

NotebookResource

Jegyzetfüzet típusú erőforrástípus.

Name Type Description
etag
  • string

Erőforrás-ETAG.

id
  • string

Az erőforrás teljes erőforrás-azonosítója. /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Az erőforrás neve

properties

A jegyzetfüzet tulajdonságai.

type
  • string

Az erőforrás típusa. Ex-Microsoft. számítás/virtualMachines vagy Microsoft. Storage/storageAccounts.

NotebookSessionProperties

Munkamenet tulajdonságai

Name Type Description
driverCores
  • integer

Az illesztőprogramhoz használandó magok száma.

driverMemory
  • string

Az illesztőprogram-folyamathoz használandó memória mennyisége.

executorCores
  • integer

Az egyes végrehajtók számára használandó magok száma.

executorMemory
  • string

A végrehajtó folyamat által használandó memória mennyisége.

numExecutors
  • integer

A munkamenet elindításához szükséges végrehajtók száma.