Items - Create Notebook

Referência

Serviço:: Notebook

Versão da API:: v1

Cria um notebook no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Para criar um bloco de anotações com definição, consulte artigo de definição do Notebook.

Permissões

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

Escopos delegados necessários

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um notebook, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte: tipos de licença do Microsoft Fabric.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string uuid	A ID do workspace.

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
201 Created	Notebook	Criado com êxito
202 Accepted		Solicitação aceita, provisionamento de bloco de anotações em andamento. 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á está sendo usado. CorruptedPayload – O conteúdo fornecido está corrompido.

Nome

Tipo

Description

201 Created

Notebook

Criado com êxito

202 Accepted

Solicitação aceita, provisionamento de bloco de anotações em andamento.

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á está sendo usado.
CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Nome	Description
CreateNotebookRequest	Criar conteúdo 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 item 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 da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

CreateNotebookRequest

Objeto

Criar conteúdo de solicitação de bloco de anotações.

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

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Objeto

A resposta de erro.

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

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

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

ItemType

Enumeração

O tipo do item. Tipos de item 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	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um bloco de anotações.
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 do Spark.
Warehouse	Um armazém.

Notebook

Objeto

Um objeto de bloco de anotações.

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

NotebookDefinition

Objeto

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.

Nome	Tipo	Description
format	string	O formato da definição do Notebook. Formato com suporte: `ipynb`.
parts	NotebookDefinitionPart[]	Uma lista de partes de definição.

NotebookDefinitionPart

Objeto

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

Nome	Tipo	Description
path	string	O caminho da parte do bloco de anotações.
payload	string	O conteúdo da parte do bloco de anotações.
payloadType	PayloadType	O tipo de conteúdo.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

Compartilhar via

Items - Create Notebook

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interface

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a notebook example

Solicitação de exemplo

Resposta de exemplo

Create a notebook with public definition example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Recursos adicionais