Items - Delete Item

Serviço:

Core

Versão da API:

v1

Exclui o 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. O comportamento padrão é apagar suavemente o item para os tipos de itens suportados.

Observação

Os itens eliminados suavemente serão contabilizados para o número máximo de itens permitidos em cada espaço de trabalho.

Permissões

O chamador deve ter permissões de escrita para o item para eliminação suave. O chamador deve ter o papel de Administrador do espaço de trabalho atribuído para eliminação completa/permanente.

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 artigo Escopos.

Limites de limitação

Tipo de Limite	Value
Quota Unificada para APIs de Plataforma	500 chamadas/min
Limite da API	200 chamadas/min

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

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

Com parâmetros opcionais:

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}?hardDelete={hardDelete}

Parâmetros do URI

Nome	Em	Obrigató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.
hardDelete	query		boolean	Especifica se deve realizar uma eliminação forçada. Quando definido para true, o item é eliminado permanentemente e não pode ser recuperado. Quando definido como false ou não especificado, o item é eliminado suavemente se o tipo de item o permitir.

Respostas

Nome	Tipo	Descrição
200 OK		Pedido concluído com sucesso.
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado. InsufficientWorkspaceRole - O utilizador não tem função de workspace suficiente. FeatureNotAvailable - Isto pode dever-se à funcionalidade de eliminação suave não estar disponível. UnsupportedItemType - Isto pode dever-se à funcionalidade de eliminação suave que não é suportada pelo tipo de item solicitado. TenantSwitchDisabled - Isto pode dever-se à desativação da funcionalidade de eliminação suave pelo administrador do inquilino. InvalidTargetItemStateForSoftDeletion - O item está em estados inválidos para eliminação suave. InvalidParentItemStateForSoftDeletion - O item pai do item não está em estado Ativo.

Exemplos

Delete an item example

Hard delete an item example

Delete an item example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

Hard delete an item example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

Definições

Nome	Descrição
ErrorParameter	Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.

ErrorParameter

Object

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

Nome	Tipo	Descrição
message	string	Uma descrição legível para humanos do significado do parâmetro.
name	string	O identificador de parâmetro.
value	string	O valor do parâmetro.

ErrorRelatedResource

Object

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

Object

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.
isRetriable	boolean	Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

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.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.