Get-AzBatchPool
Gets Batch pools under the specified Batch account.
Syntax
Get-AzBatchPool
[-Filter <String>]
[-MaxCount <Int32>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzBatchPool
[[-Id] <String>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzBatchPool cmdlet gets the Azure Batch pools under the Batch account specified with the BatchContext parameter. You can use the Id parameter to get a single pool, or you can use the Filter parameter to get the pools that match an Open Data Protocol (OData) filter.
Examples
Example 1: Get a pool by ID
Get-AzBatchPool -Id "MyPool" -BatchContext $Context
AllocationState : Resizing
AllocationStateTransitionTime : 7/25/2015 9:30:28 PM
AutoScaleEnabled : False
AutoScaleFormula :
AutoScaleRun :
CertificateReferences :
CreationTime : 7/25/2015 9:30:28 PM
CurrentDedicated : 0
CurrentOSVersion : *
DisplayName :
ETag : 0x8D29538429CF04C
Id : MyPool
InterComputeNodeCommunicationEnabled : False
LastModified : 7/25/2015 9:30:28 PM
MaxTasksPerComputeNode : 1
Metadata :
OSFamily : 4
ResizeError :
ResizeTimeout : 00:05:00
TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy
StartTask :
State : Active
StateTransitionTime : 7/25/2015 9:30:28 PM
Statistics :
TargetDedicated : 1
TargetOSVersion : *
Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool
VirtualMachineSize : standard_d1_v2This command gets the pool with ID MyPool.
Example 2: Get all pools using an OData filter
Get-AzBatchPool -Filter "startswith(id,'My')" -BatchContext $Context
AllocationState : Resizing
AllocationStateTransitionTime : 7/25/2015 9:30:28 PM
AutoScaleEnabled : False
AutoScaleFormula :
AutoScaleRun :
CertificateReferences :
CreationTime : 7/25/2015 9:30:28 PM
CurrentDedicated : 0
CurrentOSVersion : *
DisplayName :
ETag : 0x8D29538429CF04C
Id : MyPool
InterComputeNodeCommunicationEnabled : False
LastModified : 7/25/2015 9:30:28 PM
MaxTasksPerComputeNode : 1
Metadata :
OSFamily : 4
ResizeError :
ResizeTimeout : 00:05:00
TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy
StartTask :
State : Active
StateTransitionTime : 7/25/2015 9:30:28 PM
Statistics :
TargetDedicated : 1
TargetOSVersion : *
Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool
VirtualMachineSize : standard_d1_v2This command gets the pools whose IDs start with My by using the Filter parameter.
Parameters
-BatchContext
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property.
| Type: | BatchAccountContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Expand
Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Specifies the OData filter clause to use when querying for pools. If you do not specify a filter, all pools under the Batch account specified with the BatchContext parameter are returned.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies the ID of the pool to get. You cannot specify wildcard characters.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxCount
Specifies the maximum number of pools to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Select
Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Related Links
Azure PowerShell