Čitajte na engleskom Uređivanje

Dijeli putem

Items - Create Notebook

  • Reference
Service:
Notebook
API Version:
v1

Creates a notebook in the specified workspace.
This API supports long running operations (LRO).

To create notebook with definition, refer to Notebook definition article.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

Notebook.ReadWrite.All or Item.ReadWrite.All

Limitations

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
displayName True

string

The notebook display name. The display name must follow naming rules according to item type.
definition

NotebookDefinition

The notebook public definition.
description

string

The notebook description. Maximum length is 256 characters.

Responses

Name Type Description
201 Created

Notebook

Successfully created
202 Accepted

Request accepted, notebook provisioning in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid

  • ItemDisplayNameAlreadyInUse - Item display name is already used.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Sample request

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

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

Sample response

Status code:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Status code:
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 example

Sample request

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.py",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Status code:
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

Definitions

Name Description
CreateNotebookRequest

Create notebook request payload.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemType

The type of the item. Additional item types may be added over time.
Notebook

A notebook object.
NotebookDefinition

Notebook public definition object. Refer to this article for more details on how to craft a notebook public definition.
NotebookDefinitionPart

Notebook definition part object.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.

CreateNotebookRequest

Object

Create notebook request payload.

Name Type Description
definition

NotebookDefinition

The notebook public definition.
description

string

The notebook description. Maximum length is 256 characters.
displayName

string

The notebook display name. The display name must follow naming rules according to item type.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value Description
CopyJob

A Copy job.
Dashboard

PowerBI dashboard.
DataPipeline

A data pipeline.
Datamart

PowerBI datamart.
Environment

An environment.
Eventhouse

An eventhouse.
Eventstream

An eventstream.
GraphQLApi

An API for GraphQL item.
KQLDashboard

A KQL dashboard.
KQLDatabase

A KQL database.
KQLQueryset

A KQL queryset.
Lakehouse

A lakehouse.
MLExperiment

A machine learning experiment.
MLModel

A machine learning model.
MirroredDatabase

A mirrored database.
MirroredWarehouse

A mirrored warehouse.
MountedDataFactory

A MountedDataFactory.
Notebook

A notebook.
PaginatedReport

PowerBI paginated report.
Reflex

A Reflex.
Report

PowerBI report.
SQLDatabase

A SQLDatabase.
SQLEndpoint

An SQL endpoint.
SemanticModel

PowerBI semantic model.
SparkJobDefinition

A spark job definition.
Warehouse

A warehouse.

Notebook

Object

A notebook object.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
folderId

string (uuid)

The folder ID.
id

string (uuid)

The item ID.
type

ItemType

The item type.
workspaceId

string (uuid)

The workspace ID.

NotebookDefinition

Object

Notebook public definition object. Refer to this article for more details on how to craft a notebook public definition.

Name Type Description
format

string

The format of the Notebook definition. Supported format: ipynb.
parts

NotebookDefinitionPart[]

A list of definition parts.

NotebookDefinitionPart

Object

Notebook definition part object.

Name Type Description
path

string

The notebook part path.
payload

string

The notebook part payload.
payloadType

PayloadType

The payload type.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value Description
InlineBase64

Inline Base 64.