Partilhar via

Items - Delete Environment

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

Exclui o ambiente especificado.

Permissões

O chamador deve ter permissões de gravação para o ambiente.

Escopos delegados necessários

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

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}
Com parâmetros opcionais: 
DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}?hardDelete={hardDelete}

Parâmetros do URI

Name Em Necessário Tipo Description
environmentId
 path True

string (uuid)

O ID do ambiente.
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

Name Tipo Description
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 environment example
Hard delete an environment example

Delete an environment example

Pedido de amostra

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

Resposta da amostra

Código de estado:
200

Hard delete an environment example

Pedido de amostra

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

Resposta da amostra

Código de estado:
200

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.

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 (uuid)

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.