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

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

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByBillingPeriod (new)
Description :  Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByBillingAccount (new)
Description :  Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByBillingAccount (new)
Description :  Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByDepartment (new)
Description :  Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails
{
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByDepartment (new)
Description :  Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByEnrollmentAccount (new)
Description :  Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails
{
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByEnrollmentAccount (new)
Description :  Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
Marketplaces_List (new)
Description :  Lists the marketplaces for a scope by subscriptionId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
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 (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_ListByBillingPeriod (new)
Description :  Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are 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/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByBillingAccount (new)
Description :  Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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 ,
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 (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_ListForBillingPeriodByBillingAccount (new)
Description :  Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByDepartment (new)
Description :  Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
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 ,
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 (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_ListForBillingPeriodByDepartment (new)
Description :  Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByEnrollmentAccount (new)
Description :  Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
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 ,
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 (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_ListForBillingPeriodByEnrollmentAccount (new)
Description :  Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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 2018-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}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-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 2018-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 ,
}
,
}
,
]
,
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 2018-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 ,
}
,
}
,
]
,
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.
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 2018-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 ,
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 ,
}
,
}
,
]
,
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.
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 2018-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 ,
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 ,
}
,
}
,
]
,
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:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/reservationRecommendations
{
$filter:
{
Description: May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation recommendation. ,
Required: False ,
}
{
lookBackPeriod:
{
Description: The number of days of usage to look back for recommendation. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
term:
{
Description: RI recommendations in one or three year terms. ,
Required: False ,
}
string ,
costWithNoReservedInstances:
{
Description: The total amount of cost without reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
recommendedQuantity:
{
Description: Recommended quality for reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
totalCostWithReservedInstances:
{
Description: The total amount of cost with reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
netSavings:
{
Description: Total estimated savings with reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
firstUsageDate:
{
Description: The usage date for looking back. ,
Format: date-time ,
Required: False ,
}
string ,
scope:
{
Description: Shared or single recommendation. ,
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_List (new)
Description :  Lists all budgets for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
]
,
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_ListByResourceGroupName (new)
Description :  Lists all budgets for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
]
,
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 a subscription by budget name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
}
,
}
Budgets_GetByResourceGroupName (new)
Description :  Gets the budget for a resource group under a subscription by budget name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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_CreateOrUpdateByResourceGroupName (new)
Description :  The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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_DeleteByResourceGroupName (new)
Description :  The operation to delete a budget.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
}
,
}
PriceSheet_Get (new)
Description :  Gets the price sheet for a scope by subscriptionId. 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. ,
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 2018-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 ,
}
,
}

⚐ 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. ,
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 2018-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 ,
}
,
}

