DevBoxesClient.StopDevBox Método

Definición

Espacio de nombres:

Azure.Developer.DevCenter

Ensamblado:

Azure.Developer.DevCenter.dll

Paquete:

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

[Método Protocol] Detiene un cuadro de desarrollo

• Este método de protocolo permite la creación explícita de la solicitud y el procesamiento de la respuesta para escenarios avanzados.

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 si el método debe esperar a que se devuelva hasta que se haya completado la operación de larga duración en el servicio; Started si debe devolverse después de iniciar la operación. Para más información sobre las operaciones de larga duración, consulte Ejemplos de operaciones de azure.Core Long-Running.

projectName

String

Proyecto de DevCenter en el que se van a ejecutar las operaciones.

userId

String

Identificador de objeto de AAD del usuario. Si value es "me", la identidad se toma del contexto de autenticación.

devBoxName

String

Nombre de un dev Box.

hibernate

Nullable<Boolean>

Parámetro opcional para hibernar el cuadro de desarrollo.

context

RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

Operation<BinaryData>

que Operation representa una operación asincrónica en el servicio.

Excepciones

ArgumentNullException

projectName, userId o devBoxName es un valor null.

ArgumentException

projectNameo userIddevBoxName es una cadena vacía y se espera que no esté vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a StopDevBox y analizar el 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());

En este ejemplo se muestra cómo llamar a StopDevBox con todos los parámetros y analizar el 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());