Notebook - Get Notebooks By Workspace

Not defterlerini listeler.

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

URI Parametreleri

Name In Required Type Description
endpoint
path True
  • string

Örneğin, çalışma alanı geliştirme uç noktası https://myworkspace.dev.azuresynapse.net .

api-version
query True
  • string

SYNAPSE istemci API sürümü.

Yanıtlar

Name Type Description
200 OK

Tamam ögesini seçin.

Other Status Codes

Azure SYNAPSE hizmetinden alınan bir hata yanıtı.

Örnekler

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

Tanımlar

BigDataPoolReference

Büyük veri havuzu başvurusu.

BigDataPoolReferenceType

Büyük veri havuzu başvuru türü.

CellOutputType

Yürütme, görüntüleme veya akış çıktıları.

CloudError

Bir Azure SYNAPSE hata yanıtının yapısını tanımlayan nesne.

Notebook

Mini.

NotebookCell

Not defteri hücresi.

NotebookCellOutputItem

Not defteri hücresi yürütme çıkışının bir öğesi.

NotebookKernelSpec

Çekirdek bilgileri.

NotebookLanguageInfo

Dil bilgisi.

NotebookListResponse

Not defteri kaynaklarının listesi.

NotebookMetadata

Not defteri kök düzeyi meta verileri.

NotebookResource

Not defteri kaynak türü.

NotebookSessionProperties

Oturum özellikleri.

BigDataPoolReference

Büyük veri havuzu başvurusu.

Name Type Description
referenceName
  • string

Başvuru büyük veri havuzu adı.

type

Büyük veri havuzu başvuru türü.

BigDataPoolReferenceType

Büyük veri havuzu başvuru türü.

Name Type Description
BigDataPoolReference
  • string

CellOutputType

Yürütme, görüntüleme veya akış çıktıları.

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

CloudError

Bir Azure SYNAPSE hata yanıtının yapısını tanımlayan nesne.

Name Type Description
error.code
  • string

Hata kodu.

error.details

Ek hata ayrıntılarına sahip dizi.

error.message
  • string

Hata iletisi.

error.target
  • string

İstekteki Özellik adı/yolu hatayla ilişkili.

Notebook

Mini.

Name Type Description
bigDataPool

Büyük veri havuzu başvurusu.

cells

Geçerli not defterinin hücre dizisi.

description
  • string

Not defterinin açıklaması.

metadata

Not defteri kök düzeyi meta verileri.

nbformat
  • integer

Not defteri biçimi (ana sayı). Geriye doğru uyumsuz değişiklikler not defteri biçiminde artırılır.

nbformat_minor
  • integer

Not defteri biçimi (küçük sayı). Not defteri biçiminde geriye dönük uyumlu değişiklikler için artırılır.

sessionProperties

Oturum özellikleri.

NotebookCell

Not defteri hücresi.

Name Type Description
attachments
  • object

Hücreyle ilişkili ekler.

cell_type
  • string

Hücrenin türünü tanımlayan dize.

metadata
  • object

Hücre düzeyinde meta veriler.

outputs

Hücre düzeyinde çıkış öğeleri.

source
  • string[]

Hücrenin, satır dizisi olarak temsil edilen içeriği.

NotebookCellOutputItem

Not defteri hücresi yürütme çıkışının bir öğesi.

Name Type Description
data
  • object

Çıkış verileri. Anahtar olarak MIME türü ve değer olarak içerik kullanın.

execution_count
  • integer

Yürütme sıra numarası.

metadata
  • object

Çıkış öğesi için meta veriler.

name
  • string

Output_type = Stream için akışın adını (stdout/stderr) belirler.

output_type

Yürütme, görüntüleme veya akış çıktıları.

text

Output_type = Stream için, akışın metin çıktısı, dize veya dize dizisi olarak gösterilir.

NotebookKernelSpec

Çekirdek bilgileri.

Name Type Description
display_name
  • string

Kullanıcı arabiriminde görüntülenecek ad.

name
  • string

Çekirdek belirtiminin adı.

NotebookLanguageInfo

Dil bilgisi.

Name Type Description
codemirror_mode
  • string

Bu dildeki kod için kullanılacak CodeMirror modu.

name
  • string

Bu çekirdeğin çalıştığı programlama dili.

NotebookListResponse

Not defteri kaynaklarının listesi.

Name Type Description
nextLink
  • string

Kalan sonuçlar varsa, sonraki sonuç sayfasına olan bağlantı.

value

Not Defterleri listesi.

NotebookMetadata

Not defteri kök düzeyi meta verileri.

Name Type Description
kernelspec

Çekirdek bilgileri.

language_info

Dil bilgisi.

NotebookResource

Not defteri kaynak türü.

Name Type Description
etag
  • string

Kaynak ETag 'i.

id
  • string

Kaynak için tam kaynak kimliği. EX-/Subscriptions/{SubscriptionID}/ResourceGroups/{resourcegroupname}/Providers/{resourceprovidernamespace}/{resourcettypeınfo}/{resourceName}

name
  • string

Kaynağın adı

properties

Not defteri özellikleri.

type
  • string

Kaynağın türü. EX-Microsoft. COMPUTE/virtualMachines veya Microsoft. Storage/storageAccounts.

NotebookSessionProperties

Oturum özellikleri.

Name Type Description
driverCores
  • integer

Sürücü için kullanılacak çekirdek sayısı.

driverMemory
  • string

Sürücü işlemi için kullanılacak bellek miktarı.

executorCores
  • integer

Her yürütücü için kullanılacak çekirdek sayısı.

executorMemory
  • string

Yürütücü işlemi başına kullanılacak bellek miktarı.

numExecutors
  • integer

Bu oturum için başlatılacak yürüticilerinin sayısı.