⚐ 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 a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/tags
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
Forecasts_List (new)
Description :  Lists the forecast charges by subscriptionId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts
{
$filter:
{
Description: May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of forecasts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the forecast charge. ,
Required: False ,
}
{
usageDate:
{
Description: The usage date of the forecast. ,
Required: False ,
}
string ,
grain:
{
Description: The granularity of forecast. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
Yearly: No description available. ,
}
,
Required: False ,
}
enum ,
charge:
{
Description: The amount of charge ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
chargeType:
{
Description: The type of the charge. Could be actual or forecast ,
Enum:
{
Actual: No description available. ,
Forecast: No description available. ,
}
,
Required: False ,
}
enum ,
confidenceLevels:
{
Description: The details about the forecast confidence levels. This is populated only when chargeType is Forecast. ,
Required: False ,
}
[
{
percentage:
{
Description: The percentage level of the confidence ,
Format: decimal ,
Required: False ,
}
number ,
bound:
{
Description: The boundary of the percentage, values could be 'Upper' or 'Lower' ,
Enum:
{
Upper: No description available. ,
Lower: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The amount of forecast within the percentage level ,
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 ,
}
,
}
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 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByManagementGroup (new)
Description :  Lists the usage detail records for all subscriptions belonging to a management group scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/usageDetails
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByManagementGroup (new)
Description :  Lists the usage detail records for all subscriptions belonging to a management group scope by specified billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
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 2018-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}/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 2018-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 ,
}
,
}
Charges_ListByEnrollmentAccount (new)
Description :  Lists the charges by enrollmentAccountId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListForBillingPeriodByEnrollmentAccount (new)
Description :  Lists the charges based on enrollmentAccountId by billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount 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 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListByDepartment (new)
Description :  Lists the charges by departmentId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListForBillingPeriodByDepartment (new)
Description :  Lists the charges based on departmentId by billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department 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 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Tenants_Get (new)
Description :  Gets a Tenant Properties.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of tenant details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the tenants. ,
Required: False ,
}
{
billingProfileName:
{
Description: The Billing Profile name. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The Billing AccountId. ,
Required: False ,
}
string ,
tenantId:
{
Description: The TenantId. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The Billing Account Name. ,
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 ,
}
,
}
Marketplaces_ListByManagementGroup (new)
Description :  Lists the marketplace records for all subscriptions belonging to a management group scope by current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Azure Management Group ID. ,
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 ,
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 (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_ListForBillingPeriodByManagementGroup (new)
Description :  Lists the marketplace records for all subscriptions belonging to a management group scope by specified billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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 a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByBillingPeriod (removed)
Description :  Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByBillingAccount (removed)
Description :  Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByBillingAccount (removed)
Description :  Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByDepartment (removed)
Description :  Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails
{
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByDepartment (removed)
Description :  Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByEnrollmentAccount (removed)
Description :  Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails
{
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByEnrollmentAccount (removed)
Description :  Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
Marketplaces_List (removed)
Description :  Lists the marketplaces for a scope by subscriptionId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
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 (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_ListByBillingPeriod (removed)
Description :  Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are 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/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByBillingAccount (removed)
Description :  Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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 ,
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 (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_ListForBillingPeriodByBillingAccount (removed)
Description :  Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByDepartment (removed)
Description :  Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
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 ,
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 (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_ListForBillingPeriodByDepartment (removed)
Description :  Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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_ListByEnrollmentAccount (removed)
Description :  Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
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 ,
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 (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_ListForBillingPeriodByEnrollmentAccount (removed)
Description :  Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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 2018-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}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-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 2018-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 ,
}
,
}
,
]
,
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 2018-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 ,
}
,
}
,
]
,
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.
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 2018-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 ,
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 ,
}
,
}
,
]
,
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.
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 2018-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 ,
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 ,
}
,
}
,
]
,
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:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/reservationRecommendations
{
$filter:
{
Description: May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation recommendation. ,
Required: False ,
}
{
lookBackPeriod:
{
Description: The number of days of usage to look back for recommendation. ,
Required: False ,
}
string ,
meterId:
{
Description: The meter id (GUID) ,
Format: uuid ,
Required: False ,
}
string ,
term:
{
Description: RI recommendations in one or three year terms. ,
Required: False ,
}
string ,
costWithNoReservedInstances:
{
Description: The total amount of cost without reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
recommendedQuantity:
{
Description: Recommended quality for reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
totalCostWithReservedInstances:
{
Description: The total amount of cost with reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
netSavings:
{
Description: Total estimated savings with reserved instances. ,
Format: decimal ,
Required: False ,
}
number ,
firstUsageDate:
{
Description: The usage date for looking back. ,
Format: date-time ,
Required: False ,
}
string ,
scope:
{
Description: Shared or single recommendation. ,
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_List (removed)
Description :  Lists all budgets for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
]
,
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_ListByResourceGroupName (removed)
Description :  Lists all budgets for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
]
,
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 a subscription by budget name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
}
,
}
Budgets_GetByResourceGroupName (removed)
Description :  Gets the budget for a resource group under a subscription by budget name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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_CreateOrUpdateByResourceGroupName (removed)
Description :  The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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. ,
Usage: 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. ,
Enum:
{
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: 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 three 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 ,
}
,
filters:
{
Description: May be used to filter budgets by resource group, resource, or meter. ,
Required: False ,
}
{
resourceGroups:
{
Description: The list of filters on resource groups, allowed at subscription level only. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The list of filters on resources. ,
Required: False ,
}
[
string ,
]
,
meters:
{
Description: The list of filters on meters (GUID), mandatory for budgets of usage category. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: The dictionary of filters on tags. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
}

⚐ 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_DeleteByResourceGroupName (removed)
Description :  The operation to delete a budget.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
}
,
}
PriceSheet_Get (removed)
Description :  Gets the price sheet for a scope by subscriptionId. 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. ,
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 2018-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 ,
}
,
}

