IPoolManager.GetPoolAsync Method

Article
11/06/2014
2 minutes to read

Begins an asynchronous call to open a bound IPool object on the specified pool.

Namespace: Microsoft.Azure.Batch
Assembly: Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Usage

'Usage
Dim instance As IPoolManager
Dim poolName As String
Dim detailLevel As DetailLevel
Dim context As OperationContext
Dim additionalBehaviors As IEnumerable(Of BatchClientBehavior)
Dim returnValue As Task(Of ICloudPool)

returnValue = instance.GetPoolAsync(poolName, detailLevel, context, additionalBehaviors)

Syntax

'Declaration
Function GetPoolAsync ( _
    poolName As String, _
    <OptionalAttribute> Optional detailLevel As DetailLevel = Nothing, _
    <OptionalAttribute> Optional context As OperationContext = Nothing, _
    <OptionalAttribute> Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing _
) As Task(Of ICloudPool)

Task<ICloudPool> GetPoolAsync (
    string poolName,
    [OptionalAttribute] DetailLevel detailLevel,
    [OptionalAttribute] OperationContext context,
    [OptionalAttribute] IEnumerable<BatchClientBehavior> additionalBehaviors
)

Task<ICloudPool^>^ GetPoolAsync (
    String^ poolName, 
    [OptionalAttribute] DetailLevel^ detailLevel, 
    [OptionalAttribute] OperationContext^ context, 
    [OptionalAttribute] IEnumerable<BatchClientBehavior^>^ additionalBehaviors
)

Task<ICloudPool> GetPoolAsync (
    String poolName, 
    /** @attribute OptionalAttribute() */ DetailLevel detailLevel, 
    /** @attribute OptionalAttribute() */ OperationContext context, 
    /** @attribute OptionalAttribute() */ IEnumerable<BatchClientBehavior> additionalBehaviors
)

function GetPoolAsync (
    poolName : String, 
    detailLevel : DetailLevel, 
    context : OperationContext, 
    additionalBehaviors : IEnumerable<BatchClientBehavior>
) : Task<ICloudPool>

Parameters

poolName
The name of the Pool to open.

Return Value

An asynchonous Task the Result of which will be a Pool object bound to the desired Pool.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012