Items - Update Item

Serviço:

Core

Versão API:

v1

Atualiza as propriedades do item especificado.
Esta API é suportada para vários tipos de itens, localize os tipos de itens suportados e informações sobre a sua estrutura de definição no Visão geral do gerenciamento de itens.

Permissões

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

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

• Escopo genérico: Item.ReadWrite.All
• Âmbito específico: itemType. ReadWrite.All (por exemplo: Notebook.ReadWrite.All)

Para obter mais informações sobre escopos, consulte: Escopos Artigo.

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	Quando o tipo de item na chamada é suportado. Verifique a API correspondente para o tipo de item que você está chamando para ver se sua chamada é suportada. Por exemplo, modelos semânticos são suportados.

Interfaz

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
itemId	path	True	string (uuid)	O ID do item.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Órgão do Pedido

Nome	Tipo	Descrição
description	string	A descrição do item. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do item. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

Respostas

Nome	Tipo	Descrição
200 OK	Item	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 an item example

Pedido de exemplo

HTTP

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

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

Resposta de exemplo

Código de estado:

200

{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definições

Nome	Descrição
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
Item	Um objeto de item.
ItemTag	Representa uma tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
UpdateItemRequest	Solicitação de atualização de item.

ErrorRelatedResource

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome	Tipo	Descrição
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

Objetivo

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
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.

Item

Objetivo

Um objeto de item.

Nome	Tipo	Descrição
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	O ID da pasta.
id	string (uuid)	O ID do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

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

Valor	Descrição
Dashboard	Painel do PowerBI.
Report	Relatório do PowerBI.
SemanticModel	Modelo semântico do PowerBI.
PaginatedReport	Relatório paginado do PowerBI.
Datamart	Datamart do PowerBI.
Lakehouse	Uma casa no lago.
Eventhouse	Uma casa de eventos.
Environment	Um ambiente.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
KQLDashboard	Um painel KQL.
DataPipeline	Um pipeline de dados.
Notebook	Um caderno.
SparkJobDefinition	Uma definição de trabalho de faísca.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
Warehouse	Um armazém.
Eventstream	Um fluxo de eventos.
SQLEndpoint	Um ponto de extremidade SQL.
MirroredWarehouse	Um armazém espelhado.
MirroredDatabase	Um banco de dados espelhado.
Reflex	Um reflexo.
GraphQLApi	Uma API para o item GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Uma VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
Map	Um mapa.
AnomalyDetector	Um detetor de anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent	Um Agente de Operações.
CosmosDBDatabase	Uma base de dados Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventoSchemaSet.

UpdateItemRequest

Objetivo

Solicitação de atualização de item.

Nome	Tipo	Descrição
description	string	A descrição do item. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do item. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.