Partilhar via

Items - Update Notebook Definition

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

Substitui a definição para o bloco de anotações especificado.
Esta API suporta operações de longa duração (LRO).

A atualização da definição do bloco de anotações não afeta seu rótulo de sensibilidade.

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

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}/updateDefinition
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition?updateMetadata={updateMetadata}

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.
updateMetadata
 query

boolean

Quando definido como true e o arquivo .platform é fornecido como parte da definição, os metadados do item são atualizados usando os metadados no arquivo .platform

Corpo do Pedido

Name Necessário Tipo Description
definition True

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.

Respostas

Name Tipo Description
200 OK

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. A definição de atualizaçã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 não suportada para o item solicitado.

  • CorruptedPayload - A carga fornecida está corrompida.

Exemplos

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

Update a notebook definition in fabricGitSource format example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Resposta da amostra

Código de estado:
200
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Update a notebook definition in ipynb format example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Resposta da amostra

Código de estado:
200
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
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.
PayloadType

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

Atualizar carga útil de solicitação de definição pública do bloco de anotações.

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.

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.

UpdateNotebookDefinitionRequest

Object

Atualizar carga útil de solicitação 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.