DevBoxesClient.StopDevBox Método

Referência

Definição

Namespace:: Azure.Developer.DevCenter

Assembly:: Azure.Developer.DevCenter.dll

Pacote:: Azure.Developer.DevCenter v1.0.0-beta.3

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

[Método protocol] Para uma caixa de desenvolvimento

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

public virtual Azure.Operation<BinaryData> StopDevBox (Azure.WaitUntil waitUntil, string projectName, string userId, string devBoxName, bool? hibernate, Azure.RequestContext context);

abstract member StopDevBox : Azure.WaitUntil * string * string * string * Nullable<bool> * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.StopDevBox : Azure.WaitUntil * string * string * string * Nullable<bool> * Azure.RequestContext -> Azure.Operation<BinaryData>

Public Overridable Function StopDevBox (waitUntil As WaitUntil, projectName As String, userId As String, devBoxName As String, hibernate As Nullable(Of Boolean), context As RequestContext) As Operation(Of BinaryData)

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 execução prolongada, consulte Exemplos de operação de Long-Running do Azure.Core.

projectName: String

O Projeto do 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.

devBoxName: String

O nome de uma Caixa de Desenvolvimento.

hibernate: Nullable<Boolean>

Parâmetro opcional para hibernar a caixa de desenvolvimento.

context: RequestContext

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

Retornos

Operation<BinaryData>

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

Exceções

ArgumentNullException

projectName, userId ou devBoxName é nulo.

ArgumentException

projectName, userId ou devBoxName é 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 StopDevBox e analisar o resultado.

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

Operation<BinaryData> operation = client.StopDevBox(WaitUntil.Completed, "<projectName>", "<userId>", "<devBoxName>", null, null);
BinaryData responseData = operation.Value;

JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("status").ToString());

Este exemplo mostra como chamar StopDevBox com todos os parâmetros e analisar o resultado.

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

Operation<BinaryData> operation = client.StopDevBox(WaitUntil.Completed, "<projectName>", "<userId>", "<devBoxName>", true, null);
BinaryData responseData = operation.Value;

JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("resourceId").ToString());
Console.WriteLine(result.GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("percentComplete").ToString());
Console.WriteLine(result.GetProperty("properties").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());

Aplica-se a

Compartilhar via