Get-AzConsumptionReservationSummary
Get reservation summaries for daily or monthly grain.
Syntax
Get-AzConsumptionReservationSummary
-Grain <String>
-ReservationOrderId <String>
[-ReservationId <String>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzConsumptionReservationSummary cmdlet gets reservation summaries for daily or monthly grain.
Examples
Example 1: Get reservation summaries with reservation order Id for monthly grain
Get-AzConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b
AvgUtilizationPercentage: 100
Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901
MaxUtilizationPercentage: 100
MinUtilizationPercentage: 100
Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901
ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640
ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b
ReservedHour: 288
SkuName: Standard_DS2_v2
Type: Microsoft.Consumption/reservationSummaries
UsageDate: 9/1/2017 12:00:00 AM
UsedHour: 288
Example 2: Get reservation summaries with reservation order Id and reservation Id for monthly grain
Get-AzConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640
AvgUtilizationPercentage: 100
Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901
MaxUtilizationPercentage: 100
MinUtilizationPercentage: 100
Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901
ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640
ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b
ReservedHour: 288
SkuName: Standard_DS2_v2
Type: Microsoft.Consumption/reservationSummaries
UsageDate: 9/1/2017 12:00:00 AM
UsedHour: 288
Example 3: Get reservation summaries with reservation order Id for daily grain provided date range
Get-AzConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -StartDate 2017-10-01 -EndDate 2017-12-07
AvgUtilizationPercentage: 100
Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101
MaxUtilizationPercentage: 100
MinUtilizationPercentage: 100
Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101
ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640
ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b
ReservedHour: 24
SkuName: Standard_DS2_v2
Type: Microsoft.Consumption/reservationSummaries
UsageDate: 11/1/2017 12:00:00 AM
UsedHour: 24
Example 4: Get reservation summaries with reservation order Id and reservation Id for daily grain provided date range
Get-AzConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -StartDate 2017-10-01 -EndDate 2017-12-07
AvgUtilizationPercentage: 100
Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101
MaxUtilizationPercentage: 100
MinUtilizationPercentage: 100
Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101
ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640
ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b
ReservedHour: 24
SkuName: Standard_DS2_v2
Type: Microsoft.Consumption/reservationSummaries
UsageDate: 11/1/2017 12:00:00 AM
UsedHour: 24
Parameters
-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 |
-EndDate
The end data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Grain
The time grain of the reservation summary, can be daily or monthly.
Type: | String |
Accepted values: | daily, monthly |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReservationId
The identifier of a reservation within a reservation order.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReservationOrderId
The identifier of a reservation purchase.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartDate
The start data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None