Items - Get Notebook Definition

Serviço:: Notebook

Versão da API:: v1

Retorna a definição pública do bloco de anotações especificada.
Esta API suporta operações de longa duração (LRO).

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

Permissões

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

Escopos delegados necessários

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limitações

Esta API está bloqueada para um bloco de notas com uma etiqueta de sensibilidade encriptada.

Identidades suportadas pelo Entra da Microsoft

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

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades geridas	Sim

Interfaz

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 do URI

Name	Em	Necessário	Tipo	Description
notebookId	path	True	string (uuid)	O ID do bloco de notas.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
format	query		string	O formato da definição pública do bloco de notas. Formato suportado: `ipynb` e `fabricGitSource`. Se nenhum formato for fornecido, `fabricGitSource` é usado.

Respostas

Name	Tipo	Description
200 OK	NotebookDefinitionResponse	Pedido concluído com sucesso.
202 Accepted		Pedido aceite. Está em curso a recuperação da definição. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Name

Tipo

Description

200 OK

NotebookDefinitionResponse

Pedido concluído com sucesso.

202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

OperationNotSupportedForItem - Operação não suportada 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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

Name	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 de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

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.

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` e `fabricGitSource`. Se nenhum formato for fornecido, `fabricGitSource` é usado.
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. Extensões de conteúdo de notebook suportadas: `.ipynb` para `ipynb` formato; `.py`, `.scala`, `.r`, `.sql` para `fabricGitSource` formato.
payload	string	A carga útil da parte do notebook.
payloadType	PayloadType	O tipo de carga útil.

NotebookDefinitionResponse

Object

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

Name	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 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 - Get Notebook Definition

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Entra da Microsoft

Interfaz

Parâmetros do URI

Respostas

Exemplos

Get a notebook definition in fabricGitSource format example

Pedido de amostra

Resposta da amostra

Get a notebook definition in ipynb format example

Pedido de amostra

Resposta da amostra

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

NotebookDefinitionResponse

PayloadType