Compartilhar via

Items - Get Notebook Definition

Serviço:
Notebook
Versão da API:
v1

Retorna a definição pública do bloco de anotações especificada.
Essa API dá suporte a LRO (operações de execução longa).

Quando você obtém a definição pública de um bloco de anotações, o rótulo de confidencialidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para o notebook.

Escopos delegados necessários

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limitações

Essa API é bloqueada para um notebook com um rótulo de confidencialidade criptografado.

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

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
notebookId
 path True

string (uuid)

A ID do bloco de anotações.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.
format
 query

string

O formato da definição pública do bloco de anotações. Formato com suporte: ipynb e fabricGitSource. Se nenhum formato for fornecido, fabricGitSource será usado.

Respostas

Nome Tipo Description
200 OK

NotebookDefinitionResponse

Solicitação concluída com êxito.
202 Accepted

Solicitação aceita. A recuperação da definição está em andamento.

Cabeçalhos

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

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem – Operação sem suporte para o item solicitado.

Exemplos

Get a notebook definition in fabricGitSource format example
Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Resposta de exemplo

Código de status:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de status:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

Resposta de exemplo

Código de status:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de status:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
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.
NotebookDefinitionResponse

Resposta de definição pública 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.

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.

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 e fabricGitSource. Se nenhum formato for fornecido, fabricGitSource será usado.
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. Extensões de conteúdo do bloco de anotações com suporte: .ipynb para ipynb formato; .py, .scala, .rpara .sqlfabricGitSource formato.
payload

string

O conteúdo da parte do bloco de anotações.
payloadType

PayloadType

O tipo de conteúdo.

NotebookDefinitionResponse

Objeto

Resposta de definição pública do bloco de anotações.

Nome Tipo Description
definition

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.

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.