DevBoxesClient.StopDevBox Method

Reference

Definition

Namespace:: Azure.Developer.DevCenter

Assembly:: Azure.Developer.DevCenter.dll

Package:: Azure.Developer.DevCenter v1.0.0

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

Source:: DevBoxesClient.cs

Source:: DevBoxesClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Stops a Dev Box

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

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

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
override this.StopDevBox : Azure.WaitUntil * string * string * string * Nullable<bool> * Azure.RequestContext -> Azure.Operation

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, Optional hibernate As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Operation

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)

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

projectName: String

Name of the project.

userId: String

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

devBoxName: String

Display name for the Dev Box.

hibernate: Nullable<Boolean>

Optional parameter to hibernate the dev box.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Operation

Operation<BinaryData>

The Operation representing an asynchronous operation on the service.

Exceptions

ArgumentNullException

projectName, userId or devBoxName is null.

ArgumentException

projectName, userId or devBoxName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call StopDevBox.

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

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

This sample shows how to call StopDevBox with all parameters.

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

Operation operation = client.StopDevBox(WaitUntil.Completed, "<projectName>", "<userId>", "<devBoxName>", hibernate: true);

Applies to

Share via