Items - Create Notebook

Usługa:: Notebook

Wersja API:: v1

Tworzy notes w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aby utworzyć notes z definicją, zapoznaj się z artykułem Definicja notesu.

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego współautora .

Wymagane zakresy delegowane

Notebook.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć notes, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej. Aby uzyskać więcej informacji, zobacz: typy licencji usługi Microsoft Fabric.

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Tak

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana notesu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.
definition		NotebookDefinition	Definicja publiczna notesu.
description		string	Opis notesu. Maksymalna długość to 256 znaków.
folderId		string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, notes zostanie utworzony z obszarem roboczym jako jego folderem.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Notebook	Pomyślnie utworzono
202 Accepted		Żądanie zaakceptowane, aprowizacja notesu w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana. CorruptedPayload — podany ładunek jest uszkodzony. WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Nazwa

Typ

Opis

201 Created

Notebook

Pomyślnie utworzono

202 Accepted

Żądanie zaakceptowane, aprowizacja notesu w toku.

Nagłówki

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidItemType — typ elementu jest nieprawidłowy
ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana.
CorruptedPayload — podany ładunek jest uszkodzony.
WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Przykłady

Create a notebook example

Create a notebook with public definition in fabricGitSource format example

Create a notebook with public definition in ipynb format example

Create a notebook example

Przykładowa prośba

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

{
  "displayName": "Notebook 1",
  "description": "A notebook description."
}

Przykładowa odpowiedź

Kod statusu:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod statusu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a notebook with public definition in fabricGitSource format example

Przykładowa prośba

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "fabricGitSource",
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod statusu:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod statusu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a notebook with public definition in ipynb format example

Przykładowa prośba

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod statusu:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod statusu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definicje

Nazwa	Opis
CreateNotebookRequest	Utwórz ładunek żądania notesu.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemTag	Reprezentuje tag zastosowany w elemencie.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
Notebook	Obiekt notesu.
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.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

CreateNotebookRequest

Sprzeciwiać się

Utwórz ładunek żądania notesu.

Nazwa	Typ	Opis
definition	NotebookDefinition	Definicja publiczna notesu.
description	string	Opis notesu. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana notesu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.
folderId	string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, notes zostanie utworzony z obszarem roboczym jako jego folderem.

ErrorRelatedResource

Sprzeciwiać się

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

Sprzeciwiać się

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

Sprzeciwiać się

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.

ItemTag

Sprzeciwiać się

Reprezentuje tag zastosowany w elemencie.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
Report	Raport usługi Power BI.
SemanticModel	Model semantyczny usługi PowerBI.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Datamart	Datamart usługi Power BI.
Lakehouse	Jezioro.
Eventhouse	Magazyn zdarzeń.
Environment	Środowisko.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
KQLDashboard	Pulpit nawigacyjny KQL.
DataPipeline	Potok danych.
Notebook	Notes.
SparkJobDefinition	Definicja zadania platformy Spark.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
Warehouse	Magazyn.
Eventstream	Strumień zdarzeń.
SQLEndpoint	Punkt końcowy SQL.
MirroredWarehouse	Dublowany magazyn.
MirroredDatabase	Dublowana baza danych.
Reflex	Refleks.
GraphQLApi	Interfejs API dla elementu GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Baza danych SQLDatabase.
CopyJob	Zadanie kopiowania.
VariableLibrary	ZmiennaLibrary.
Dataflow	Przepływ danych.
ApacheAirflowJob	Zadanie ApacheAirflowJob.
WarehouseSnapshot	Migawka magazynu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
Map	Mapa.
AnomalyDetector	Wykrywacz anomalii.
UserDataFunction	Funkcja danych użytkownika.
GraphModel	Model programu Graph.
GraphQuerySet	Zestaw zapytań programu Graph.
SnowflakeDatabase	Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Baza danych usługi Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.

Notebook

Sprzeciwiać się

Obiekt notesu.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
folderId	string (uuid)	Identyfikator folderu.
id	string (uuid)	Identyfikator elementu.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego.

NotebookDefinition

Sprzeciwiać się

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

Sprzeciwiać się

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.

PayloadType

Wyliczenie

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

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

Udostępnij przez

Items - Create Notebook

Uprawnienia

Wymagane zakresy delegowane

Ograniczenia

Tożsamości obsługiwane przez firmę Microsoft

Interfejs

Parametry URI

Ciało żądania

Odpowiedzi

Przykłady

Create a notebook example

Przykładowa prośba

Przykładowa odpowiedź

Create a notebook with public definition in fabricGitSource format example

Przykładowa prośba

Przykładowa odpowiedź

Create a notebook with public definition in ipynb format example

Przykładowa prośba

Przykładowa odpowiedź

Definicje

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType