Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureBatchPool

Get-AzureBatchPool

microsoft.azure.commands.batch.dll

Synopsis

Gets Azure Batch pools under the specified Batch account.

Syntax

Get-AzureBatchPool [-BatchContext] [-Filter] [-MaxCount] [<CommonParameters>]

Get-AzureBatchPool [-Name] [-BatchContext] [<CommonParameters>]

Detailed Description

Gets the Azure Batch pools under the Batch account specified with the BatchContext parameter. You can use the Name parameter to get a single pool, or you can use the Filter parameter to get the pools that match an OData filter.

Parameters

-BatchContext <BatchAccountContext>

The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Filter <string>

The OData filter clause to use when querying for pools. If no filter is specified, then all pools under the Batch account specified with the BatchContext parameter will be returned.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxCount <int>

The maximum number of pools to return. If a value of 0 or less is specified, then no upper limit will be used. If no value is specified, a default value of 1000 will be used.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <string>

The name of the pool to retrieve. Wildcards are not permitted.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

PSCloudPool

Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

Gets the pool named "myPool".

        Get-AzureBatchPool -Name "myPool" -BatchContext $context

        AllocationState               : Resizing
        AllocationStateTransitionTime : 3/24/2015 10:02:46 PM
        AutoScaleFormula              :
        AutoScaleRun                  :
        CertificateReferences         :
        Communication                 : False
        CreationTime                  : 3/24/2015 10:02:46 PM
        CurrentDedicated              : 0
        CurrentOSVersion              : *
        AutoScaleEnabled              : False
        LastModified                  : 3/24/2015 10:02:46 PM
        MaxTasksPerVM                 : 1
        Metadata                      :
        Name                          : myPool
        OSFamily                      : 4
        ResizeError                   :
        ResizeTimeout                 : 00:05:00
        SchedulingPolicy              : Microsoft.Azure.Commands.Batch.Models.PSSchedulingPolicy
        StartTask                     :
        State                         : Active
        StateTransitionTime           : 3/24/2015 10:02:46 PM
        Statistics                    :
        TargetDedicated               : 3
        TargetOSVersion               : *
        VMSize                        : small
        Url                           : https://cmdletexample.batch-test.windows-int.net/pools/myPool
      

-------------------------- EXAMPLE 2 --------------------------

C:\PS>

Description

-----------

Gets the pools whose names start with "my" by using the Filter parameter.

        Get-AzureBatchPool -Filter "startswith(name,'my')" -BatchContext $context

        AllocationState               : Steady
        AllocationStateTransitionTime : 3/24/2015 10:04:55 PM
        AutoScaleFormula              :
        AutoScaleRun                  :
        CertificateReferences         :
        Communication                 : False
        CreationTime                  : 3/24/2015 10:02:46 PM
        CurrentDedicated              : 3
        CurrentOSVersion              : *
        AutoScaleEnabled              : False
        LastModified                  : 3/24/2015 10:02:46 PM
        MaxTasksPerVM                 : 1
        Metadata                      :
        Name                          : myPool
        OSFamily                      : 4
        ResizeError                   :
        ResizeTimeout                 : 00:05:00
        SchedulingPolicy              : Microsoft.Azure.Commands.Batch.Models.PSSchedulingPolicy
        StartTask                     :
        State                         : Active
        StateTransitionTime           : 3/24/2015 10:02:46 PM
        Statistics                    :
        TargetDedicated               : 3
        TargetOSVersion               : *
        VMSize                        : small
        Url                           : https://cmdletexample.batch-test.windows-int.net/pools/myPool

        AllocationState               : Resizing
        AllocationStateTransitionTime : 3/24/2015 10:04:55 PM
        AutoScaleFormula              :
        AutoScaleRun                  :
        CertificateReferences         :
        Communication                 : False
        CreationTime                  : 3/24/2015 10:04:55 PM
        CurrentDedicated              : 0
        CurrentOSVersion              : *
        AutoScaleEnabled              : False
        LastModified                  : 3/24/2015 10:04:55 PM
        MaxTasksPerVM                 : 1
        Metadata                      :
        Name                          : myPool2
        OSFamily                      : 4
        ResizeError                   :
        ResizeTimeout                 : 00:05:00
        SchedulingPolicy              : Microsoft.Azure.Commands.Batch.Models.PSSchedulingPolicy
        StartTask                     :
        State                         : Active
        StateTransitionTime           : 3/24/2015 10:04:55 PM
        Statistics                    :
        TargetDedicated               : 3
        TargetOSVersion               : *
        VMSize                        : small
        Url                           : https://cmdletexample.batch-test.windows-int.net/pools/myPool2