DevBoxesClient.GetDevBoxesAsync Method

Definition

Namespace:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Package:

Azure.Developer.DevCenter v1.0.0

Overloads

GetDevBoxesAsync(String, String, RequestContext)	[Protocol Method] Lists Dev Boxes in the project for a particular user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDevBoxesAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
GetDevBoxesAsync(String, String, CancellationToken)	Lists Dev Boxes in the project for a particular user.

GetDevBoxesAsync(String, String, RequestContext)

Source:

DevBoxesClient.cs

[Protocol Method] Lists Dev Boxes in the project for a particular user.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetDevBoxesAsync(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.AsyncPageable<BinaryData> GetDevBoxesAsync (string projectName, string userId, Azure.RequestContext context);

abstract member GetDevBoxesAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDevBoxesAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetDevBoxesAsync (projectName As String, userId As String, context As RequestContext) As AsyncPageable(Of BinaryData)

Parameters

projectName

String

The DevCenter Project upon which to execute operations.

userId

String

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

context

RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

projectName or userId is null.

ArgumentException

projectName or userId 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 GetDevBoxesAsync and parse the result.

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

await foreach (BinaryData item in client.GetDevBoxesAsync("<projectName>", "<userId>", null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("poolName").ToString());
}

This sample shows how to call GetDevBoxesAsync with all parameters and parse the result.

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

await foreach (BinaryData item in client.GetDevBoxesAsync("<projectName>", "<userId>", null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("projectName").ToString());
    Console.WriteLine(result.GetProperty("poolName").ToString());
    Console.WriteLine(result.GetProperty("hibernateSupport").ToString());
    Console.WriteLine(result.GetProperty("provisioningState").ToString());
    Console.WriteLine(result.GetProperty("actionState").ToString());
    Console.WriteLine(result.GetProperty("powerState").ToString());
    Console.WriteLine(result.GetProperty("uniqueId").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
    Console.WriteLine(result.GetProperty("location").ToString());
    Console.WriteLine(result.GetProperty("osType").ToString());
    Console.WriteLine(result.GetProperty("user").ToString());
    Console.WriteLine(result.GetProperty("hardwareProfile").GetProperty("skuName").ToString());
    Console.WriteLine(result.GetProperty("hardwareProfile").GetProperty("vCPUs").ToString());
    Console.WriteLine(result.GetProperty("hardwareProfile").GetProperty("memoryGB").ToString());
    Console.WriteLine(result.GetProperty("storageProfile").GetProperty("osDisk").GetProperty("diskSizeGB").ToString());
    Console.WriteLine(result.GetProperty("imageReference").GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("imageReference").GetProperty("version").ToString());
    Console.WriteLine(result.GetProperty("imageReference").GetProperty("operatingSystem").ToString());
    Console.WriteLine(result.GetProperty("imageReference").GetProperty("osBuildNumber").ToString());
    Console.WriteLine(result.GetProperty("imageReference").GetProperty("publishedDate").ToString());
    Console.WriteLine(result.GetProperty("createdTime").ToString());
    Console.WriteLine(result.GetProperty("localAdministrator").ToString());
}

GetDevBoxesAsync(String, String, CancellationToken)

Source:

DevBoxesClient.cs

Lists Dev Boxes in the project for a particular user.

public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevBox> GetDevBoxesAsync (string projectName, string userId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDevBoxesAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevBox>
override this.GetDevBoxesAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevBox>

Public Overridable Function GetDevBoxesAsync (projectName As String, userId As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DevBox)

Parameters

projectName

String

The DevCenter Project upon which to execute operations.

userId

String

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<DevBox>

Exceptions

ArgumentNullException

projectName or userId is null.

ArgumentException

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

Examples

This sample shows how to call GetDevBoxesAsync.

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

await foreach (DevBox item in client.GetDevBoxesAsync("<projectName>", "<userId>"))
{
}

This sample shows how to call GetDevBoxesAsync with all parameters.

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

await foreach (DevBox item in client.GetDevBoxesAsync("<projectName>", "<userId>"))
{
}