Partilhar via

Items - Update Notebook

  • Referência
Serviço:
Notebook
Versão da API:
v1

Atualiza as propriedades do bloco de anotações especificado.

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

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

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

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.

Corpo do Pedido

Name Tipo Description
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.

Respostas

Name Tipo Description
200 OK

Notebook

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

  • InvalidRequest - Solicitação de atualização inválida

Exemplos

Update a notebook example

Pedido de amostra

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook."
}

Resposta da amostra

Código de estado:
200 
{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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.
ItemType

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

Um objeto de bloco de anotações.
UpdateNotebookRequest

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

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.

UpdateNotebookRequest

Object

Atualizar solicitação de bloco de anotações.

Name Tipo Description
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.