Microsoft.Consumption (stable:2021-10-01)

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

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/usageDetails
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalInfo or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter usageDetails by properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
metric:
{
Description: Allows to select different type of cost/usage records. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of usage details. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Marketplaces_List (new)
Description :  Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/marketplaces
{
$filter:
{
Description: May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N marketplaces. ,
Format: int32 ,
Required: False ,
}
integer ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
scope:
{
Description: The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplaces. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by the usage detail. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the usage detail. ,
Format: date-time ,
Required: False ,
}
string ,
resourceRate:
{
Description: The marketplace resource rate. ,
Format: decimal ,
Required: False ,
}
number ,
offerName:
{
Description: The type of offer. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of resource group. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: Additional information. ,
Required: False ,
}
string ,
orderNumber:
{
Description: The order number. ,
Required: False ,
}
string ,
instanceName:
{
Description: The name of the resource instance that the usage is about. ,
Required: False ,
}
string ,
instanceId:
{
Description: The uri of the resource instance that the usage is about. ,
Required: False ,
}
string ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
consumedQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure. ,
Required: False ,
}
string ,
pretaxCost:
{
Description: The amount of cost before tax. ,
Format: decimal ,
Required: False ,
}
number ,
isEstimated:
{
Description: The estimated usage is subject to change. ,
Required: False ,
}
boolean ,
meterId:
{
Description: The meter id (GUID). ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionGuid:
{
Description: Subscription guid. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Subscription name. ,
Required: False ,
}
string ,
accountName:
{
Description: Account name. ,
Required: False ,
}
string ,
departmentName:
{
Description: Department name. ,
Required: False ,
}
string ,
consumedService:
{
Description: Consumed service name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center of this department if it is a department and a costcenter exists ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional details of this usage item. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
string ,
publisherName:
{
Description: The name of publisher. ,
Required: False ,
}
string ,
planName:
{
Description: The name of plan. ,
Required: False ,
}
string ,
isRecurringCharge:
{
Description: Flag indicating whether this is a recurring charge or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_List (new)
Description :  Lists all budgets for the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/budgets
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of budgets. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_Get (new)
Description :  Gets the budget for the scope by budget name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_CreateOrUpdate (new)
Description :  The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Budget operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_Delete (new)
Description :  The operation to delete a budget.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Tags_Get (new)
Description :  Get all available tag keys for the defined scope
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/tags
{
scope:
{
Description: The scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the tag. ,
Required: False ,
}
{
tags:
{
Description: A list of Tag. ,
Required: False ,
}
[
{
key:
{
Description: Tag key. ,
Required: False ,
}
string ,
value:
{
Description: Tag values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
previousLink:
{
Description: The link (url) to the previous page of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Charges_List (new)
Description :  Lists the charges based for the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/charges
{
scope:
{
Description: The scope associated with charges operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: False ,
}
string ,
endDate:
{
Description: End date ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: May be used to group charges for billingAccount scope by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of charge summary. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Balances_GetByBillingAccount (new)
Description :  Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the balance. ,
Required: False ,
}
{
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
beginningBalance:
{
Description: The beginning balance for the billing period. ,
Format: decimal ,
Required: False ,
}
number ,
endingBalance:
{
Description: The ending balance for the billing period (for open periods this will be updated daily). ,
Format: decimal ,
Required: False ,
}
number ,
newPurchases:
{
Description: Total new purchase amount. ,
Format: decimal ,
Required: False ,
}
number ,
adjustments:
{
Description: Total adjustment amount. ,
Format: decimal ,
Required: False ,
}
number ,
utilized:
{
Description: Total Commitment usage. ,
Format: decimal ,
Required: False ,
}
number ,
serviceOverage:
{
Description: Overage for Azure services. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
totalOverage:
{
Description: serviceOverage + chargesBilledSeparately. ,
Format: decimal ,
Required: False ,
}
number ,
totalUsage:
{
Description: Azure service commitment + total Overage. ,
Format: decimal ,
Required: False ,
}
number ,
azureMarketplaceServiceCharges:
{
Description: Total charges for Azure Marketplace. ,
Format: decimal ,
Required: False ,
}
number ,
billingFrequency:
{
Description: The billing frequency. ,
Enum:
{
Month: No description available. ,
Quarter: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
priceHidden:
{
Description: Price is hidden or not. ,
Required: False ,
}
boolean ,
newPurchasesDetails:
{
Description: List of new purchases. ,
Required: False ,
}
[
{
name:
{
Description: the name of new purchase. ,
Required: False ,
}
string ,
value:
{
Description: the value of new purchase. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
adjustmentDetails:
{
Description: List of Adjustments (Promo credit, SIE credit etc.). ,
Required: False ,
}
[
{
name:
{
Description: the name of new adjustment. ,
Required: False ,
}
string ,
value:
{
Description: the value of new adjustment. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Balances_GetForBillingPeriodByBillingAccount (new)
Description :  Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the balance. ,
Required: False ,
}
{
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
beginningBalance:
{
Description: The beginning balance for the billing period. ,
Format: decimal ,
Required: False ,
}
number ,
endingBalance:
{
Description: The ending balance for the billing period (for open periods this will be updated daily). ,
Format: decimal ,
Required: False ,
}
number ,
newPurchases:
{
Description: Total new purchase amount. ,
Format: decimal ,
Required: False ,
}
number ,
adjustments:
{
Description: Total adjustment amount. ,
Format: decimal ,
Required: False ,
}
number ,
utilized:
{
Description: Total Commitment usage. ,
Format: decimal ,
Required: False ,
}
number ,
serviceOverage:
{
Description: Overage for Azure services. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
totalOverage:
{
Description: serviceOverage + chargesBilledSeparately. ,
Format: decimal ,
Required: False ,
}
number ,
totalUsage:
{
Description: Azure service commitment + total Overage. ,
Format: decimal ,
Required: False ,
}
number ,
azureMarketplaceServiceCharges:
{
Description: Total charges for Azure Marketplace. ,
Format: decimal ,
Required: False ,
}
number ,
billingFrequency:
{
Description: The billing frequency. ,
Enum:
{
Month: No description available. ,
Quarter: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
priceHidden:
{
Description: Price is hidden or not. ,
Required: False ,
}
boolean ,
newPurchasesDetails:
{
Description: List of new purchases. ,
Required: False ,
}
[
{
name:
{
Description: the name of new purchase. ,
Required: False ,
}
string ,
value:
{
Description: the value of new purchase. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
adjustmentDetails:
{
Description: List of Adjustments (Promo credit, SIE credit etc.). ,
Required: False ,
}
[
{
name:
{
Description: the name of new adjustment. ,
Required: False ,
}
string ,
value:
{
Description: the value of new adjustment. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_ListByReservationOrder (new)
Description :  Lists the reservations summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_ListByReservationOrderAndReservation (new)
Description :  Lists the reservations summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_List (new)
Description :  Lists the reservations summaries for the defined scope daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationSummaries
{
resourceScope:
{
Description: The scope associated with reservations summaries operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
startDate:
{
Description: Start date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
endDate:
{
Description: End date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile ,
Required: False ,
}
string ,
reservationId:
{
Description: Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_ListByReservationOrder (new)
Description :  Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_ListByReservationOrderAndReservation (new)
Description :  Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation ,
Required: True ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_List (new)
Description :  Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationDetails
{
resourceScope:
{
Description: The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ,
Required: True ,
}
string ,
startDate:
{
Description: Start date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
endDate:
{
Description: End date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile ,
Required: False ,
}
string ,
reservationId:
{
Description: Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationRecommendations_List (new)
Description :  List of recommendations for purchasing reserved instances.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations
{
$filter:
{
Description: May be used to filter reservationRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Single'; properties/resourceType with allowed values ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple'] and default value 'VirtualMachines'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last7Days'. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope associated with reservation recommendations operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of reservation recommendation. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
previousLink:
{
Description: The link (url) to the previous page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationRecommendationDetails_Get (new)
Description :  Details of a reservation recommendation for what-if analysis of reserved instances.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope ,
Required: True ,
}
string ,
scope:
{
Description: Scope of the reservation. ,
Required: True ,
}
string ,
region:
{
Description: Used to select the region the recommendation should be generated for. ,
Required: True ,
}
string ,
term:
{
Description: Specify length of reservation recommendation term. ,
Required: True ,
}
string ,
lookBackPeriod:
{
Description: Filter the time period on which reservation recommendation results are based. ,
Required: True ,
}
string ,
product:
{
Description: Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource Location. ,
Required: False ,
}
string ,
sku:
{
Description: Resource sku ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the reservation recommendation. ,
Required: False ,
}
{
currency:
{
Description: An ISO 4217 currency code identifier for the costs and savings ,
Required: False ,
}
string ,
resource:
{
Description: Resource specific properties. ,
Required: False ,
}
{
appliedScopes:
{
Description: List of subscriptions for which the reservation is applied. ,
Required: False ,
}
[
string ,
]
,
onDemandRate:
{
Description: On-demand rate of the resource. Most resources use hourly rates, except for BlockBlob, ManagedDisk, Backup, and Azure Files, which use monthly rates. Only hardware rates are included; software rates are excluded. Note: there could be new resources that use hourly rates in the future. ,
Required: False ,
}
number ,
product:
{
Description: Azure product ex: Standard_E8s_v3 etc. ,
Required: False ,
}
string ,
region:
{
Description: Azure resource region ex:EastUS, WestUS etc. ,
Required: False ,
}
string ,
reservationRate:
{
Description: Hourly reservation rate of the resource. Varies based on the term. ,
Required: False ,
}
number ,
resourceType:
{
Description: The azure resource type. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource Group. ,
Required: False ,
}
string ,
savings:
{
Description: Savings information for the recommendation. ,
Required: False ,
}
{
calculatedSavings:
{
Description: List of calculated savings. ,
Required: False ,
}
[
{
onDemandCost:
{
Description: The cost without reservation. Includes hardware and software cost. ,
Required: False ,
}
number ,
overageCost:
{
Description: Hardware and software cost of the resources not covered by the reservation. ,
Required: False ,
}
number ,
quantity:
{
Description: The quantity for calculated savings. ,
Required: False ,
}
number ,
reservationCost:
{
Description: Hardware cost of the resources covered by the reservation. ,
Required: False ,
}
number ,
totalReservationCost:
{
Description: Reservation cost + software cost of the resources covered by the reservation + overage cost. ,
Required: False ,
}
number ,
reservedUnitCount:
{
Description: The number of reserved units used to calculate savings. Always 1 for virtual machines. ,
Required: False ,
}
number ,
savings:
{
Description: The amount saved by purchasing the recommended quantity of reservation. This is equal to onDemandCost - totalReservationCost. ,
Required: False ,
}
number ,
}
,
]
,
lookBackPeriod:
{
Description: Number of days of usage to look back used for computing the recommendation. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedQuantity:
{
Description: Number of recommended units of the resource. ,
Required: False ,
}
number ,
reservationOrderTerm:
{
Description: Term period of the reservation, ex: P1Y or P3Y. ,
Required: False ,
}
string ,
savingsType:
{
Description: Type of savings, ex: instance. ,
Required: False ,
}
string ,
unitOfMeasure:
{
Description: Measurement unit ex: hour etc. ,
Required: False ,
}
string ,
}
,
scope:
{
Description: Scope of the reservation, ex: Single or Shared. ,
Required: False ,
}
string ,
usage:
{
Description: Historical usage details used to calculate the estimated savings. ,
Required: False ,
}
{
firstConsumptionDate:
{
Description: The first usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lastConsumptionDate:
{
Description: The last usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lookBackUnitType:
{
Description: What the usage data values represent ex: virtual machine instance. ,
Required: False ,
}
string ,
usageData:
{
Description: The breakdown of historical resource usage. The values are in the order of usage between the firstConsumptionDate and the lastConsumptionDate. ,
Required: False ,
}
[
number ,
]
,
usageGrain:
{
Description: The grain of the values represented in the usage data ex: hourly. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationTransactions_List (new)
Description :  List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions
{
$filter:
{
Description: Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for the entire December 2020 month (i.e. will contain records for dates December 30 and 31) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a legacy reservation transaction. ,
Required: False ,
}
{
eventDate:
{
Description: The date of the transaction ,
Format: date-time ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
description:
{
Description: The description of the transaction. ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the transaction (Purchase, Cancel or Refund). ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
amount:
{
Description: The charge of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the transaction is charged, for example, USD. ,
Required: False ,
}
string ,
reservationOrderName:
{
Description: The name of the reservation order. ,
Required: False ,
}
string ,
purchasingEnrollment:
{
Description: The purchasing enrollment. ,
Required: False ,
}
string ,
purchasingSubscriptionGuid:
{
Description: The subscription guid that makes the transaction. ,
Format: uuid ,
Required: False ,
}
string ,
purchasingSubscriptionName:
{
Description: The subscription name that makes the transaction. ,
Required: False ,
}
string ,
armSkuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
term:
{
Description: This is the term of the transaction. ,
Required: False ,
}
string ,
region:
{
Description: The region of the transaction. ,
Required: False ,
}
string ,
accountName:
{
Description: The name of the account that makes the transaction. ,
Required: False ,
}
string ,
accountOwnerEmail:
{
Description: The email of the account owner that makes the transaction. ,
Required: False ,
}
string ,
departmentName:
{
Description: The department name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center of this department if it is a department and a cost center is provided. ,
Required: False ,
}
string ,
currentEnrollment:
{
Description: The current enrollment. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency, which can be either one-time or recurring. ,
Required: False ,
}
string ,
billingMonth:
{
Description: The billing month(yyyyMMdd), on which the event initiated. ,
Format: int32 ,
Required: False ,
}
integer ,
monetaryCommitment:
{
Description: The monetary commitment amount at the enrollment scope. ,
Format: decimal ,
Required: False ,
}
number ,
overage:
{
Description: The overage amount at the enrollment scope. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationTransactions_ListByBillingProfile (new)
Description :  List of transactions for reserved instances on billing profile scope. The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/reservationTransactions
{
$filter:
{
Description: Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for entire December 2020 month (i.e. will contain records for dates December 30 and 31) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a modern reservation transaction. ,
Required: True ,
}
{
amount:
{
Description: The charge of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
armSkuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency, which can be either one-time or recurring. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing profile name. ,
Required: False ,
}
string ,
currency:
{
Description: The ISO currency in which the transaction is charged, for example, USD. ,
Required: False ,
}
string ,
description:
{
Description: The description of the transaction. ,
Required: False ,
}
string ,
eventDate:
{
Description: The date of the transaction ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the transaction (Purchase, Cancel or Refund). ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice Number ,
Required: False ,
}
string ,
invoiceId:
{
Description: Invoice Id as on the invoice where the specific transaction appears. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice Section Name. ,
Required: False ,
}
string ,
purchasingSubscriptionGuid:
{
Description: The subscription guid that makes the transaction. ,
Format: uuid ,
Required: False ,
}
string ,
purchasingSubscriptionName:
{
Description: The subscription name that makes the transaction. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
region:
{
Description: The region of the transaction. ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationOrderName:
{
Description: The name of the reservation order. ,
Required: False ,
}
string ,
term:
{
Description: This is the term of the transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PriceSheet_Get (new)
Description :  Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default
{
$expand:
{
Description: May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the top N results. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: price sheet result. It contains the pricesheet associated with billing period ,
Required: False ,
}
{
pricesheets:
{
Description: Price sheet ,
Required: False ,
}
[
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
meterDetails:
{
Description: The details about the meter. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
unitOfMeasure:
{
Description: Unit of measure ,
Required: False ,
}
string ,
includedQuantity:
{
Description: Included quality for an offer ,
Format: decimal ,
Required: False ,
}
number ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
unitPrice:
{
Description: Unit Price ,
Format: decimal ,
Required: False ,
}
number ,
currencyCode:
{
Description: Currency Code ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
download:
{
Description: Pricesheet download details. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PriceSheet_GetByBillingPeriod (new)
Description :  Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default
{
$expand:
{
Description: May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the top N results. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: price sheet result. It contains the pricesheet associated with billing period ,
Required: False ,
}
{
pricesheets:
{
Description: Price sheet ,
Required: False ,
}
[
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
meterDetails:
{
Description: The details about the meter. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
unitOfMeasure:
{
Description: Unit of measure ,
Required: False ,
}
string ,
includedQuantity:
{
Description: Included quality for an offer ,
Format: decimal ,
Required: False ,
}
number ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
unitPrice:
{
Description: Unit Price ,
Format: decimal ,
Required: False ,
}
number ,
currencyCode:
{
Description: Currency Code ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
download:
{
Description: Pricesheet download details. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
id:
{
Description: Operation Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AggregatedCost_GetByManagementGroup (new)
Description :  Provides the aggregate cost of a management group and all child management groups by current billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Management Group Aggregated Cost. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the aggregated cost belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed Separately. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
children:
{
Description: Children of a management group ,
Required: False ,
}
[
string ,
]
,
includedSubscriptions:
{
Description: List of subscription Guids included in the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
excludedSubscriptions:
{
Description: List of subscription Guids excluded from the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AggregatedCost_GetForBillingPeriodByManagementGroup (new)
Description :  Provides the aggregate cost of a management group and all child management groups by specified billing period
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/aggregatedCost
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Management Group Aggregated Cost. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the aggregated cost belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed Separately. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
children:
{
Description: Children of a management group ,
Required: False ,
}
[
string ,
]
,
includedSubscriptions:
{
Description: List of subscription Guids included in the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
excludedSubscriptions:
{
Description: List of subscription Guids excluded from the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Events_ListByBillingProfile (new)
Description :  Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: The date of the event. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the event. ,
Required: False ,
}
string ,
newCredit:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: The amount of balance adjustment. The property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
charges:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance after the event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: Identifies the type of the event. ,
Enum:
{
SettledCharges: No description available. ,
PendingCharges: No description available. ,
PendingAdjustments: No description available. ,
PendingNewCredit: No description available. ,
PendingExpiredCredit: No description available. ,
UnKnown: No description available. ,
NewCredit: No description available. ,
CreditExpired: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
lotId:
{
Description: The ID that uniquely identifies the lot for which the event happened. ,
Required: False ,
}
string ,
lotSource:
{
Description: Identifies the source of the lot for which the event happened. ,
Required: False ,
}
string ,
canceledCredit:
{
Description: Amount of canceled credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency of the event. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the event. ,
Required: False ,
}
string ,
reseller:
{
Description: The reseller of the event. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
creditExpiredInBillingCurrency:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
newCreditInBillingCurrency:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
adjustmentsInBillingCurrency:
{
Description: The amount of balance adjustment in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
chargesInBillingCurrency:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance in billing currency after the event. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Events_ListByBillingAccount (new)
Description :  Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the events by lotId, lotSource etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: The date of the event. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the event. ,
Required: False ,
}
string ,
newCredit:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: The amount of balance adjustment. The property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
charges:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance after the event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: Identifies the type of the event. ,
Enum:
{
SettledCharges: No description available. ,
PendingCharges: No description available. ,
PendingAdjustments: No description available. ,
PendingNewCredit: No description available. ,
PendingExpiredCredit: No description available. ,
UnKnown: No description available. ,
NewCredit: No description available. ,
CreditExpired: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
lotId:
{
Description: The ID that uniquely identifies the lot for which the event happened. ,
Required: False ,
}
string ,
lotSource:
{
Description: Identifies the source of the lot for which the event happened. ,
Required: False ,
}
string ,
canceledCredit:
{
Description: Amount of canceled credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency of the event. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the event. ,
Required: False ,
}
string ,
reseller:
{
Description: The reseller of the event. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
creditExpiredInBillingCurrency:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
newCreditInBillingCurrency:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
adjustmentsInBillingCurrency:
{
Description: The amount of balance adjustment in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
chargesInBillingCurrency:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance in billing currency after the event. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByBillingProfile (new)
Description :  Lists all Azure credits for a billing account or a billing profile. The API is only supported for Microsoft Customer Agreements (MCA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByBillingAccount (new)
Description :  Lists all Microsoft Azure consumption commitments for a billing account. The API is only supported for Microsoft Customer Agreements (MCA) and Direct Enterprise Agreement (EA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByCustomer (new)
Description :  Lists all Azure credits for a customer. The API is only supported for Microsoft Partner Agreements (MPA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
customerId:
{
Description: Customer ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Credits_Get (new)
Description :  The credit summary by billingAccountId and billingProfileId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credit summary. ,
Required: False ,
}
{
balanceSummary:
{
Description: Summary of balances associated with this credit summary. ,
Required: False ,
}
{
estimatedBalance:
{
Description: Estimated balance. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
currentBalance:
{
Description: Current balance. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
estimatedBalanceInBillingCurrency:
{
Description: Estimated balance in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
pendingCreditAdjustments:
{
Description: Pending credit adjustments. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
expiredCredit:
{
Description: Expired credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
pendingEligibleCharges:
{
Description: Pending eligible charges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency. ,
Required: False ,
}
string ,
reseller:
{
Description: Credit's reseller. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
UsageDetails_List (removed)
Description :  Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/usageDetails
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalInfo or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter usageDetails by properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
metric:
{
Description: Allows to select different type of cost/usage records. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of usage details. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Marketplaces_List (removed)
Description :  Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/marketplaces
{
$filter:
{
Description: May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N marketplaces. ,
Format: int32 ,
Required: False ,
}
integer ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
scope:
{
Description: The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of marketplaces. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the marketplace usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by the usage detail. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the usage detail. ,
Format: date-time ,
Required: False ,
}
string ,
resourceRate:
{
Description: The marketplace resource rate. ,
Format: decimal ,
Required: False ,
}
number ,
offerName:
{
Description: The type of offer. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of resource group. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: Additional information. ,
Required: False ,
}
string ,
orderNumber:
{
Description: The order number. ,
Required: False ,
}
string ,
instanceName:
{
Description: The name of the resource instance that the usage is about. ,
Required: False ,
}
string ,
instanceId:
{
Description: The uri of the resource instance that the usage is about. ,
Required: False ,
}
string ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
consumedQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure. ,
Required: False ,
}
string ,
pretaxCost:
{
Description: The amount of cost before tax. ,
Format: decimal ,
Required: False ,
}
number ,
isEstimated:
{
Description: The estimated usage is subject to change. ,
Required: False ,
}
boolean ,
meterId:
{
Description: The meter id (GUID). ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionGuid:
{
Description: Subscription guid. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Subscription name. ,
Required: False ,
}
string ,
accountName:
{
Description: Account name. ,
Required: False ,
}
string ,
departmentName:
{
Description: Department name. ,
Required: False ,
}
string ,
consumedService:
{
Description: Consumed service name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center of this department if it is a department and a costcenter exists ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Additional details of this usage item. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
string ,
publisherName:
{
Description: The name of publisher. ,
Required: False ,
}
string ,
planName:
{
Description: The name of plan. ,
Required: False ,
}
string ,
isRecurringCharge:
{
Description: Flag indicating whether this is a recurring charge or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_List (removed)
Description :  Lists all budgets for the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/budgets
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of budgets. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_Get (removed)
Description :  Gets the budget for the scope by budget name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_CreateOrUpdate (removed)
Description :  The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Budget operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget, whether the budget tracks cost or usage. ,
Enum:
{
Cost: No description available. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget ,
Format: decimal ,
Required: True ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. If not provided, we default this to 10 years from the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
notifications:
{
Description: Dictionary of notifications associated with the budget. Budget can have up to five notifications. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Budgets_Delete (removed)
Description :  The operation to delete a budget.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
budgetName:
{
Description: Budget Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Tags_Get (removed)
Description :  Get all available tag keys for the defined scope
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/tags
{
scope:
{
Description: The scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the tag. ,
Required: False ,
}
{
tags:
{
Description: A list of Tag. ,
Required: False ,
}
[
{
key:
{
Description: Tag key. ,
Required: False ,
}
string ,
value:
{
Description: Tag values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
previousLink:
{
Description: The link (url) to the previous page of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Charges_List (removed)
Description :  Lists the charges based for the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Consumption/charges
{
scope:
{
Description: The scope associated with charges operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: False ,
}
string ,
endDate:
{
Description: End date ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: May be used to group charges for billingAccount scope by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of charge summary. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Balances_GetByBillingAccount (removed)
Description :  Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the balance. ,
Required: False ,
}
{
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
beginningBalance:
{
Description: The beginning balance for the billing period. ,
Format: decimal ,
Required: False ,
}
number ,
endingBalance:
{
Description: The ending balance for the billing period (for open periods this will be updated daily). ,
Format: decimal ,
Required: False ,
}
number ,
newPurchases:
{
Description: Total new purchase amount. ,
Format: decimal ,
Required: False ,
}
number ,
adjustments:
{
Description: Total adjustment amount. ,
Format: decimal ,
Required: False ,
}
number ,
utilized:
{
Description: Total Commitment usage. ,
Format: decimal ,
Required: False ,
}
number ,
serviceOverage:
{
Description: Overage for Azure services. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
totalOverage:
{
Description: serviceOverage + chargesBilledSeparately. ,
Format: decimal ,
Required: False ,
}
number ,
totalUsage:
{
Description: Azure service commitment + total Overage. ,
Format: decimal ,
Required: False ,
}
number ,
azureMarketplaceServiceCharges:
{
Description: Total charges for Azure Marketplace. ,
Format: decimal ,
Required: False ,
}
number ,
billingFrequency:
{
Description: The billing frequency. ,
Enum:
{
Month: No description available. ,
Quarter: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
priceHidden:
{
Description: Price is hidden or not. ,
Required: False ,
}
boolean ,
newPurchasesDetails:
{
Description: List of new purchases. ,
Required: False ,
}
[
{
name:
{
Description: the name of new purchase. ,
Required: False ,
}
string ,
value:
{
Description: the value of new purchase. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
adjustmentDetails:
{
Description: List of Adjustments (Promo credit, SIE credit etc.). ,
Required: False ,
}
[
{
name:
{
Description: the name of new adjustment. ,
Required: False ,
}
string ,
value:
{
Description: the value of new adjustment. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Balances_GetForBillingPeriodByBillingAccount (removed)
Description :  Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the balance. ,
Required: False ,
}
{
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
beginningBalance:
{
Description: The beginning balance for the billing period. ,
Format: decimal ,
Required: False ,
}
number ,
endingBalance:
{
Description: The ending balance for the billing period (for open periods this will be updated daily). ,
Format: decimal ,
Required: False ,
}
number ,
newPurchases:
{
Description: Total new purchase amount. ,
Format: decimal ,
Required: False ,
}
number ,
adjustments:
{
Description: Total adjustment amount. ,
Format: decimal ,
Required: False ,
}
number ,
utilized:
{
Description: Total Commitment usage. ,
Format: decimal ,
Required: False ,
}
number ,
serviceOverage:
{
Description: Overage for Azure services. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
totalOverage:
{
Description: serviceOverage + chargesBilledSeparately. ,
Format: decimal ,
Required: False ,
}
number ,
totalUsage:
{
Description: Azure service commitment + total Overage. ,
Format: decimal ,
Required: False ,
}
number ,
azureMarketplaceServiceCharges:
{
Description: Total charges for Azure Marketplace. ,
Format: decimal ,
Required: False ,
}
number ,
billingFrequency:
{
Description: The billing frequency. ,
Enum:
{
Month: No description available. ,
Quarter: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
priceHidden:
{
Description: Price is hidden or not. ,
Required: False ,
}
boolean ,
newPurchasesDetails:
{
Description: List of new purchases. ,
Required: False ,
}
[
{
name:
{
Description: the name of new purchase. ,
Required: False ,
}
string ,
value:
{
Description: the value of new purchase. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
adjustmentDetails:
{
Description: List of Adjustments (Promo credit, SIE credit etc.). ,
Required: False ,
}
[
{
name:
{
Description: the name of new adjustment. ,
Required: False ,
}
string ,
value:
{
Description: the value of new adjustment. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_ListByReservationOrder (removed)
Description :  Lists the reservations summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_ListByReservationOrderAndReservation (removed)
Description :  Lists the reservations summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsSummaries_List (removed)
Description :  Lists the reservations summaries for the defined scope daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationSummaries
{
resourceScope:
{
Description: The scope associated with reservations summaries operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ,
Required: True ,
}
string ,
grain:
{
Description: Can be daily or monthly ,
Required: True ,
}
string ,
startDate:
{
Description: Start date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
endDate:
{
Description: End date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
$filter:
{
Description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile ,
Required: False ,
}
string ,
reservationId:
{
Description: Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation summaries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation summary. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: Total used hours by the reservation ,
Format: decimal ,
Required: False ,
}
number ,
minUtilizationPercentage:
{
Description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day ,
Format: decimal ,
Required: False ,
}
number ,
avgUtilizationPercentage:
{
Description: This is average utilization for the entire time range. (day or month depending on the grain) ,
Format: decimal ,
Required: False ,
}
number ,
maxUtilizationPercentage:
{
Description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
purchasedQuantity:
{
Description: This is the purchased quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
remainingQuantity:
{
Description: This is the remaining quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
usedQuantity:
{
Description: This is the used quantity for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
utilizedPercentage:
{
Description: This is the utilized percentage for the reservation Id. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_ListByReservationOrder (removed)
Description :  Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_ListByReservationOrderAndReservation (removed)
Description :  Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation ,
Required: True ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationsDetails_List (removed)
Description :  Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationDetails
{
resourceScope:
{
Description: The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ,
Required: True ,
}
string ,
startDate:
{
Description: Start date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
endDate:
{
Description: End date. Only applicable when querying with billing profile ,
Required: False ,
}
string ,
$filter:
{
Description: Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile ,
Required: False ,
}
string ,
reservationId:
{
Description: Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation detail. ,
Required: False ,
}
{
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
instanceFlexibilityRatio:
{
Description: The instance Flexibility Ratio. ,
Required: False ,
}
string ,
instanceFlexibilityGroup:
{
Description: The instance Flexibility Group. ,
Required: False ,
}
string ,
reservationId:
{
Description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to. ,
Required: False ,
}
string ,
skuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
reservedHours:
{
Description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days. ,
Format: decimal ,
Required: False ,
}
number ,
usageDate:
{
Description: The date on which consumption occurred. ,
Format: date-time ,
Required: False ,
}
string ,
usedHours:
{
Description: This is the total hours used by the instance. ,
Format: decimal ,
Required: False ,
}
number ,
instanceId:
{
Description: This identifier is the name of the resource or the fully qualified Resource ID. ,
Required: False ,
}
string ,
totalReservedQuantity:
{
Description: This is the total count of instances that are reserved for the reservationId. ,
Format: decimal ,
Required: False ,
}
number ,
kind:
{
Description: The reservation kind. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationRecommendations_List (removed)
Description :  List of recommendations for purchasing reserved instances.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations
{
$filter:
{
Description: May be used to filter reservationRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Single'; properties/resourceType with allowed values ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple'] and default value 'VirtualMachines'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last7Days'. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope associated with reservation recommendations operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of reservation recommendation. ,
Enum:
{
legacy: No description available. ,
modern: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
previousLink:
{
Description: The link (url) to the previous page of results. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationRecommendationDetails_Get (removed)
Description :  Details of a reservation recommendation for what-if analysis of reserved instances.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope ,
Required: True ,
}
string ,
scope:
{
Description: Scope of the reservation. ,
Required: True ,
}
string ,
region:
{
Description: Used to select the region the recommendation should be generated for. ,
Required: True ,
}
string ,
term:
{
Description: Specify length of reservation recommendation term. ,
Required: True ,
}
string ,
lookBackPeriod:
{
Description: Filter the time period on which reservation recommendation results are based. ,
Required: True ,
}
string ,
product:
{
Description: Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource Location. ,
Required: False ,
}
string ,
sku:
{
Description: Resource sku ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the reservation recommendation. ,
Required: False ,
}
{
currency:
{
Description: An ISO 4217 currency code identifier for the costs and savings ,
Required: False ,
}
string ,
resource:
{
Description: Resource specific properties. ,
Required: False ,
}
{
appliedScopes:
{
Description: List of subscriptions for which the reservation is applied. ,
Required: False ,
}
[
string ,
]
,
onDemandRate:
{
Description: On-demand rate of the resource. Most resources use hourly rates, except for BlockBlob, ManagedDisk, Backup, and Azure Files, which use monthly rates. Only hardware rates are included; software rates are excluded. Note: there could be new resources that use hourly rates in the future. ,
Required: False ,
}
number ,
product:
{
Description: Azure product ex: Standard_E8s_v3 etc. ,
Required: False ,
}
string ,
region:
{
Description: Azure resource region ex:EastUS, WestUS etc. ,
Required: False ,
}
string ,
reservationRate:
{
Description: Hourly reservation rate of the resource. Varies based on the term. ,
Required: False ,
}
number ,
resourceType:
{
Description: The azure resource type. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource Group. ,
Required: False ,
}
string ,
savings:
{
Description: Savings information for the recommendation. ,
Required: False ,
}
{
calculatedSavings:
{
Description: List of calculated savings. ,
Required: False ,
}
[
{
onDemandCost:
{
Description: The cost without reservation. Includes hardware and software cost. ,
Required: False ,
}
number ,
overageCost:
{
Description: Hardware and software cost of the resources not covered by the reservation. ,
Required: False ,
}
number ,
quantity:
{
Description: The quantity for calculated savings. ,
Required: False ,
}
number ,
reservationCost:
{
Description: Hardware cost of the resources covered by the reservation. ,
Required: False ,
}
number ,
totalReservationCost:
{
Description: Reservation cost + software cost of the resources covered by the reservation + overage cost. ,
Required: False ,
}
number ,
reservedUnitCount:
{
Description: The number of reserved units used to calculate savings. Always 1 for virtual machines. ,
Required: False ,
}
number ,
savings:
{
Description: The amount saved by purchasing the recommended quantity of reservation. This is equal to onDemandCost - totalReservationCost. ,
Required: False ,
}
number ,
}
,
]
,
lookBackPeriod:
{
Description: Number of days of usage to look back used for computing the recommendation. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedQuantity:
{
Description: Number of recommended units of the resource. ,
Required: False ,
}
number ,
reservationOrderTerm:
{
Description: Term period of the reservation, ex: P1Y or P3Y. ,
Required: False ,
}
string ,
savingsType:
{
Description: Type of savings, ex: instance. ,
Required: False ,
}
string ,
unitOfMeasure:
{
Description: Measurement unit ex: hour etc. ,
Required: False ,
}
string ,
}
,
scope:
{
Description: Scope of the reservation, ex: Single or Shared. ,
Required: False ,
}
string ,
usage:
{
Description: Historical usage details used to calculate the estimated savings. ,
Required: False ,
}
{
firstConsumptionDate:
{
Description: The first usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lastConsumptionDate:
{
Description: The last usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lookBackUnitType:
{
Description: What the usage data values represent ex: virtual machine instance. ,
Required: False ,
}
string ,
usageData:
{
Description: The breakdown of historical resource usage. The values are in the order of usage between the firstConsumptionDate and the lastConsumptionDate. ,
Required: False ,
}
[
number ,
]
,
usageGrain:
{
Description: The grain of the values represented in the usage data ex: hourly. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationTransactions_List (removed)
Description :  List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions
{
$filter:
{
Description: Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for the entire December 2020 month (i.e. will contain records for dates December 30 and 31) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a legacy reservation transaction. ,
Required: False ,
}
{
eventDate:
{
Description: The date of the transaction ,
Format: date-time ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
description:
{
Description: The description of the transaction. ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the transaction (Purchase, Cancel or Refund). ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
amount:
{
Description: The charge of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the transaction is charged, for example, USD. ,
Required: False ,
}
string ,
reservationOrderName:
{
Description: The name of the reservation order. ,
Required: False ,
}
string ,
purchasingEnrollment:
{
Description: The purchasing enrollment. ,
Required: False ,
}
string ,
purchasingSubscriptionGuid:
{
Description: The subscription guid that makes the transaction. ,
Format: uuid ,
Required: False ,
}
string ,
purchasingSubscriptionName:
{
Description: The subscription name that makes the transaction. ,
Required: False ,
}
string ,
armSkuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
term:
{
Description: This is the term of the transaction. ,
Required: False ,
}
string ,
region:
{
Description: The region of the transaction. ,
Required: False ,
}
string ,
accountName:
{
Description: The name of the account that makes the transaction. ,
Required: False ,
}
string ,
accountOwnerEmail:
{
Description: The email of the account owner that makes the transaction. ,
Required: False ,
}
string ,
departmentName:
{
Description: The department name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center of this department if it is a department and a cost center is provided. ,
Required: False ,
}
string ,
currentEnrollment:
{
Description: The current enrollment. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency, which can be either one-time or recurring. ,
Required: False ,
}
string ,
billingMonth:
{
Description: The billing month(yyyyMMdd), on which the event initiated. ,
Format: int32 ,
Required: False ,
}
integer ,
monetaryCommitment:
{
Description: The monetary commitment amount at the enrollment scope. ,
Format: decimal ,
Required: False ,
}
number ,
overage:
{
Description: The overage amount at the enrollment scope. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ReservationTransactions_ListByBillingProfile (removed)
Description :  List of transactions for reserved instances on billing profile scope. The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/reservationTransactions
{
$filter:
{
Description: Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for entire December 2020 month (i.e. will contain records for dates December 30 and 31) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a modern reservation transaction. ,
Required: True ,
}
{
amount:
{
Description: The charge of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
armSkuName:
{
Description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency, which can be either one-time or recurring. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing profile name. ,
Required: False ,
}
string ,
currency:
{
Description: The ISO currency in which the transaction is charged, for example, USD. ,
Required: False ,
}
string ,
description:
{
Description: The description of the transaction. ,
Required: False ,
}
string ,
eventDate:
{
Description: The date of the transaction ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the transaction (Purchase, Cancel or Refund). ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice Number ,
Required: False ,
}
string ,
invoiceId:
{
Description: Invoice Id as on the invoice where the specific transaction appears. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice Section Name. ,
Required: False ,
}
string ,
purchasingSubscriptionGuid:
{
Description: The subscription guid that makes the transaction. ,
Format: uuid ,
Required: False ,
}
string ,
purchasingSubscriptionName:
{
Description: The subscription name that makes the transaction. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the transaction. ,
Format: decimal ,
Required: False ,
}
number ,
region:
{
Description: The region of the transaction. ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations. ,
Required: False ,
}
string ,
reservationOrderName:
{
Description: The name of the reservation order. ,
Required: False ,
}
string ,
term:
{
Description: This is the term of the transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PriceSheet_Get (removed)
Description :  Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default
{
$expand:
{
Description: May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the top N results. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: price sheet result. It contains the pricesheet associated with billing period ,
Required: False ,
}
{
pricesheets:
{
Description: Price sheet ,
Required: False ,
}
[
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
meterDetails:
{
Description: The details about the meter. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
unitOfMeasure:
{
Description: Unit of measure ,
Required: False ,
}
string ,
includedQuantity:
{
Description: Included quality for an offer ,
Format: decimal ,
Required: False ,
}
number ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
unitPrice:
{
Description: Unit Price ,
Format: decimal ,
Required: False ,
}
number ,
currencyCode:
{
Description: Currency Code ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
download:
{
Description: Pricesheet download details. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PriceSheet_GetByBillingPeriod (removed)
Description :  Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default
{
$expand:
{
Description: May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the top N results. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: price sheet result. It contains the pricesheet associated with billing period ,
Required: False ,
}
{
pricesheets:
{
Description: Price sheet ,
Required: False ,
}
[
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
meterDetails:
{
Description: The details about the meter. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
unitOfMeasure:
{
Description: Unit of measure ,
Required: False ,
}
string ,
includedQuantity:
{
Description: Included quality for an offer ,
Format: decimal ,
Required: False ,
}
number ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
unitPrice:
{
Description: Unit Price ,
Format: decimal ,
Required: False ,
}
number ,
currencyCode:
{
Description: Currency Code ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
download:
{
Description: Pricesheet download details. ,
Required: False ,
}
{
meterName:
{
Description: The name of the meter, within the given meter category ,
Required: False ,
}
string ,
meterCategory:
{
Description: The category of the meter, for example, 'Cloud services', 'Networking', etc.. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. ,
Required: False ,
}
string ,
unit:
{
Description: The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. ,
Required: False ,
}
string ,
meterLocation:
{
Description: The location in which the Azure service is available. ,
Required: False ,
}
string ,
totalIncludedQuantity:
{
Description: The total included quantity associated with the offer. ,
Format: decimal ,
Required: False ,
}
number ,
pretaxStandardRate:
{
Description: The pretax listing price. ,
Format: decimal ,
Required: False ,
}
number ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
serviceTier:
{
Description: The service tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
id:
{
Description: Operation Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AggregatedCost_GetByManagementGroup (removed)
Description :  Provides the aggregate cost of a management group and all child management groups by current billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Management Group Aggregated Cost. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the aggregated cost belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed Separately. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
children:
{
Description: Children of a management group ,
Required: False ,
}
[
string ,
]
,
includedSubscriptions:
{
Description: List of subscription Guids included in the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
excludedSubscriptions:
{
Description: List of subscription Guids excluded from the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AggregatedCost_GetForBillingPeriodByManagementGroup (removed)
Description :  Provides the aggregate cost of a management group and all child management groups by specified billing period
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/aggregatedCost
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Management Group Aggregated Cost. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the aggregated cost belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: The start of the date time range covered by aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: The end of the date time range covered by the aggregated cost. ,
Format: date-time ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed Separately. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
children:
{
Description: Children of a management group ,
Required: False ,
}
[
string ,
]
,
includedSubscriptions:
{
Description: List of subscription Guids included in the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
excludedSubscriptions:
{
Description: List of subscription Guids excluded from the calculation of aggregated cost ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Events_ListByBillingProfile (removed)
Description :  Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: The date of the event. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the event. ,
Required: False ,
}
string ,
newCredit:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: The amount of balance adjustment. The property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
charges:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance after the event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: Identifies the type of the event. ,
Enum:
{
SettledCharges: No description available. ,
PendingCharges: No description available. ,
PendingAdjustments: No description available. ,
PendingNewCredit: No description available. ,
PendingExpiredCredit: No description available. ,
UnKnown: No description available. ,
NewCredit: No description available. ,
CreditExpired: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
lotId:
{
Description: The ID that uniquely identifies the lot for which the event happened. ,
Required: False ,
}
string ,
lotSource:
{
Description: Identifies the source of the lot for which the event happened. ,
Required: False ,
}
string ,
canceledCredit:
{
Description: Amount of canceled credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency of the event. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the event. ,
Required: False ,
}
string ,
reseller:
{
Description: The reseller of the event. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
creditExpiredInBillingCurrency:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
newCreditInBillingCurrency:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
adjustmentsInBillingCurrency:
{
Description: The amount of balance adjustment in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
chargesInBillingCurrency:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance in billing currency after the event. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Events_ListByBillingAccount (removed)
Description :  Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the events by lotId, lotSource etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: The date of the event. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the event. ,
Required: False ,
}
string ,
newCredit:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: The amount of balance adjustment. The property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
charges:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance after the event. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: Identifies the type of the event. ,
Enum:
{
SettledCharges: No description available. ,
PendingCharges: No description available. ,
PendingAdjustments: No description available. ,
PendingNewCredit: No description available. ,
PendingExpiredCredit: No description available. ,
UnKnown: No description available. ,
NewCredit: No description available. ,
CreditExpired: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ,
Required: False ,
}
string ,
lotId:
{
Description: The ID that uniquely identifies the lot for which the event happened. ,
Required: False ,
}
string ,
lotSource:
{
Description: Identifies the source of the lot for which the event happened. ,
Required: False ,
}
string ,
canceledCredit:
{
Description: Amount of canceled credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency of the event. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the event. ,
Required: False ,
}
string ,
reseller:
{
Description: The reseller of the event. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
creditExpiredInBillingCurrency:
{
Description: The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
newCreditInBillingCurrency:
{
Description: The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
adjustmentsInBillingCurrency:
{
Description: The amount of balance adjustment in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
chargesInBillingCurrency:
{
Description: The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance in billing currency after the event. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByBillingProfile (removed)
Description :  Lists all Azure credits for a billing account or a billing profile. The API is only supported for Microsoft Customer Agreements (MCA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByBillingAccount (removed)
Description :  Lists all Microsoft Azure consumption commitments for a billing account. The API is only supported for Microsoft Customer Agreements (MCA) and Direct Enterprise Agreement (EA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Lots_ListByCustomer (removed)
Description :  Lists all Azure credits for a customer. The API is only supported for Microsoft Partner Agreements (MPA) billing accounts.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
customerId:
{
Description: Customer ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: The original amount of a lot. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: The balance as of the last invoice. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
source:
{
Description: The source of the lot. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
ConsumptionCommitment: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: The date when the lot became effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of a lot. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots. ,
Required: False ,
}
string ,
purchasedDate:
{
Description: The date when the lot was added. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the lot. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Inactive: No description available. ,
Expired: No description available. ,
Complete: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creditCurrency:
{
Description: The currency of the lot. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency of the lot. ,
Required: False ,
}
string ,
originalAmountInBillingCurrency:
{
Description: The original amount of a lot in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
closedBalanceInBillingCurrency:
{
Description: The balance as of the last invoice in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
reseller:
{
Description: The reseller of the lot. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Credits_Get (removed)
Description :  The credit summary by billingAccountId and billingProfileId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credit summary. ,
Required: False ,
}
{
balanceSummary:
{
Description: Summary of balances associated with this credit summary. ,
Required: False ,
}
{
estimatedBalance:
{
Description: Estimated balance. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
currentBalance:
{
Description: Current balance. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
estimatedBalanceInBillingCurrency:
{
Description: Estimated balance in billing currency. ,
Required: False ,
}
{
exchangeRate:
{
Description: The exchange rate. ,
Format: decimal ,
Required: False ,
}
number ,
exchangeRateMonth:
{
Description: The exchange rate month. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
pendingCreditAdjustments:
{
Description: Pending credit adjustments. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
expiredCredit:
{
Description: Expired credit. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
pendingEligibleCharges:
{
Description: Pending eligible charges. ,
Required: False ,
}
{
currency:
{
Description: Amount currency. ,
Required: False ,
}
string ,
value:
{
Description: Amount. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
creditCurrency:
{
Description: The credit currency. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The billing currency. ,
Required: False ,
}
string ,
reseller:
{
Description: Credit's reseller. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller property ID. ,
Required: False ,
}
string ,
resellerDescription:
{
Description: The reseller property description. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: The eTag for the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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