Items - Update Logical Id

Serviço:: Core

Versão da API:: v1

Atualiza a ID lógica do item especificado.
As instâncias de item correspondentes compartilham a mesma ID lógica. Use esta operação para resolver conflitos de ID lógica. Antes de alterar a ID lógica, examine as automações que dependem de seu valor atual e atualize-as conforme necessário. Caso contrário, essas automações podem falhar ao localizar o item ou falhar devido a um nome de exibição duplicado. Para obter mais informações, consulte Resolver conflitos de ID lógica em Microsoft Fabric.

Permissions

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

Escopos delegados necessários

Para APIs de item, use um dos seguintes tipos de escopo:

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

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

Limitações

A ID lógica não pode ser um GUID vazio (00000000-0000-0000-0000-000000000000).
A ID lógica deve ser exclusiva dentro do workspace.
Não há suporte para a operação enquanto uma operação de CI/CD estiver ativa no workspace.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity	Suporte
User	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
logicalId	True	string (uuid)	A ID lógica a ser atualizada para o item.

Respostas

Nome Tipo Description

200 OK

Nome	Tipo	Description
200 OK	LogicalIdResponse	Solicitação concluída com êxito.
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado. ActiveCiCdOperationInProgress – Uma operação de CI/CD está ativa no workspace.

LogicalIdResponse

Solicitação concluída com êxito.

429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound - O item solicitado não foi encontrado.
ActiveCiCdOperationInProgress – Uma operação de CI/CD está ativa no workspace.

Exemplos

Update logical ID example

Solicitação de exemplo

HTTP

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

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Resposta de exemplo

Código de status:: 200

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Definições

Nome	Description
ErrorParameter	Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.
ErrorRelatedResource	O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
LogicalIdResponse	Resposta de ID lógica.
UpdateLogicalIdRequest	Atualizar o conteúdo da solicitação de ID lógica.

ErrorParameter

Objeto

Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.

Nome	Tipo	Description
message	string	Uma descrição legível pelo ser humano do significado do parâmetro.
name	string	O identificador de parâmetro.
value	string	O valor do parâmetro.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome	Tipo	Description
resourceId	string	O identificador do recurso envolvido 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.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

LogicalIdResponse

Objeto

Resposta de ID lógica.

Nome	Tipo	Description
logicalId	string (uuid)	A ID lógica do item.

UpdateLogicalIdRequest

Objeto

Atualizar o conteúdo da solicitação de ID lógica.

Nome	Tipo	Description
logicalId	string (uuid)	A ID lógica a ser atualizada para o item.