< Back
Get-UsageAggregates
Post
NAME Get-UsageAggregates
SYNOPSIS
Gets the reported Azure subscription usage details.
SYNTAX
Get-UsageAggregates [-AggregationGranularity {Daily | Hourly}] [-ContinuationToken <String>] [-DefaultProfile <IAzureContextContainer>]
-ReportedEndTime <DateTime> -ReportedStartTime <DateTime> [-ShowDetails <Boolean>] [<CommonParameters>]
DESCRIPTION
The Get-UsageAggregates cmdlet gets aggregated Azure subscription usage data by the following properties:
- Start and end times of when the usage was reported.
- Aggregation precision, either daily or hourly.
- Instance level detail for multiple instances of the same resource.
For consistent results, the returned data is based on when the usage details were reported by the Azure resource.
For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c
(https://msdn.microsoft.com/library/azur ... 0de96c6a3c) in the Microsoft Developer Network library.
PARAMETERS
-AggregationGranularity <AggregationGranularity>
Specifies the aggregation precision of the data. Valid values are: Daily and Hourly.
The default value is Daily.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContinuationToken <String>
Specifies the continuation token that was retrieved from the response body in the previous call. For a large result set, responses are paged
by using continuation tokens. The continuation token serves as a bookmark for progress. If you do not specify this parameter, the data is
retrieved from the beginning of the day or hour specified in ReportedStartTime . We recommend that you follow the next link in the response to
page though the data.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
-ReportedEndTime <DateTime>
Specifies the reported end time for when resource usage was recorded in the Azure billing system.
Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually
consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. In
order to get all usage events for a subscription that are reported for a time period, you query by reported time. Even though you query by
reported time, the cmdlet aggregates the response data by the resource usage time. The resource usage data is the useful pivot for analyzing
the data.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReportedStartTime <DateTime>
Specifies the reported start time for when resource usage was recorded in the Azure billing system.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ShowDetails <Boolean>
Indicates whether this cmdlet returns instance-level details with the usage data.
The default value is $True.
If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. For example, if you are
running three websites, by default you will get three line items for website consumption. However, when the value is $False, all the data for
the same subscriptionId , meterId , usageStartTime , and usageEndTime is collapsed into a single line item.
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse
NOTES
Example 1: Retrieve subscription data
PS C:\\>Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015"
This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... aggregates
SYNOPSIS
Gets the reported Azure subscription usage details.
SYNTAX
Get-UsageAggregates [-AggregationGranularity {Daily | Hourly}] [-ContinuationToken <String>] [-DefaultProfile <IAzureContextContainer>]
-ReportedEndTime <DateTime> -ReportedStartTime <DateTime> [-ShowDetails <Boolean>] [<CommonParameters>]
DESCRIPTION
The Get-UsageAggregates cmdlet gets aggregated Azure subscription usage data by the following properties:
- Start and end times of when the usage was reported.
- Aggregation precision, either daily or hourly.
- Instance level detail for multiple instances of the same resource.
For consistent results, the returned data is based on when the usage details were reported by the Azure resource.
For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c
(https://msdn.microsoft.com/library/azur ... 0de96c6a3c) in the Microsoft Developer Network library.
PARAMETERS
-AggregationGranularity <AggregationGranularity>
Specifies the aggregation precision of the data. Valid values are: Daily and Hourly.
The default value is Daily.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContinuationToken <String>
Specifies the continuation token that was retrieved from the response body in the previous call. For a large result set, responses are paged
by using continuation tokens. The continuation token serves as a bookmark for progress. If you do not specify this parameter, the data is
retrieved from the beginning of the day or hour specified in ReportedStartTime . We recommend that you follow the next link in the response to
page though the data.
Required? false
Position? named
Default value None
Accept pipeline input? False
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
-ReportedEndTime <DateTime>
Specifies the reported end time for when resource usage was recorded in the Azure billing system.
Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually
consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. In
order to get all usage events for a subscription that are reported for a time period, you query by reported time. Even though you query by
reported time, the cmdlet aggregates the response data by the resource usage time. The resource usage data is the useful pivot for analyzing
the data.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReportedStartTime <DateTime>
Specifies the reported start time for when resource usage was recorded in the Azure billing system.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ShowDetails <Boolean>
Indicates whether this cmdlet returns instance-level details with the usage data.
The default value is $True.
If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. For example, if you are
running three websites, by default you will get three line items for website consumption. However, when the value is $False, all the data for
the same subscriptionId , meterId , usageStartTime , and usageEndTime is collapsed into a single line item.
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse
NOTES
Example 1: Retrieve subscription data
PS C:\\>Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015"
This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... aggregates