Microsoft.Consumption (stable:2017-11-30)

2025/10/30 • 4 new, 4 deleted methods

UsageDetails_List (new)
Description Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/usageDetails
{
scope: string ,
$expand: string ,
$filter: string ,
$skiptoken: string ,
$top: integer ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
billingPeriodId: string ,
invoiceId: string ,
usageStart: string ,
usageEnd: string ,
instanceName: string ,
instanceId: string ,
instanceLocation: string ,
currency: string ,
usageQuantity: number ,
billableQuantity: number ,
pretaxCost: number ,
isEstimated: boolean ,
meterId: string ,
meterDetails:
{
meterName: string ,
meterCategory: string ,
meterSubCategory: string ,
unit: string ,
meterLocation: string ,
totalIncludedQuantity: number ,
pretaxStandardRate: number ,
}
,
subscriptionGuid: string ,
subscriptionName: string ,
accountName: string ,
departmentName: string ,
product: string ,
consumedService: string ,
costCenter: string ,
additionalProperties: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
ReservationsSummaries_List (new)
Description Lists the reservations summaries for daily or monthly grain.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/reservationSummaries
{
scope: string ,
grain: string ,
$filter: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
reservationOrderId: string ,
reservationId: string ,
skuName: string ,
reservedHours: number ,
usageDate: string ,
usedHours: number ,
minUtilizationPercentage: number ,
avgUtilizationPercentage: number ,
maxUtilizationPercentage: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
ReservationsDetails_List (new)
Description Lists the reservations details for provided date range.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/reservationDetails
{
scope: string ,
$filter: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
reservationOrderId: string ,
reservationId: string ,
skuName: string ,
reservedHours: number ,
usageDate: string ,
usedHours: number ,
instanceId: string ,
totalReservedQuantity: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Operations_List (new)
Description Lists all of the available consumption REST API operations.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
UsageDetails_List (removed)
Description Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/usageDetails
{
scope: string ,
$expand: string ,
$filter: string ,
$skiptoken: string ,
$top: integer ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
billingPeriodId: string ,
invoiceId: string ,
usageStart: string ,
usageEnd: string ,
instanceName: string ,
instanceId: string ,
instanceLocation: string ,
currency: string ,
usageQuantity: number ,
billableQuantity: number ,
pretaxCost: number ,
isEstimated: boolean ,
meterId: string ,
meterDetails:
{
meterName: string ,
meterCategory: string ,
meterSubCategory: string ,
unit: string ,
meterLocation: string ,
totalIncludedQuantity: number ,
pretaxStandardRate: number ,
}
,
subscriptionGuid: string ,
subscriptionName: string ,
accountName: string ,
departmentName: string ,
product: string ,
consumedService: string ,
costCenter: string ,
additionalProperties: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
ReservationsSummaries_List (removed)
Description Lists the reservations summaries for daily or monthly grain.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/reservationSummaries
{
scope: string ,
grain: string ,
$filter: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
reservationOrderId: string ,
reservationId: string ,
skuName: string ,
reservedHours: number ,
usageDate: string ,
usedHours: number ,
minUtilizationPercentage: number ,
avgUtilizationPercentage: number ,
maxUtilizationPercentage: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
ReservationsDetails_List (removed)
Description Lists the reservations details for provided date range.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/reservationDetails
{
scope: string ,
$filter: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
reservationOrderId: string ,
reservationId: string ,
skuName: string ,
reservedHours: number ,
usageDate: string ,
usedHours: number ,
instanceId: string ,
totalReservedQuantity: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Operations_List (removed)
Description Lists all of the available consumption REST API operations.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}