Items - Create Notebook

Referência

Serviço:: Notebook

Versão da API:: v1

Cria um bloco de anotações no espaço de trabalho especificado.
Esta API suporta operações de longa duração (LRO).

Para criar um bloco de notas com definição, consulte artigo Definição Bloco de Notas.

Permissões

O chamador deve ter função de colaborador ou superior do espaço de trabalho.

Escopos delegados necessários

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um bloco de anotações, o espaço de trabalho deve estar em uma capacidade de malha suportada. Para obter mais informações, consulte: Tipos de licença do Microsoft Fabric.

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string uuid	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string	O nome de exibição do bloco de anotações. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
definition		NotebookDefinition	A definição pública do caderno.
description		string	A descrição do caderno. O comprimento máximo é de 256 caracteres.

Respostas

Name	Tipo	Description
201 Created	Notebook	Criado com sucesso
202 Accepted		Pedido aceite, provisionamento de caderno em curso. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType - O tipo de item é inválido ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado. CorruptedPayload - A carga fornecida está corrompida.

Name

Tipo

Description

201 Created

Notebook

Criado com sucesso

202 Accepted

Pedido aceite, provisionamento de caderno em curso.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType - O tipo de item é inválido
ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado.
CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 201

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

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 201

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

Código de estado:: 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

Definições

Name	Description
CreateNotebookRequest	Crie carga útil de solicitação de bloco de anotações.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
Notebook	Um objeto de bloco de anotações.
NotebookDefinition	Objeto de definição pública do bloco de anotações. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de bloco de anotações.
NotebookDefinitionPart	Objeto da parte de definição do bloco de anotações.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

CreateNotebookRequest

Object

Crie carga útil de solicitação de bloco de anotações.

Name	Tipo	Description
definition	NotebookDefinition	A definição pública do caderno.
description	string	A descrição do caderno. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do bloco de anotações. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Uma API para o item GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um caderno.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho de faísca.
Warehouse	Um armazém.

Notebook

Object

Um objeto de bloco de anotações.

Name	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
id	string uuid	O ID do item.
type	ItemType	O tipo de item.
workspaceId	string uuid	O ID do espaço de trabalho.

NotebookDefinition

Object

Objeto de definição pública do bloco de anotações. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de bloco de anotações.

Name	Tipo	Description
format	string	O formato da definição do Bloco de Notas. Formato suportado: `ipynb`.
parts	NotebookDefinitionPart[]	Uma lista de partes de definição.

NotebookDefinitionPart

Object

Objeto da parte de definição do bloco de anotações.

Name	Tipo	Description
path	string	O caminho da parte do bloco de anotações.
payload	string	A carga útil da parte do notebook.
payloadType	PayloadType	O tipo de carga útil.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Description
InlineBase64	Base em linha 64.

Partilhar via

Items - Create Notebook

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interface

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create a notebook example

Pedido de amostra

Resposta da amostra

Create a notebook with public definition example

Pedido de amostra

Resposta da amostra

Definições

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Recursos adicionais