| external help file | Module Name | online version | schema |
|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml |
Az.Batch |
2.0.0 |
Gets Batch node counts per node state grouped by pool id.
Get-AzBatchPoolNodeCount -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBatchPoolNodeCount [-PoolId <String>] -BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzBatchPoolNodeCount [-Pool <PSCloudPool>] -BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzBatchPoolNodeCount [-MaxCount <Int32>] -BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
The Get-AzBatchPoolNodeCount cmdlet allows customers to get back node counts per node state grouped by pool. Possible node states are creating, idle, leavingPool, offline, preempted, rebooting, reimaging, running, starting, startTaskFailed, unknown, unusable and waitingForStartTask. The cmdlet takes PoolId or Pool parameter to filter only pool with pool id specified.
$batchContext = Get-AzBatchAccountKey -AccountName "contosobatch"
Get-AzBatchPoolNodeCount -BatchContext $batchContextPoolId Dedicated LowPriority
------ --------- -----------
contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0
contosopool2 Idle: 1, Rebooting: 1, Total: 2 Total: 0
List node counts per node state for pools under current batch account context.
Get-AzBatchPoolNodeCount -BatchContext $batchContext -PoolId "contosopool1"
PoolId Dedicated LowPriority
------ --------- -----------
contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0
$poolnodecounts = Get-AzBatchPoolNodeCount -BatchContext $batchContext -PoolId "contosopool1"
$poolnodecounts.Dedicated
Creating : 1
Idle : 1
LeavingPool : 0
Offline : 0
Preempted : 0
Rebooting : 1
Reimaging : 0
Running : 5
Starting : 0
StartTaskFailed : 0
Total : 8
Unknown : 0
Unusable : 0
WaitingForStartTask : 0
Get-AzBatchPool -Id "contosopool1" -BatchContext $batchContext | Get-AzBatchPoolNodeCount -BatchContext $batchContext
PoolId Dedicated LowPriority
------ --------- -----------
contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0Show node counts per node state for a pool given pool id.
The BatchAccountContext instance to use when interacting 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: Microsoft.Azure.Commands.Batch.BatchAccountContext
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number of pools to return. The default value is 10.
Type: System.Int32
Parameter Sets: ODataFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the PSCloudPool for which to get node counts.
Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool
Parameter Sets: ParentObject
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe id of the pool for which to get node counts.
Type: System.String
Parameter Sets: PoolId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.