DeploymentEnvironmentsClient.DeleteEnvironmentAsync Método

Definição

Namespace:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Pacote:

Azure.Developer.DevCenter v1.0.0

Origem:

DeploymentEnvironmentsClient.cs

[Método de protocolo] Exclui um ambiente e todos os seus recursos associados

• Esse método de protocolo permite a criação explícita da solicitação e do processamento da resposta para cenários avançados.

public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteEnvironmentAsync (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.RequestContext context = default);

abstract member DeleteEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>

Public Overridable Function DeleteEnvironmentAsync (waitUntil As WaitUntil, projectName As String, userId As String, environmentName As String, Optional context As RequestContext = Nothing) As Task(Of Operation)

Parâmetros

waitUntil

WaitUntil

Completed se o método deve aguardar para retornar até que a operação de execução prolongada seja concluída no serviço; Started se ele deve retornar depois de iniciar a operação. Para obter mais informações sobre operações de longa execução, consulte Exemplos de operação de Long-Running do Azure.Core.

projectName

String

O Projeto DevCenter no qual executar operações.

userId

String

A ID do objeto do AAD do usuário. Se value for 'me', a identidade será retirada do contexto de autenticação.

environmentName

String

O nome do ambiente.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Operation>

O Operation que representa uma operação assíncrona no serviço.

Exceções

ArgumentNullException

projectName, userId ou environmentName é nulo.

ArgumentException

projectName, userId ou environmentName é uma cadeia de caracteres vazia e era esperado que não estivesse vazio.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar DeleteEnvironmentAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);

Operation operation = await client.DeleteEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");

Este exemplo mostra como chamar DeleteEnvironmentAsync com todos os parâmetros.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);

Operation operation = await client.DeleteEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");