< Back
Get-AzureBatchPoolStatistics
Post
NAME Get-AzureBatchPoolStatistics
SYNOPSIS
Gets pool summary statistics for a Batch account.
SYNTAX
Get-AzureBatchPoolStatistics -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchPoolStatistics cmdlet gets the lifetime statistics for all of the pools in the specified account. Statistics are aggregated
across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
PSPoolStatistics
NOTES
Example 1: Get resource statistics of all pools in an account
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> $PoolStatistics = Get-AzureBatchPoolStatistics -BatchContext $Context
PS C:\\> $PoolStatistics.ResourceStatistics
AverageCpuPercentage : 0.351232518750755
AverageDiskGiB : 55.2569014701165
AverageMemoryGiB : 2.87273772318252
DiskReadGiB : 45.1326256990433
DiskReadIOps : 878278
DiskWriteGiB : 1230.72120628133
DiskWriteIOps : 176832212
LastUpdateTime : 5/16/2016 4:30:00 PM
NetworkReadGiB : 29.3502839952707
NetworkWriteGiB : 25.5208827350289
PeakDiskGiB : 21.9638671875
PeakMemoryGiB : 1.11184692382813
StartTime : 2/10/2016 7:07:24 PM
The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using
Get-AzureRmBatchAccountKeys . The command stores this object reference in the $Context variable.
The second command gets the statistics of all of the pools in the specified account, and then stores them in the $PoolStatistics.
The final command displays the ResourceStatistics property of $PoolStatistics.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... statistics
Get-AzureRmBatchAccountKeys
Get-AzureBatchPoolUsageMetrics
Get-AzureBatchJobStatistics
SYNOPSIS
Gets pool summary statistics for a Batch account.
SYNTAX
Get-AzureBatchPoolStatistics -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchPoolStatistics cmdlet gets the lifetime statistics for all of the pools in the specified account. Statistics are aggregated
across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
PSPoolStatistics
NOTES
Example 1: Get resource statistics of all pools in an account
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> $PoolStatistics = Get-AzureBatchPoolStatistics -BatchContext $Context
PS C:\\> $PoolStatistics.ResourceStatistics
AverageCpuPercentage : 0.351232518750755
AverageDiskGiB : 55.2569014701165
AverageMemoryGiB : 2.87273772318252
DiskReadGiB : 45.1326256990433
DiskReadIOps : 878278
DiskWriteGiB : 1230.72120628133
DiskWriteIOps : 176832212
LastUpdateTime : 5/16/2016 4:30:00 PM
NetworkReadGiB : 29.3502839952707
NetworkWriteGiB : 25.5208827350289
PeakDiskGiB : 21.9638671875
PeakMemoryGiB : 1.11184692382813
StartTime : 2/10/2016 7:07:24 PM
The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using
Get-AzureRmBatchAccountKeys . The command stores this object reference in the $Context variable.
The second command gets the statistics of all of the pools in the specified account, and then stores them in the $PoolStatistics.
The final command displays the ResourceStatistics property of $PoolStatistics.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... statistics
Get-AzureRmBatchAccountKeys
Get-AzureBatchPoolUsageMetrics
Get-AzureBatchJobStatistics