Partager via


DevBoxesClient.GetDevBoxAction Method

Definition

Overloads

GetDevBoxAction(String, String, String, String, RequestContext)

[Protocol Method] Gets an action.

GetDevBoxAction(String, String, String, String, CancellationToken)

Gets an action.

GetDevBoxAction(String, String, String, String, RequestContext)

Source:
DevBoxesClient.cs
Source:
DevBoxesClient.cs

[Protocol Method] Gets an action.

public virtual Azure.Response GetDevBoxAction (string projectName, string userId, string devBoxName, string actionName, Azure.RequestContext context);
abstract member GetDevBoxAction : string * string * string * string * Azure.RequestContext -> Azure.Response
override this.GetDevBoxAction : string * string * string * string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetDevBoxAction (projectName As String, userId As String, devBoxName As String, actionName As String, context As RequestContext) As Response

Parameters

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.

actionName
String

The name of the action.

context
RequestContext

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

Returns

The response returned from the service.

Exceptions

projectName, userId, devBoxName or actionName is null.

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

Service returned a non-success status code.

Examples

This sample shows how to call GetDevBoxAction and parse the result.

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

Response response = client.GetDevBoxAction("<projectName>", "<userId>", "<devBoxName>", "<actionName>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("actionType").ToString());
Console.WriteLine(result.GetProperty("sourceId").ToString());

This sample shows how to call GetDevBoxAction 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);

Response response = client.GetDevBoxAction("<projectName>", "<userId>", "<devBoxName>", "<actionName>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("actionType").ToString());
Console.WriteLine(result.GetProperty("sourceId").ToString());
Console.WriteLine(result.GetProperty("suspendedUntil").ToString());
Console.WriteLine(result.GetProperty("next").GetProperty("scheduledTime").ToString());

Applies to

GetDevBoxAction(String, String, String, String, CancellationToken)

Source:
DevBoxesClient.cs

Gets an action.

public virtual Azure.Response<Azure.Developer.DevCenter.Models.DevBoxAction> GetDevBoxAction (string projectName, string userId, string devBoxName, string actionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDevBoxAction : string * string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevBoxAction>
override this.GetDevBoxAction : string * string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevBoxAction>
Public Overridable Function GetDevBoxAction (projectName As String, userId As String, devBoxName As String, actionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DevBoxAction)

Parameters

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.

actionName
String

The name of the action.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

projectName, userId, devBoxName or actionName is null.

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

Examples

This sample shows how to call GetDevBoxAction.

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

Response<DevBoxAction> response = client.GetDevBoxAction("<projectName>", "<userId>", "<devBoxName>", "<actionName>");

This sample shows how to call GetDevBoxAction with all parameters.

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

Response<DevBoxAction> response = client.GetDevBoxAction("<projectName>", "<userId>", "<devBoxName>", "<actionName>");

Applies to