Microsoft.Commerce (preview:2015-06-01)

2025/09/19 • 2 new, 2 deleted methods

UsageAggregates_List (new)
Description :  Query aggregated Azure subscription consumption data for a date range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates
{
reportedStartTime:
{
Description: The start of the time range to retrieve data for. ,
Format: date-time ,
Required: True ,
}
string ,
reportedEndTime:
{
Description: The end of the time range to retrieve data for. ,
Format: date-time ,
Required: True ,
}
string ,
showDetails:
{
Description: `True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime). ,
Required: False ,
}
boolean ,
aggregationGranularity:
{
Description: `Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets details for the requested aggregation. ,
Required: False ,
}
[
{
id:
{
Description: Unique Id for the usage aggregate. ,
Required: False ,
}
string ,
name:
{
Description: Name of the usage aggregate. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource being returned. ,
Required: False ,
}
string ,
properties:
{
Description: Usage data. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier for the Azure user. ,
Format: uuid ,
Required: False ,
}
string ,
meterId:
{
Description: Unique ID for the resource that was consumed (aka ResourceID). ,
Required: False ,
}
string ,
usageStartTime:
{
Description: UTC start time for the usage bucket to which this usage aggregate belongs. ,
Format: date-time ,
Required: False ,
}
string ,
usageEndTime:
{
Description: UTC end time for the usage bucket to which this usage aggregate belongs. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The amount of the resource consumption that occurred in this time frame. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: The unit in which the usage for this resource is being counted, e.g. Hours, GB. ,
Required: False ,
}
string ,
meterName:
{
Description: Friendly name of the resource being consumed. ,
Required: False ,
}
string ,
meterCategory:
{
Description: Category of the consumed resource. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: Sub-category of the consumed resource. ,
Required: False ,
}
string ,
meterRegion:
{
Description: Region of the meterId used for billing purposes ,
Required: False ,
}
string ,
infoFields:
{
Description: Key-value pairs of instance details (legacy format). ,
Required: False ,
}
string ,
instanceData:
{
Description: Key-value pairs of instance details represented as a string. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
error:
{
Description: Wrapper object for error information ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Wrapper object for error information ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RateCard_Get (new)
Description :  Enables you to query for the resource/meter metadata and related prices used in a given subscription by Offer ID, Currency, Locale and Region. The metadata associated with the billing meters, including but not limited to service names, types, resources, units of measure, and regions, is subject to change at any time and without notice. If you intend to use this billing data in an automated fashion, please use the billing meter GUID to uniquely identify each billable item. If the billing meter GUID is scheduled to change due to a new billing model, you will be notified in advance of the change.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Commerce/RateCard
{
$filter:
{
Description: The filter to apply on the operation. It ONLY supports the 'eq' and 'and' logical operators at this time. All the 4 query parameters 'OfferDurableId', 'Currency', 'Locale', 'Region' are required to be a part of the $filter. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Currency:
{
Description: The currency in which the rates are provided. ,
Required: False ,
}
string ,
Locale:
{
Description: The culture in which the resource information is localized. ,
Required: False ,
}
string ,
IsTaxIncluded:
{
Description: All rates are pretax, so this will always be returned as 'false'. ,
Required: False ,
}
boolean ,
OfferTerms:
{
Description: A list of offer terms. ,
Required: False ,
}
[
{
Name:
{
Description: Name of the offer term ,
Enum:
{
Recurring Charge: No description available. ,
Monetary Commitment: No description available. ,
Monetary Credit: No description available. ,
}
,
Required: True ,
}
enum ,
EffectiveDate:
{
Description: Indicates the date from which the offer term is effective. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
Meters:
{
Description: A list of meters. ,
Required: False ,
}
[
{
MeterId:
{
Description: The unique identifier of the resource. ,
Format: uuid ,
Required: False ,
}
string ,
MeterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
MeterCategory:
{
Description: The category of the meter, e.g., 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
MeterSubCategory:
{
Description: The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
Unit:
{
Description: The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
MeterTags:
{
Description: Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party. ,
Required: False ,
}
[
string ,
]
,
MeterRegion:
{
Description: The region in which the Azure service is available. ,
Required: False ,
}
string ,
MeterRates:
{
Description: The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price ,
Required: False ,
}
object ,
EffectiveDate:
{
Description: Indicates the date from which the meter rate is effective. ,
Format: date-time ,
Required: False ,
}
string ,
IncludedQuantity:
{
Description: The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UsageAggregates_List (removed)
Description :  Query aggregated Azure subscription consumption data for a date range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates
{
reportedStartTime:
{
Description: The start of the time range to retrieve data for. ,
Format: date-time ,
Required: True ,
}
string ,
reportedEndTime:
{
Description: The end of the time range to retrieve data for. ,
Format: date-time ,
Required: True ,
}
string ,
showDetails:
{
Description: `True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime). ,
Required: False ,
}
boolean ,
aggregationGranularity:
{
Description: `Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity. ,
Required: False ,
}
string ,
continuationToken:
{
Description: Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets details for the requested aggregation. ,
Required: False ,
}
[
{
id:
{
Description: Unique Id for the usage aggregate. ,
Required: False ,
}
string ,
name:
{
Description: Name of the usage aggregate. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource being returned. ,
Required: False ,
}
string ,
properties:
{
Description: Usage data. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier for the Azure user. ,
Format: uuid ,
Required: False ,
}
string ,
meterId:
{
Description: Unique ID for the resource that was consumed (aka ResourceID). ,
Required: False ,
}
string ,
usageStartTime:
{
Description: UTC start time for the usage bucket to which this usage aggregate belongs. ,
Format: date-time ,
Required: False ,
}
string ,
usageEndTime:
{
Description: UTC end time for the usage bucket to which this usage aggregate belongs. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The amount of the resource consumption that occurred in this time frame. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: The unit in which the usage for this resource is being counted, e.g. Hours, GB. ,
Required: False ,
}
string ,
meterName:
{
Description: Friendly name of the resource being consumed. ,
Required: False ,
}
string ,
meterCategory:
{
Description: Category of the consumed resource. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: Sub-category of the consumed resource. ,
Required: False ,
}
string ,
meterRegion:
{
Description: Region of the meterId used for billing purposes ,
Required: False ,
}
string ,
infoFields:
{
Description: Key-value pairs of instance details (legacy format). ,
Required: False ,
}
string ,
instanceData:
{
Description: Key-value pairs of instance details represented as a string. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
error:
{
Description: Wrapper object for error information ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Wrapper object for error information ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RateCard_Get (removed)
Description :  Enables you to query for the resource/meter metadata and related prices used in a given subscription by Offer ID, Currency, Locale and Region. The metadata associated with the billing meters, including but not limited to service names, types, resources, units of measure, and regions, is subject to change at any time and without notice. If you intend to use this billing data in an automated fashion, please use the billing meter GUID to uniquely identify each billable item. If the billing meter GUID is scheduled to change due to a new billing model, you will be notified in advance of the change.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Commerce/RateCard
{
$filter:
{
Description: The filter to apply on the operation. It ONLY supports the 'eq' and 'and' logical operators at this time. All the 4 query parameters 'OfferDurableId', 'Currency', 'Locale', 'Region' are required to be a part of the $filter. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Currency:
{
Description: The currency in which the rates are provided. ,
Required: False ,
}
string ,
Locale:
{
Description: The culture in which the resource information is localized. ,
Required: False ,
}
string ,
IsTaxIncluded:
{
Description: All rates are pretax, so this will always be returned as 'false'. ,
Required: False ,
}
boolean ,
OfferTerms:
{
Description: A list of offer terms. ,
Required: False ,
}
[
{
Name:
{
Description: Name of the offer term ,
Enum:
{
Recurring Charge: No description available. ,
Monetary Commitment: No description available. ,
Monetary Credit: No description available. ,
}
,
Required: True ,
}
enum ,
EffectiveDate:
{
Description: Indicates the date from which the offer term is effective. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
Meters:
{
Description: A list of meters. ,
Required: False ,
}
[
{
MeterId:
{
Description: The unique identifier of the resource. ,
Format: uuid ,
Required: False ,
}
string ,
MeterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
MeterCategory:
{
Description: The category of the meter, e.g., 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
MeterSubCategory:
{
Description: The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
Unit:
{
Description: The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
MeterTags:
{
Description: Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party. ,
Required: False ,
}
[
string ,
]
,
MeterRegion:
{
Description: The region in which the Azure service is available. ,
Required: False ,
}
string ,
MeterRates:
{
Description: The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price ,
Required: False ,
}
object ,
EffectiveDate:
{
Description: Indicates the date from which the meter rate is effective. ,
Format: date-time ,
Required: False ,
}
string ,
IncludedQuantity:
{
Description: The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}