PoolOperations.GetPool Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: PoolOperations.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.

Gets the specified CloudPool.

public Microsoft.Azure.Batch.CloudPool GetPool (string poolId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.GetPool : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.CloudPool

Public Function GetPool (poolId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As CloudPool

Parameters

poolId: String

The id of the pool 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.

Returns

CloudPool

A CloudPool containing information about the specified Azure Batch pool.

Remarks

This is a blocking operation. For a non-blocking equivalent, see GetPoolAsync(String, DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken).

Applies to