DeploymentEnvironmentsClient.DeleteEnvironment Méthode

Définition

Espace de noms:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Paquet:

Azure.Developer.DevCenter v1.0.0

Source:

DeploymentEnvironmentsClient.cs

[Méthode de protocole] Supprime un environnement et toutes ses ressources associées

• Cette méthode de protocole permet la création explicite de la demande et le traitement de la réponse pour les scénarios avancés.

public virtual Azure.Operation DeleteEnvironment (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.RequestContext context = default);

abstract member DeleteEnvironment : Azure.WaitUntil * string * string * string * Azure.RequestContext -> Azure.Operation
override this.DeleteEnvironment : Azure.WaitUntil * string * string * string * Azure.RequestContext -> Azure.Operation

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

Paramètres

waitUntil

WaitUntil

Completed si la méthode doit attendre pour retourner jusqu’à ce que l’opération de longue durée soit terminée sur le service ; Started si elle doit être retournée après le démarrage de l’opération. Pour plus d’informations sur les opérations de longue durée, consultez Exemples d’opérations de Long-Running Azure.Core.

projectName

String

Projet DevCenter sur lequel exécuter des opérations.

userId

String

ID d’objet AAD de l’utilisateur. Si la valeur est « moi », l’identité est extraite du contexte d’authentification.

environmentName

String

Nom de l’environnement.

context

RequestContext

Contexte de la demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Operation

Operation représentant une opération asynchrone sur le service.

Exceptions

ArgumentNullException

projectName, userId ou environmentName a la valeur Null.

ArgumentException

projectName, userId ou environmentName est une chaîne vide, et était censé être non vide.

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler DeleteEnvironment.

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

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

Cet exemple montre comment appeler DeleteEnvironment avec tous les paramètres.

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

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