⚐ 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. ,
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 2018-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 ,
}
,
}

⚐ 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 a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/tags
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
Forecasts_List (removed)
Description :  Lists the forecast charges by subscriptionId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts
{
$filter:
{
Description: May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of forecasts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the forecast charge. ,
Required: False ,
}
{
usageDate:
{
Description: The usage date of the forecast. ,
Required: False ,
}
string ,
grain:
{
Description: The granularity of forecast. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
Yearly: No description available. ,
}
,
Required: False ,
}
enum ,
charge:
{
Description: The amount of charge ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: The ISO currency in which the meter is charged, for example, USD. ,
Required: False ,
}
string ,
chargeType:
{
Description: The type of the charge. Could be actual or forecast ,
Enum:
{
Actual: No description available. ,
Forecast: No description available. ,
}
,
Required: False ,
}
enum ,
confidenceLevels:
{
Description: The details about the forecast confidence levels. This is populated only when chargeType is Forecast. ,
Required: False ,
}
[
{
percentage:
{
Description: The percentage level of the confidence ,
Format: decimal ,
Required: False ,
}
number ,
bound:
{
Description: The boundary of the percentage, values could be 'Upper' or 'Lower' ,
Enum:
{
Upper: No description available. ,
Lower: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The amount of forecast within the percentage level ,
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 ,
}
,
}
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 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListByManagementGroup (removed)
Description :  Lists the usage detail records for all subscriptions belonging to a management group scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/usageDetails
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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 (:). ,
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. ,
Required: False ,
}
integer ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
UsageDetails_ListForBillingPeriodByManagementGroup (removed)
Description :  Lists the usage detail records for all subscriptions belonging to a management group scope by specified billing period. Usage details are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails
{
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties/additionalProperties 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/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'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
$apply:
{
Description: OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period ,
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. ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usage details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the usage detail. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The id of the invoice 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 ,
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 ,
instanceLocation:
{
Description: The location 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 ,
usageQuantity:
{
Description: The quantity of usage. ,
Format: decimal ,
Required: False ,
}
number ,
billableQuantity:
{
Description: The billable usage quantity. ,
Format: decimal ,
Required: False ,
}
number ,
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 ,
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 ,
}
,
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 ,
product:
{
Description: Product 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 ,
partNumber:
{
Description: Part Number ,
Required: False ,
}
string ,
resourceGuid:
{
Description: Resource Guid ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id ,
Required: False ,
}
string ,
chargesBilledSeparately:
{
Description: Charges billed separately ,
Required: False ,
}
boolean ,
location:
{
Description: Resource Location ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
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 2018-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}/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 2018-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 ,
}
,
}
Charges_ListByEnrollmentAccount (removed)
Description :  Lists the charges by enrollmentAccountId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListForBillingPeriodByEnrollmentAccount (removed)
Description :  Lists the charges based on enrollmentAccountId by billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: EnrollmentAccount 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 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListByDepartment (removed)
Description :  Lists the charges by departmentId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Charges_ListForBillingPeriodByDepartment (removed)
Description :  Lists the charges based on departmentId by billing period.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department 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 2018-10-01. ,
Required: True ,
}
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the charge belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Format: decimal ,
Required: False ,
}
number ,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Format: decimal ,
Required: False ,
}
number ,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Format: decimal ,
Required: False ,
}
number ,
currency:
{
Description: Currency Code ,
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 ,
}
,
}
Tenants_Get (removed)
Description :  Gets a Tenant Properties.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of tenant details. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the tenants. ,
Required: False ,
}
{
billingProfileName:
{
Description: The Billing Profile name. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The Billing AccountId. ,
Required: False ,
}
string ,
tenantId:
{
Description: The TenantId. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The Billing Account Name. ,
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 ,
}
,
}
Marketplaces_ListByManagementGroup (removed)
Description :  Lists the marketplace records for all subscriptions belonging to a management group scope by current billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Azure Management Group ID. ,
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 ,
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 (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_ListForBillingPeriodByManagementGroup (removed)
Description :  Lists the marketplace records for all subscriptions belonging to a management group scope by specified billing period. Marketplaces are available via this API only for May 1, 2014 or later.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/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. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-10-01. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Azure Management Group ID. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: Billing Period Name. ,
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 ,
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 (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 ,
}
,
}