ApplicationOperations.GetApplicationSummaryAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

ApplicationOperations.cs

Gets information about the specified application.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.ApplicationSummary> GetApplicationSummaryAsync (string applicationId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.GetApplicationSummaryAsync : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.ApplicationSummary>

Public Function GetApplicationSummaryAsync (applicationId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ApplicationSummary)

Parameters

applicationId

String

The id of the application to get.

detailLevel

DetailLevel

A DetailLevel used for controlling which properties are retrieved from the service.

additionalBehaviors

IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors and detailLevel.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task<ApplicationSummary>

An ApplicationSummary containing information about the specified application.

Remarks

The get application operation runs asynchronously.