Microsoft.CostManagement (preview:2024-10-01)

2025/02/26 • 63 new methods

Operations_List (new)
Description :  Lists all of the available cost management REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of cost management operations supported by the Microsoft.CostManagement resource provider. ,
Required: False ,
}
[
{
id:
{
Description: Operation id: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations
{
$filter:
{
Description: Can be used to filter benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to order the recommendations by: properties/armSkuName. For the savings plan, the results are in order by default. There is no need to use this clause. ,
Required: False ,
}
string ,
$expand:
{
Description: May be used to expand the properties by: properties/usage, properties/allRecommendationDetails ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingScope:
{
Description: The scope associated with benefit recommendation operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for enterprise agreement scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of benefit recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the benefit recommendations. ,
Required: False ,
}
{
firstConsumptionDate:
{
Description: The first usage date used for looking back for computing the recommendations. ,
Format: date-time ,
Required: False ,
}
string ,
lastConsumptionDate:
{
Description: The last usage date used for looking back for computing the recommendations. ,
Format: date-time ,
Required: False ,
}
string ,
lookBackPeriod:
{
Description: The number of days of usage evaluated for computing the recommendations. ,
Enum:
{
Last7Days: 7 days used to look back. ,
Last30Days: 30 days used to look back. ,
Last60Days: 60 days used to look back. ,
}
,
Required: False ,
}
enum ,
totalHours:
{
Description: The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'. ,
Format: int32 ,
Required: False ,
}
integer ,
usage:
{
Description: On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations. ,
Required: False ,
}
{
usageGrain:
{
Description: The grain of the usage. Supported values: 'Hourly' ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: False ,
}
enum ,
charges:
{
Description: On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations. ,
Required: False ,
}
[
number ,
]
,
}
,
armSkuName:
{
Description: ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan. ,
Required: False ,
}
string ,
term:
{
Description: Term period of the benefit. For example, P1Y or P3Y. ,
Enum:
{
P1Y: Benefit term is 1 year. ,
P3Y: Benefit term is 3 years. ,
}
,
Required: False ,
}
enum ,
commitmentGranularity:
{
Description: Grain of the proposed commitment amount. Supported values: 'Hourly' ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: False ,
}
enum ,
currencyCode:
{
Description: An ISO 4217 currency code identifier for the costs and savings amounts. ,
Required: False ,
}
string ,
costWithoutBenefit:
{
Description: The current cost without benefit, corresponds to 'totalHours' in the look-back period. ,
Format: decimal ,
Required: False ,
}
number ,
recommendationDetails:
{
Description: The details of the proposed recommendation. ,
Required: False ,
}
{
overageCost:
{
Description: The difference between total cost and benefit cost for the 'totalHours' in the look-back period. ,
Format: decimal ,
Required: False ,
}
number ,
benefitCost:
{
Description: The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours) ,
Format: decimal ,
Required: False ,
}
number ,
totalCost:
{
Description: Total cost, which is sum of benefit cost and overage cost. ,
Format: decimal ,
Required: False ,
}
number ,
savingsAmount:
{
Description: The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit. ,
Format: decimal ,
Required: False ,
}
number ,
savingsPercentage:
{
Description: The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit. ,
Format: decimal ,
Required: False ,
}
number ,
coveragePercentage:
{
Description: Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment. ,
Format: decimal ,
Required: False ,
}
number ,
commitmentAmount:
{
Description: The commitment amount at the commitmentGranularity. ,
Format: decimal ,
Required: False ,
}
number ,
averageUtilizationPercentage:
{
Description: Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment. ,
Format: decimal ,
Required: False ,
}
number ,
wastageCost:
{
Description: Estimated unused portion of the 'benefitCost'. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
allRecommendationDetails:
{
Description: The list of all benefit recommendations with the recommendation details. ,
Required: False ,
}
{
value:
{
Description: The list of benefit recommendations with the recommendation details.. ,
Required: False ,
}
[
{
overageCost:
{
Description: The difference between total cost and benefit cost for the 'totalHours' in the look-back period. ,
Format: decimal ,
Required: False ,
}
number ,
benefitCost:
{
Description: The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours) ,
Format: decimal ,
Required: False ,
}
number ,
totalCost:
{
Description: Total cost, which is sum of benefit cost and overage cost. ,
Format: decimal ,
Required: False ,
}
number ,
savingsAmount:
{
Description: The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit. ,
Format: decimal ,
Required: False ,
}
number ,
savingsPercentage:
{
Description: The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit. ,
Format: decimal ,
Required: False ,
}
number ,
coveragePercentage:
{
Description: Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment. ,
Format: decimal ,
Required: False ,
}
number ,
commitmentAmount:
{
Description: The commitment amount at the commitmentGranularity. ,
Format: decimal ,
Required: False ,
}
number ,
averageUtilizationPercentage:
{
Description: Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment. ,
Format: decimal ,
Required: False ,
}
number ,
wastageCost:
{
Description: Estimated unused portion of the 'benefitCost'. ,
Format: decimal ,
Required: False ,
}
number ,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
scope:
{
Description: Benefit scope. For example, Single or Shared. ,
Enum:
{
Single: Single scope recommendation. ,
Shared: Shared scope recommendation. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
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 ,
}
,
}
BenefitUtilizationSummaries_ListByBillingAccountId (new)
Description :  Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Billing account ID ,
Required: True ,
}
string ,
grainParameter:
{
Description: Grain. ,
Required: False ,
}
string ,
filter:
{
Description: Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of benefit utilization summaries. ,
Required: False ,
}
[
{
kind:
{
Description: Supported values: 'SavingsPlan'. ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
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 ,
}
,
}
BenefitUtilizationSummaries_ListByBillingProfileId (new)
Description :  Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Billing account ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing profile ID. ,
Required: True ,
}
string ,
grainParameter:
{
Description: Grain. ,
Required: False ,
}
string ,
filter:
{
Description: Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of benefit utilization summaries. ,
Required: False ,
}
[
{
kind:
{
Description: Supported values: 'SavingsPlan'. ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
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 ,
}
,
}
BenefitUtilizationSummaries_ListBySavingsPlanOrder (new)
Description :  Lists the savings plan utilization summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Supports filtering by properties/usageDate. ,
Required: False ,
}
string ,
grainParameter:
{
Description: Grain. ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Savings plan order ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of benefit utilization summaries. ,
Required: False ,
}
[
{
kind:
{
Description: Supported values: 'SavingsPlan'. ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
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 ,
}
,
}
BenefitUtilizationSummaries_ListBySavingsPlanId (new)
Description :  Lists the savings plan utilization summaries for daily or monthly grain.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Supports filtering by properties/usageDate. ,
Required: False ,
}
string ,
grainParameter:
{
Description: Grain. ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Savings plan order ID. ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: Savings plan ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of benefit utilization summaries. ,
Required: False ,
}
[
{
kind:
{
Description: Supported values: 'SavingsPlan'. ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (URL) to the next page of results. ,
Format: uri ,
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 ,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
billingAccountId:
{
Description: Billing account ID ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
billingAccountId:
{
Description: Billing account ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing profile ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided reservation order.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
reservationOrderId:
{
Description: Reservation Order ID ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateByReservationId (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided reservation.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
reservationOrderId:
{
Description: Reservation Order ID ,
Required: True ,
}
string ,
reservationId:
{
Description: Reservation ID ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided savings plan order.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
savingsPlanOrderId:
{
Description: Savings plan order ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId (new)
Description :  Triggers generation of a benefit utilization summaries report for the provided savings plan.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
{
savingsPlanOrderId:
{
Description: Savings plan order ID. ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: Savings plan ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
benefitUtilizationSummariesRequest:
{
Description: Async Benefit Utilization Summary report to be created. ,
Required: True ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
input:
{
Description: Input given to create the benefit utilization summaries report. ,
Required: False ,
}
{
billingAccountId:
{
Description: Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. ,
Required: False ,
}
string ,
benefitOrderId:
{
Description: Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. ,
Required: False ,
}
string ,
benefitId:
{
Description: Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. ,
Required: False ,
}
string ,
grain:
{
Description: The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. ,
Enum:
{
Hourly: Hourly grain corresponds to value per hour. ,
Daily: Hourly grain corresponds to value per day. ,
Monthly: Hourly grain corresponds to value per month. ,
}
,
Required: True ,
}
enum ,
startDate:
{
Description: The start date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date of the summaries data that will be served in the report. ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan ,
Enum:
{
IncludedQuantity: Benefit is IncludedQuantity. ,
Reservation: Benefit is Reservation. ,
SavingsPlan: Benefit is SavingsPlan. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the creation of the benefit utilization summaries report. ,
Enum:
{
Running: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state ,
Required: False ,
}
{
reportUrl:
{
Description: Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryReportUrl:
{
Description: Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state. ,
Enum:
{
Kind: No description available. ,
AvgUtilizationPercentage: No description available. ,
BenefitOrderId: No description available. ,
BenefitId: No description available. ,
BenefitType: No description available. ,
MaxUtilizationPercentage: No description available. ,
MinUtilizationPercentage: No description available. ,
UsageDate: No description available. ,
UtilizedPercentage: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The date that the sas url provided in reportUrl expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Budgets_List (new)
Description :  Lists all budgets for the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/budgets
{
scope:
{
Description: The scope associated with budget operations. Supported scopes for **CategoryType: Cost** Azure RBAC Scopes: - '/subscriptions/{subscriptionId}/' for subscription scope - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope - '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) Supported scopes for **CategoryType: ReservationUtilization** EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only) - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only. ,
Required: False ,
}
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. - 'Cost' defines a Budget. - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. ,
Enum:
{
Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ,
ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget. Supported for CategoryType(s): Cost. Required for CategoryType(s): Cost. ,
Required: False ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for **CategoryType: Cost** - Monthly - Quarterly - Annually - BillingMonth* - BillingQuarter* - BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for **CategoryType: ReservationUtilization** - Last7Days - Last30Days Required for CategoryType(s): Cost, ReservationUtilization. ,
Enum:
{
Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. ,
Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. ,
Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. ,
BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. Supported for CategoryType(s): Cost. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
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. Supported for CategoryType(s): Cost, ReservationUtilization. - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. Supported scopes for **CategoryType: Cost** Azure RBAC Scopes: - '/subscriptions/{subscriptionId}/' for subscription scope - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope - '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) Supported scopes for **CategoryType: ReservationUtilization** EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only) - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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. - 'Cost' defines a Budget. - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. ,
Enum:
{
Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ,
ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget. Supported for CategoryType(s): Cost. Required for CategoryType(s): Cost. ,
Required: False ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for **CategoryType: Cost** - Monthly - Quarterly - Annually - BillingMonth* - BillingQuarter* - BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for **CategoryType: ReservationUtilization** - Last7Days - Last30Days Required for CategoryType(s): Cost, ReservationUtilization. ,
Enum:
{
Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. ,
Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. ,
Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. ,
BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. Supported for CategoryType(s): Cost. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
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. Supported for CategoryType(s): Cost, ReservationUtilization. - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. Supported scopes for **CategoryType: Cost** Azure RBAC Scopes: - '/subscriptions/{subscriptionId}/' for subscription scope - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope - '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) Supported scopes for **CategoryType: ReservationUtilization** EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only) - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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. - 'Cost' defines a Budget. - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. ,
Enum:
{
Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ,
ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget. Supported for CategoryType(s): Cost. Required for CategoryType(s): Cost. ,
Required: False ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for **CategoryType: Cost** - Monthly - Quarterly - Annually - BillingMonth* - BillingQuarter* - BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for **CategoryType: ReservationUtilization** - Last7Days - Last30Days Required for CategoryType(s): Cost, ReservationUtilization. ,
Enum:
{
Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. ,
Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. ,
Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. ,
BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. Supported for CategoryType(s): Cost. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
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. Supported for CategoryType(s): Cost, ReservationUtilization. - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget. - 'Cost' defines a Budget. - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. ,
Enum:
{
Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ,
ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget. Supported for CategoryType(s): Cost. Required for CategoryType(s): Cost. ,
Required: False ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for **CategoryType: Cost** - Monthly - Quarterly - Annually - BillingMonth* - BillingQuarter* - BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for **CategoryType: ReservationUtilization** - Last7Days - Last30Days Required for CategoryType(s): Cost, ReservationUtilization. ,
Enum:
{
Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. ,
Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. ,
Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. ,
BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. Supported for CategoryType(s): Cost. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
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. Supported for CategoryType(s): Cost, ReservationUtilization. - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the budget. ,
Required: False ,
}
{
category:
{
Description: The category of the budget. - 'Cost' defines a Budget. - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. ,
Enum:
{
Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ,
ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. ,
}
,
Required: True ,
}
enum ,
amount:
{
Description: The total amount of cost to track with the budget. Supported for CategoryType(s): Cost. Required for CategoryType(s): Cost. ,
Required: False ,
}
number ,
timeGrain:
{
Description: The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for **CategoryType: Cost** - Monthly - Quarterly - Annually - BillingMonth* - BillingQuarter* - BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for **CategoryType: ReservationUtilization** - Last7Days - Last30Days Required for CategoryType(s): Cost, ReservationUtilization. ,
Enum:
{
Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. ,
Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. ,
Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. ,
BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. ,
Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization. ,
Required: True ,
}
{
startDate:
{
Description: The start date for the budget. - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date for the budget. - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
filter:
{
Description: May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. Supported for CategoryType(s): Cost. ,
Required: False ,
}
[
{
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
dimensions:
{
Description: Has comparison expression for a dimension. Supported for CategoryType(s): Cost, ReservationUtilization. Supported dimension names for **CategoryType: ReservationUtilization** - ReservationId - ReservedResourceType ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
currentSpend:
{
Description: The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The total amount of cost which is being tracked by the budget. ,
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. Supported for CategoryType(s): Cost, ReservationUtilization. - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. ,
Required: False ,
}
object ,
forecastSpend:
{
Description: The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost. ,
Required: False ,
}
{
amount:
{
Description: The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. ,
Required: False ,
}
number ,
unit:
{
Description: The unit of measure for the budget amount. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}
{
scope:
{
Description: The scope associated with budget operations. Supported scopes for **CategoryType: Cost** Azure RBAC Scopes: - '/subscriptions/{subscriptionId}/' for subscription scope - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope - '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) Supported scopes for **CategoryType: ReservationUtilization** EA (Enterprise Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope MCA (Modern Customer Agreement) Scopes: - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only) - '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}
Exports_List (new)
Description :  The operation to list all exports at the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last run of each export. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of exports. ,
Required: False ,
}
[
{
identity:
{
Description: The managed identity associated with Export ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location of the Export's managed identity. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
SystemSuspended: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
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 ,
}
,
}
Exports_Get (new)
Description :  The operation to get the export for the defined scope by export name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity associated with Export ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location of the Export's managed identity. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
SystemSuspended: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
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 ,
}
,
}
Exports_CreateOrUpdate (new)
Description :  The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: True ,
}
{
identity:
{
Description: The managed identity associated with Export ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location of the Export's managed identity. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
SystemSuspended: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity associated with Export ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location of the Export's managed identity. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
SystemSuspended: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The managed identity associated with Export ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location of the Export's managed identity. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
SystemSuspended: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
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 ,
}
,
}
Exports_Delete (new)
Description :  The operation to delete a export.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
exportName:
{
Description: Export 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 ,
}
,
}
Exports_Execute (new)
Description :  The operation to run an export.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: False ,
}
{
timePeriod:
{
Description: Has time period for pulling data for the export. ,
Required: False ,
}
{
from:
{
Description: The start date for export data. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date for export data. ,
Format: date-time ,
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 ,
}
,
}
Exports_GetExecutionHistory (new)
Description :  The operation to get the run history of an export for the defined scope and export name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of export runs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export run. ,
Required: False ,
}
{
executionType:
{
Description: The type of the export run. ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The last known status of the export run. ,
Enum:
{
Queued: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Timeout: No description available. ,
NewDataNotAvailable: No description available. ,
DataNotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
submittedBy:
{
Description: The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'. ,
Required: False ,
}
string ,
submittedTime:
{
Description: The time when export was queued to be run. ,
Format: date-time ,
Required: False ,
}
string ,
processingStartTime:
{
Description: The time when export was picked up to be run. ,
Format: date-time ,
Required: False ,
}
string ,
startDate:
{
Description: The start datetime for the export. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end datetime for the export. ,
Format: date-time ,
Required: False ,
}
string ,
processingEndTime:
{
Description: The time when the export run finished. ,
Format: date-time ,
Required: False ,
}
string ,
fileName:
{
Description: The name of the exported file. ,
Required: False ,
}
string ,
manifestFile:
{
Description: The manifest file location(URI location) for the exported files. ,
Required: False ,
}
string ,
runSettings:
{
Required: False ,
}
string ,
error:
{
Description: The details of any error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
GenerateCostDetailsReport_CreateOperation (new)
Description :  This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport
{
scope:
{
Description: The ARM Resource ID for subscription, billing account, or other billing scopes.Currently Resource Group and Management Group are not supported. For details, see https://aka.ms/costmgmt/scopes. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create cost details operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the result of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateCostDetailsReport_GetOperationResults (new)
Description :  Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}
{
scope:
{
Description: The ARM Resource ID for subscription, billing account, or other billing scopes.Currently Resource Group and Management Group are not supported. For details, see https://aka.ms/costmgmt/scopes. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
GenerateDetailedCostReport_CreateOperation (new)
Description :  Generates the detailed cost report for provided date range, billing period(only enterprise customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport
{
scope:
{
Description: The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create detailed cost report operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: Billing period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
invoiceId:
{
Description: Invoice ID for Pay-as-you-go and Microsoft Customer Agreement scopes. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM resource id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
expiryTime:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
downloadUrl:
{
Description: The URL to download the generated report. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the result of the asynchronous operation. ,
}
string ,
azure-consumption-asyncoperation:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ 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 ,
}
,
}
GenerateDetailedCostReportOperationResults_Get (new)
Description :  Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ARM resource id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
expiryTime:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
downloadUrl:
{
Description: The URL to download the generated report. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
GenerateDetailedCostReportOperationStatus_Get (new)
Description :  Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the long running operation. ,
Required: False ,
}
{
status:
{
Description: The status of the long running operation. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Queued: No description available. ,
NoDataFound: No description available. ,
ReadyToDownload: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startTime:
{
Description: The startTime of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The endTime of the operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
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 ,
}
,
properties:
{
Description: The properties of the usage file generated. ,
Required: False ,
}
{
expiryTime:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
downloadUrl:
{
Description: The URL to download the generated report. ,
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 ,
}
,
}
Views_List (new)
Description :  Lists all views by tenant and object.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/views
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of views. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_ListByScope (new)
Description :  Lists all views at the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/views
{
scope:
{
Description: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of views. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_Get (new)
Description :  Gets the view by view name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/views/{viewName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_CreateOrUpdate (new)
Description :  The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/views/{viewName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate View operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_Delete (new)
Description :  The operation to delete a view.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/views/{viewName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/views/{viewName}
{
scope:
{
Description: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_CreateOrUpdateByScope (new)
Description :  The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/views/{viewName}
{
scope:
{
Description: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate View operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the view. ,
Required: False ,
}
{
displayName:
{
Description: User input name of the view. Required. ,
Required: False ,
}
string ,
scope:
{
Description: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
createdOn:
{
Description: Date the user created this view. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Date when the user last modified this view. ,
Format: date-time ,
Required: False ,
}
string ,
dateRange:
{
Description: Date range of the current view. ,
Required: False ,
}
string ,
currency:
{
Description: Currency of the current view. ,
Required: False ,
}
string ,
query:
{
Description: Query body configuration. Required. ,
Required: False ,
}
{
type:
{
Description: The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. ,
Enum:
{
Usage: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the report. If custom, then a specific time period must be provided. ,
Enum:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the report. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataSet:
{
Description: Has definition for data in this report config. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the report. Report can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. This version supports subscription lowest possible grain. ,
Required: True ,
}
string ,
}
,
]
,
sorting:
{
Description: Array of order by expression to use in the report. ,
Required: False ,
}
[
{
direction:
{
Description: Direction of sort. ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to sort. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: Has filter expression to use in the report. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
Contains: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeMonetaryCommitment:
{
Description: If true, report includes monetary commitment. ,
Required: False ,
}
boolean ,
}
,
chart:
{
Description: Chart type of the main view in Cost Analysis. Required. ,
Enum:
{
Area: No description available. ,
Line: No description available. ,
StackedColumn: No description available. ,
GroupedColumn: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
accumulated:
{
Description: Show costs accumulated over time. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
metric:
{
Description: Metric to use when displaying costs. ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
AHUB: No description available. ,
}
,
Required: False ,
}
enum ,
kpis:
{
Description: List of KPIs to show in Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: KPI type (Forecast, Budget). ,
Enum:
{
Forecast: No description available. ,
Budget: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID of resource related to metric (budget). ,
Required: False ,
}
string ,
enabled:
{
Description: show the KPI in the UI? ,
Required: False ,
}
boolean ,
}
,
]
,
pivots:
{
Description: Configuration of 3 sub-views in the Cost Analysis UI. ,
Required: False ,
}
[
{
type:
{
Description: Data type to show in view. ,
Enum:
{
Dimension: No description available. ,
TagKey: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Data field to show in view. ,
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 ,
}
,
}
Views_DeleteByScope (new)
Description :  The operation to delete a view.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/views/{viewName}
{
scope:
{
Description: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
viewName:
{
Description: View name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of alerts. ,
Required: False ,
}
[
{
properties:
{
Description: Alert properties. ,
Required: False ,
}
{
definition:
{
Description: defines the type of alert ,
Required: False ,
}
{
type:
{
Description: type of alert ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
Quota: No description available. ,
General: No description available. ,
xCloud: No description available. ,
BudgetForecast: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Alert category ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria that triggered alert ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdApproaching: No description available. ,
CreditThresholdReached: No description available. ,
QuotaThresholdApproaching: No description available. ,
QuotaThresholdReached: No description available. ,
MultiCurrency: No description available. ,
ForecastCostThresholdExceeded: No description available. ,
ForecastUsageThresholdExceeded: No description available. ,
InvoiceDueDateApproaching: No description available. ,
InvoiceDueDateReached: No description available. ,
CrossCloudNewDataAvailable: No description available. ,
CrossCloudCollectionError: No description available. ,
GeneralThresholdError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Alert description ,
Required: False ,
}
string ,
source:
{
Description: Source of alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Alert details ,
Required: False ,
}
{
timeGrainType:
{
Description: Type of timegrain cadence ,
Enum:
{
None: No description available. ,
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: False ,
}
enum ,
periodStartDate:
{
Description: datetime of periodStartDate ,
Required: False ,
}
string ,
triggeredBy:
{
Description: notificationId that triggered this alert ,
Required: False ,
}
string ,
resourceGroupFilter:
{
Description: array of resourceGroups to filter by ,
Required: False ,
}
[
string ,
]
,
resourceFilter:
{
Description: array of resources to filter by ,
Required: False ,
}
[
string ,
]
,
meterFilter:
{
Description: array of meters to filter by ,
Required: False ,
}
[
string ,
]
,
tagFilter:
{
Description: tags to filter by ,
Required: False ,
}
object ,
threshold:
{
Description: notification threshold percentage as a decimal which activated this alert ,
Format: decimal ,
Required: False ,
}
number ,
operator:
{
Description: operator used to compare currentSpend with amount ,
Enum:
{
None: No description available. ,
EqualTo: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqualTo: No description available. ,
LessThan: No description available. ,
LessThanOrEqualTo: No description available. ,
}
,
Required: False ,
}
enum ,
amount:
{
Description: budget threshold amount ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: unit of currency being used ,
Required: False ,
}
string ,
currentSpend:
{
Description: current spend ,
Format: decimal ,
Required: False ,
}
number ,
contactEmails:
{
Description: list of emails to contact ,
Required: False ,
}
[
string ,
]
,
contactGroups:
{
Description: list of action groups to broadcast to ,
Required: False ,
}
[
string ,
]
,
contactRoles:
{
Description: list of contact roles ,
Required: False ,
}
[
string ,
]
,
overridingAlert:
{
Description: overriding alert ,
Required: False ,
}
string ,
departmentName:
{
Description: department name ,
Required: False ,
}
string ,
companyName:
{
Description: company name ,
Required: False ,
}
string ,
enrollmentNumber:
{
Description: enrollment number ,
Required: False ,
}
string ,
enrollmentStartDate:
{
Description: datetime of enrollmentStartDate ,
Required: False ,
}
string ,
enrollmentEndDate:
{
Description: datetime of enrollmentEndDate ,
Required: False ,
}
string ,
invoicingThreshold:
{
Description: invoicing threshold ,
Format: decimal ,
Required: False ,
}
number ,
}
,
costEntityId:
{
Description: related budget ,
Required: False ,
}
string ,
status:
{
Description: alert status ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: dateTime in which alert was created ,
Required: False ,
}
string ,
closeTime:
{
Description: dateTime in which alert was closed ,
Required: False ,
}
string ,
modificationTime:
{
Description: dateTime in which alert was last modified ,
Required: False ,
}
string ,
statusModificationUserName:
{
Description: User who last modified the alert ,
Required: False ,
}
string ,
statusModificationTime:
{
Description: dateTime in which the alert status was last modified ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of alerts 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 ,
}
,
}
Alerts_Get (new)
Description :  Gets the alert for the scope by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert properties. ,
Required: False ,
}
{
definition:
{
Description: defines the type of alert ,
Required: False ,
}
{
type:
{
Description: type of alert ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
Quota: No description available. ,
General: No description available. ,
xCloud: No description available. ,
BudgetForecast: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Alert category ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria that triggered alert ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdApproaching: No description available. ,
CreditThresholdReached: No description available. ,
QuotaThresholdApproaching: No description available. ,
QuotaThresholdReached: No description available. ,
MultiCurrency: No description available. ,
ForecastCostThresholdExceeded: No description available. ,
ForecastUsageThresholdExceeded: No description available. ,
InvoiceDueDateApproaching: No description available. ,
InvoiceDueDateReached: No description available. ,
CrossCloudNewDataAvailable: No description available. ,
CrossCloudCollectionError: No description available. ,
GeneralThresholdError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Alert description ,
Required: False ,
}
string ,
source:
{
Description: Source of alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Alert details ,
Required: False ,
}
{
timeGrainType:
{
Description: Type of timegrain cadence ,
Enum:
{
None: No description available. ,
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: False ,
}
enum ,
periodStartDate:
{
Description: datetime of periodStartDate ,
Required: False ,
}
string ,
triggeredBy:
{
Description: notificationId that triggered this alert ,
Required: False ,
}
string ,
resourceGroupFilter:
{
Description: array of resourceGroups to filter by ,
Required: False ,
}
[
string ,
]
,
resourceFilter:
{
Description: array of resources to filter by ,
Required: False ,
}
[
string ,
]
,
meterFilter:
{
Description: array of meters to filter by ,
Required: False ,
}
[
string ,
]
,
tagFilter:
{
Description: tags to filter by ,
Required: False ,
}
object ,
threshold:
{
Description: notification threshold percentage as a decimal which activated this alert ,
Format: decimal ,
Required: False ,
}
number ,
operator:
{
Description: operator used to compare currentSpend with amount ,
Enum:
{
None: No description available. ,
EqualTo: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqualTo: No description available. ,
LessThan: No description available. ,
LessThanOrEqualTo: No description available. ,
}
,
Required: False ,
}
enum ,
amount:
{
Description: budget threshold amount ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: unit of currency being used ,
Required: False ,
}
string ,
currentSpend:
{
Description: current spend ,
Format: decimal ,
Required: False ,
}
number ,
contactEmails:
{
Description: list of emails to contact ,
Required: False ,
}
[
string ,
]
,
contactGroups:
{
Description: list of action groups to broadcast to ,
Required: False ,
}
[
string ,
]
,
contactRoles:
{
Description: list of contact roles ,
Required: False ,
}
[
string ,
]
,
overridingAlert:
{
Description: overriding alert ,
Required: False ,
}
string ,
departmentName:
{
Description: department name ,
Required: False ,
}
string ,
companyName:
{
Description: company name ,
Required: False ,
}
string ,
enrollmentNumber:
{
Description: enrollment number ,
Required: False ,
}
string ,
enrollmentStartDate:
{
Description: datetime of enrollmentStartDate ,
Required: False ,
}
string ,
enrollmentEndDate:
{
Description: datetime of enrollmentEndDate ,
Required: False ,
}
string ,
invoicingThreshold:
{
Description: invoicing threshold ,
Format: decimal ,
Required: False ,
}
number ,
}
,
costEntityId:
{
Description: related budget ,
Required: False ,
}
string ,
status:
{
Description: alert status ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: dateTime in which alert was created ,
Required: False ,
}
string ,
closeTime:
{
Description: dateTime in which alert was closed ,
Required: False ,
}
string ,
modificationTime:
{
Description: dateTime in which alert was last modified ,
Required: False ,
}
string ,
statusModificationUserName:
{
Description: User who last modified the alert ,
Required: False ,
}
string ,
statusModificationTime:
{
Description: dateTime in which the alert status was last modified ,
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 ,
}
,
}
Alerts_Dismiss (new)
Description :  Dismisses the specified alert
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Dismiss Alert operation. ,
Required: True ,
}
{
properties:
{
Description: Alert properties. ,
Required: False ,
}
{
definition:
{
Description: defines the type of alert ,
Required: False ,
}
{
type:
{
Description: type of alert ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
Quota: No description available. ,
General: No description available. ,
xCloud: No description available. ,
BudgetForecast: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Alert category ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria that triggered alert ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdApproaching: No description available. ,
CreditThresholdReached: No description available. ,
QuotaThresholdApproaching: No description available. ,
QuotaThresholdReached: No description available. ,
MultiCurrency: No description available. ,
ForecastCostThresholdExceeded: No description available. ,
ForecastUsageThresholdExceeded: No description available. ,
InvoiceDueDateApproaching: No description available. ,
InvoiceDueDateReached: No description available. ,
CrossCloudNewDataAvailable: No description available. ,
CrossCloudCollectionError: No description available. ,
GeneralThresholdError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Alert description ,
Required: False ,
}
string ,
source:
{
Description: Source of alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Alert details ,
Required: False ,
}
{
timeGrainType:
{
Description: Type of timegrain cadence ,
Enum:
{
None: No description available. ,
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: False ,
}
enum ,
periodStartDate:
{
Description: datetime of periodStartDate ,
Required: False ,
}
string ,
triggeredBy:
{
Description: notificationId that triggered this alert ,
Required: False ,
}
string ,
resourceGroupFilter:
{
Description: array of resourceGroups to filter by ,
Required: False ,
}
[
string ,
]
,
resourceFilter:
{
Description: array of resources to filter by ,
Required: False ,
}
[
string ,
]
,
meterFilter:
{
Description: array of meters to filter by ,
Required: False ,
}
[
string ,
]
,
tagFilter:
{
Description: tags to filter by ,
Required: False ,
}
object ,
threshold:
{
Description: notification threshold percentage as a decimal which activated this alert ,
Format: decimal ,
Required: False ,
}
number ,
operator:
{
Description: operator used to compare currentSpend with amount ,
Enum:
{
None: No description available. ,
EqualTo: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqualTo: No description available. ,
LessThan: No description available. ,
LessThanOrEqualTo: No description available. ,
}
,
Required: False ,
}
enum ,
amount:
{
Description: budget threshold amount ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: unit of currency being used ,
Required: False ,
}
string ,
currentSpend:
{
Description: current spend ,
Format: decimal ,
Required: False ,
}
number ,
contactEmails:
{
Description: list of emails to contact ,
Required: False ,
}
[
string ,
]
,
contactGroups:
{
Description: list of action groups to broadcast to ,
Required: False ,
}
[
string ,
]
,
contactRoles:
{
Description: list of contact roles ,
Required: False ,
}
[
string ,
]
,
overridingAlert:
{
Description: overriding alert ,
Required: False ,
}
string ,
departmentName:
{
Description: department name ,
Required: False ,
}
string ,
companyName:
{
Description: company name ,
Required: False ,
}
string ,
enrollmentNumber:
{
Description: enrollment number ,
Required: False ,
}
string ,
enrollmentStartDate:
{
Description: datetime of enrollmentStartDate ,
Required: False ,
}
string ,
enrollmentEndDate:
{
Description: datetime of enrollmentEndDate ,
Required: False ,
}
string ,
invoicingThreshold:
{
Description: invoicing threshold ,
Format: decimal ,
Required: False ,
}
number ,
}
,
costEntityId:
{
Description: related budget ,
Required: False ,
}
string ,
status:
{
Description: alert status ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: dateTime in which alert was created ,
Required: False ,
}
string ,
closeTime:
{
Description: dateTime in which alert was closed ,
Required: False ,
}
string ,
modificationTime:
{
Description: dateTime in which alert was last modified ,
Required: False ,
}
string ,
statusModificationUserName:
{
Description: User who last modified the alert ,
Required: False ,
}
string ,
statusModificationTime:
{
Description: dateTime in which the alert status was last modified ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert properties. ,
Required: False ,
}
{
definition:
{
Description: defines the type of alert ,
Required: False ,
}
{
type:
{
Description: type of alert ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
Quota: No description available. ,
General: No description available. ,
xCloud: No description available. ,
BudgetForecast: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Alert category ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria that triggered alert ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdApproaching: No description available. ,
CreditThresholdReached: No description available. ,
QuotaThresholdApproaching: No description available. ,
QuotaThresholdReached: No description available. ,
MultiCurrency: No description available. ,
ForecastCostThresholdExceeded: No description available. ,
ForecastUsageThresholdExceeded: No description available. ,
InvoiceDueDateApproaching: No description available. ,
InvoiceDueDateReached: No description available. ,
CrossCloudNewDataAvailable: No description available. ,
CrossCloudCollectionError: No description available. ,
GeneralThresholdError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Alert description ,
Required: False ,
}
string ,
source:
{
Description: Source of alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Alert details ,
Required: False ,
}
{
timeGrainType:
{
Description: Type of timegrain cadence ,
Enum:
{
None: No description available. ,
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: False ,
}
enum ,
periodStartDate:
{
Description: datetime of periodStartDate ,
Required: False ,
}
string ,
triggeredBy:
{
Description: notificationId that triggered this alert ,
Required: False ,
}
string ,
resourceGroupFilter:
{
Description: array of resourceGroups to filter by ,
Required: False ,
}
[
string ,
]
,
resourceFilter:
{
Description: array of resources to filter by ,
Required: False ,
}
[
string ,
]
,
meterFilter:
{
Description: array of meters to filter by ,
Required: False ,
}
[
string ,
]
,
tagFilter:
{
Description: tags to filter by ,
Required: False ,
}
object ,
threshold:
{
Description: notification threshold percentage as a decimal which activated this alert ,
Format: decimal ,
Required: False ,
}
number ,
operator:
{
Description: operator used to compare currentSpend with amount ,
Enum:
{
None: No description available. ,
EqualTo: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqualTo: No description available. ,
LessThan: No description available. ,
LessThanOrEqualTo: No description available. ,
}
,
Required: False ,
}
enum ,
amount:
{
Description: budget threshold amount ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: unit of currency being used ,
Required: False ,
}
string ,
currentSpend:
{
Description: current spend ,
Format: decimal ,
Required: False ,
}
number ,
contactEmails:
{
Description: list of emails to contact ,
Required: False ,
}
[
string ,
]
,
contactGroups:
{
Description: list of action groups to broadcast to ,
Required: False ,
}
[
string ,
]
,
contactRoles:
{
Description: list of contact roles ,
Required: False ,
}
[
string ,
]
,
overridingAlert:
{
Description: overriding alert ,
Required: False ,
}
string ,
departmentName:
{
Description: department name ,
Required: False ,
}
string ,
companyName:
{
Description: company name ,
Required: False ,
}
string ,
enrollmentNumber:
{
Description: enrollment number ,
Required: False ,
}
string ,
enrollmentStartDate:
{
Description: datetime of enrollmentStartDate ,
Required: False ,
}
string ,
enrollmentEndDate:
{
Description: datetime of enrollmentEndDate ,
Required: False ,
}
string ,
invoicingThreshold:
{
Description: invoicing threshold ,
Format: decimal ,
Required: False ,
}
number ,
}
,
costEntityId:
{
Description: related budget ,
Required: False ,
}
string ,
status:
{
Description: alert status ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: dateTime in which alert was created ,
Required: False ,
}
string ,
closeTime:
{
Description: dateTime in which alert was closed ,
Required: False ,
}
string ,
modificationTime:
{
Description: dateTime in which alert was last modified ,
Required: False ,
}
string ,
statusModificationUserName:
{
Description: User who last modified the alert ,
Required: False ,
}
string ,
statusModificationTime:
{
Description: dateTime in which the alert status was last modified ,
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 ,
}
,
}
Alerts_ListExternal (new)
Description :  Lists the Alerts for external cloud provider type defined.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
externalCloudProviderType:
{
Description: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. ,
Required: True ,
}
string ,
externalCloudProviderId:
{
Description: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of alerts. ,
Required: False ,
}
[
{
properties:
{
Description: Alert properties. ,
Required: False ,
}
{
definition:
{
Description: defines the type of alert ,
Required: False ,
}
{
type:
{
Description: type of alert ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
Quota: No description available. ,
General: No description available. ,
xCloud: No description available. ,
BudgetForecast: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: Alert category ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria that triggered alert ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdApproaching: No description available. ,
CreditThresholdReached: No description available. ,
QuotaThresholdApproaching: No description available. ,
QuotaThresholdReached: No description available. ,
MultiCurrency: No description available. ,
ForecastCostThresholdExceeded: No description available. ,
ForecastUsageThresholdExceeded: No description available. ,
InvoiceDueDateApproaching: No description available. ,
InvoiceDueDateReached: No description available. ,
CrossCloudNewDataAvailable: No description available. ,
CrossCloudCollectionError: No description available. ,
GeneralThresholdError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Alert description ,
Required: False ,
}
string ,
source:
{
Description: Source of alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Alert details ,
Required: False ,
}
{
timeGrainType:
{
Description: Type of timegrain cadence ,
Enum:
{
None: No description available. ,
Monthly: No description available. ,
Quarterly: No description available. ,
Annually: No description available. ,
BillingMonth: No description available. ,
BillingQuarter: No description available. ,
BillingAnnual: No description available. ,
}
,
Required: False ,
}
enum ,
periodStartDate:
{
Description: datetime of periodStartDate ,
Required: False ,
}
string ,
triggeredBy:
{
Description: notificationId that triggered this alert ,
Required: False ,
}
string ,
resourceGroupFilter:
{
Description: array of resourceGroups to filter by ,
Required: False ,
}
[
string ,
]
,
resourceFilter:
{
Description: array of resources to filter by ,
Required: False ,
}
[
string ,
]
,
meterFilter:
{
Description: array of meters to filter by ,
Required: False ,
}
[
string ,
]
,
tagFilter:
{
Description: tags to filter by ,
Required: False ,
}
object ,
threshold:
{
Description: notification threshold percentage as a decimal which activated this alert ,
Format: decimal ,
Required: False ,
}
number ,
operator:
{
Description: operator used to compare currentSpend with amount ,
Enum:
{
None: No description available. ,
EqualTo: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqualTo: No description available. ,
LessThan: No description available. ,
LessThanOrEqualTo: No description available. ,
}
,
Required: False ,
}
enum ,
amount:
{
Description: budget threshold amount ,
Format: decimal ,
Required: False ,
}
number ,
unit:
{
Description: unit of currency being used ,
Required: False ,
}
string ,
currentSpend:
{
Description: current spend ,
Format: decimal ,
Required: False ,
}
number ,
contactEmails:
{
Description: list of emails to contact ,
Required: False ,
}
[
string ,
]
,
contactGroups:
{
Description: list of action groups to broadcast to ,
Required: False ,
}
[
string ,
]
,
contactRoles:
{
Description: list of contact roles ,
Required: False ,
}
[
string ,
]
,
overridingAlert:
{
Description: overriding alert ,
Required: False ,
}
string ,
departmentName:
{
Description: department name ,
Required: False ,
}
string ,
companyName:
{
Description: company name ,
Required: False ,
}
string ,
enrollmentNumber:
{
Description: enrollment number ,
Required: False ,
}
string ,
enrollmentStartDate:
{
Description: datetime of enrollmentStartDate ,
Required: False ,
}
string ,
enrollmentEndDate:
{
Description: datetime of enrollmentEndDate ,
Required: False ,
}
string ,
invoicingThreshold:
{
Description: invoicing threshold ,
Format: decimal ,
Required: False ,
}
number ,
}
,
costEntityId:
{
Description: related budget ,
Required: False ,
}
string ,
status:
{
Description: alert status ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: dateTime in which alert was created ,
Required: False ,
}
string ,
closeTime:
{
Description: dateTime in which alert was closed ,
Required: False ,
}
string ,
modificationTime:
{
Description: dateTime in which alert was last modified ,
Required: False ,
}
string ,
statusModificationUserName:
{
Description: User who last modified the alert ,
Required: False ,
}
string ,
statusModificationTime:
{
Description: dateTime in which the alert status was last modified ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of alerts 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 ,
}
,
}
Forecast_Usage (new)
Description :  Lists the forecast charges for scope defined.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/forecast
{
$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: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Forecast Config operation. ,
Required: True ,
}
{
type:
{
Description: The type of the forecast. ,
Enum:
{
Usage: No description available. ,
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the forecast. If custom, then a specific time period must be provided. ,
Enum:
{
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the forecast. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataset:
{
Description: Has definition for data in this forecast. ,
Required: True ,
}
{
granularity:
{
Description: The granularity of rows in the forecast. ,
Enum:
{
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses. ,
Required: True ,
}
object ,
filter:
{
Description: Has filter expression to use in the forecast. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeActualCost:
{
Description: A boolean determining if actualCost will be included. ,
Required: False ,
}
boolean ,
includeFreshPartialCost:
{
Description: A boolean determining if FreshPartialCost will be included. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Forecast properties ,
Required: False ,
}
{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Description: The name of column. ,
Required: False ,
}
string ,
type:
{
Description: The type of column. ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Array of rows ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Forecast_ExternalCloudProviderUsage (new)
Description :  Lists the forecast charges for external cloud provider type defined.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast
{
$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: The API version to use for this operation. ,
Required: True ,
}
string ,
externalCloudProviderType:
{
Description: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. ,
Required: True ,
}
string ,
externalCloudProviderId:
{
Description: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Forecast Config operation. ,
Required: True ,
}
{
type:
{
Description: The type of the forecast. ,
Enum:
{
Usage: No description available. ,
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the forecast. If custom, then a specific time period must be provided. ,
Enum:
{
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the forecast. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataset:
{
Description: Has definition for data in this forecast. ,
Required: True ,
}
{
granularity:
{
Description: The granularity of rows in the forecast. ,
Enum:
{
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses. ,
Required: True ,
}
object ,
filter:
{
Description: Has filter expression to use in the forecast. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
includeActualCost:
{
Description: A boolean determining if actualCost will be included. ,
Required: False ,
}
boolean ,
includeFreshPartialCost:
{
Description: A boolean determining if FreshPartialCost will be included. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Forecast properties ,
Required: False ,
}
{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Description: The name of column. ,
Required: False ,
}
string ,
type:
{
Description: The type of column. ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Array of rows ,
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 ,
}
,
}
Dimensions_List (new)
Description :  Lists the dimensions by the defined scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/dimensions
{
scope:
{
Description: The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
Required: False ,
}
string ,
$expand:
{
Description: May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. ,
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 dimension data. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of dimensions. ,
Required: False ,
}
[
{
properties:
{
Description: Dimension properties. ,
Required: False ,
}
{
description:
{
Description: Dimension description. ,
Required: False ,
}
string ,
filterEnabled:
{
Description: Filter enabled. ,
Required: False ,
}
boolean ,
groupingEnabled:
{
Description: Grouping enabled. ,
Required: False ,
}
boolean ,
data:
{
Description: Dimension data. ,
Required: False ,
}
[
string ,
]
,
total:
{
Description: Total number of data for the dimension. ,
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Description: Dimension category. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end. ,
Format: date-time ,
Required: False ,
}
string ,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Dimensions_ByExternalCloudProviderType (new)
Description :  Lists the dimensions by the external cloud provider type.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions
{
externalCloudProviderType:
{
Description: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. ,
Required: True ,
}
string ,
externalCloudProviderId:
{
Description: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
Required: False ,
}
string ,
$expand:
{
Description: May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. ,
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 dimension data. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of dimensions. ,
Required: False ,
}
[
{
properties:
{
Description: Dimension properties. ,
Required: False ,
}
{
description:
{
Description: Dimension description. ,
Required: False ,
}
string ,
filterEnabled:
{
Description: Filter enabled. ,
Required: False ,
}
boolean ,
groupingEnabled:
{
Description: Grouping enabled. ,
Required: False ,
}
boolean ,
data:
{
Description: Dimension data. ,
Required: False ,
}
[
string ,
]
,
total:
{
Description: Total number of data for the dimension. ,
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Description: Dimension category. ,
Required: False ,
}
string ,
usageStart:
{
Description: Usage start. ,
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Description: Usage end. ,
Format: date-time ,
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 ,
}
,
}
Query_Usage (new)
Description :  Query the usage data for scope defined.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/query
{
scope:
{
Description: The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Query Config operation. ,
Required: True ,
}
{
type:
{
Description: The type of the query. ,
Enum:
{
Usage: No description available. ,
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the query. If custom, then a specific time period must be provided. ,
Enum:
{
MonthToDate: No description available. ,
BillingMonthToDate: No description available. ,
TheLastMonth: No description available. ,
TheLastBillingMonth: No description available. ,
WeekToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the query. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataset:
{
Description: Has definition for data in this query. ,
Required: True ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the query. Query can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Query properties ,
Required: False ,
}
{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Description: The name of column. ,
Required: False ,
}
string ,
type:
{
Description: The type of column. ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Array of rows ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Query_UsageByExternalCloudProviderType (new)
Description :  Query the usage data for external cloud provider type defined.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query
{
externalCloudProviderType:
{
Description: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. ,
Required: True ,
}
string ,
externalCloudProviderId:
{
Description: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Query Config operation. ,
Required: True ,
}
{
type:
{
Description: The type of the query. ,
Enum:
{
Usage: No description available. ,
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: True ,
}
enum ,
timeframe:
{
Description: The time frame for pulling data for the query. If custom, then a specific time period must be provided. ,
Enum:
{
MonthToDate: No description available. ,
BillingMonthToDate: No description available. ,
TheLastMonth: No description available. ,
TheLastBillingMonth: No description available. ,
WeekToDate: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the query. ,
Required: False ,
}
{
from:
{
Description: The start date to pull data from. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date to pull data to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
dataset:
{
Description: Has definition for data in this query. ,
Required: True ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. ,
Required: False ,
}
{
columns:
{
Description: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. ,
Required: False ,
}
[
string ,
]
,
}
,
aggregation:
{
Description: Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses. ,
Required: False ,
}
object ,
grouping:
{
Description: Array of group by expression to use in the query. Query can have up to 2 group by clauses. ,
Required: False ,
}
[
{
type:
{
Description: Has type of the column to group. ,
Enum:
{
TagKey: The tag associated with the cost data. ,
Dimension: The dimension of cost data. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the column to group. ,
Required: True ,
}
string ,
}
,
]
,
filter:
{
Description: The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter. ,
Required: False ,
}
{
and:
{
Description: The logical "AND" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
or:
{
Description: The logical "OR" expression. Must have at least 2 items. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Has comparison expression for a dimension ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tags:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Query properties ,
Required: False ,
}
{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Description: The name of column. ,
Required: False ,
}
string ,
type:
{
Description: The type of column. ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Array of rows ,
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 ,
}
,
}
GenerateReservationDetailsReport_ByBillingAccountId (new)
Description :  Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport
{
billingAccountId:
{
Description: Enrollment ID (Legacy BillingAccount ID) ,
Required: True ,
}
string ,
startDate:
{
Description: Start Date ,
Required: True ,
}
string ,
endDate:
{
Description: End Date ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the long running operation. ,
Enum:
{
Running: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
reportUrl:
{
Description: The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity ,
Enum:
{
InstanceFlexibilityGroup: No description available. ,
InstanceFlexibilityRatio: No description available. ,
InstanceId: No description available. ,
Kind: No description available. ,
ReservationId: No description available. ,
ReservationOrderId: No description available. ,
ReservedHours: No description available. ,
SkuName: No description available. ,
TotalReservedQuantity: No description available. ,
UsageDate: No description available. ,
UsedHours: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The time at which report URL becomes invalid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ 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 ,
}
,
}
GenerateReservationDetailsReport_ByBillingProfileId (new)
Description :  Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport
{
billingAccountId:
{
Description: Billing account ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing profile ID. ,
Required: True ,
}
string ,
startDate:
{
Description: Start Date ,
Required: True ,
}
string ,
endDate:
{
Description: End Date ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the long running operation. ,
Enum:
{
Running: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
reportUrl:
{
Description: The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity ,
Enum:
{
InstanceFlexibilityGroup: No description available. ,
InstanceFlexibilityRatio: No description available. ,
InstanceId: No description available. ,
Kind: No description available. ,
ReservationId: No description available. ,
ReservationOrderId: No description available. ,
ReservedHours: No description available. ,
SkuName: No description available. ,
TotalReservedQuantity: No description available. ,
UsageDate: No description available. ,
UsedHours: No description available. ,
}
,
Required: False ,
}
enum ,
validUntil:
{
Description: The time at which report URL becomes invalid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ 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 ,
}
,
}
ScheduledActions_List (new)
Description :  List all private scheduled actions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
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 ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_ListByScope (new)
Description :  List all shared scheduled actions within the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
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 ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_CreateOrUpdate (new)
Description :  Create or update a private scheduled action.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_Get (new)
Description :  Get the private scheduled action by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_Delete (new)
Description :  Delete a private scheduled action.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_CreateOrUpdateByScope (new)
Description :  Create or update a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_GetByScope (new)
Description :  Get the shared scheduled action from the given scope by name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only CSV format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
language:
{
Description: Locale of the email. ,
Required: False ,
}
string ,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
regionalFormat:
{
Description: Regional format used for formatting date/time and currency values in the email. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
notificationEmail:
{
Description: Email address of the point of contact that should get the unsubscribe requests and notification emails. ,
Required: False ,
}
string ,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be run. ,
Expired: Scheduled action is expired. ,
Disabled: Scheduled action is saved but will not be run. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_DeleteByScope (new)
Description :  Delete a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_Run (new)
Description :  Processes a private scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_RunByScope (new)
Description :  Runs a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_CheckNameAvailability (new)
Description :  Checks availability and correctness of the name for a scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScheduledActions_CheckNameAvailabilityByScope (new)
Description :  Checks availability and correctness of the name for a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/checkNameAvailability
{
scope:
{
Description: The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
details:
{
Description: The additional details of the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Settings_List (new)
Description :  List all cost management settings in the requested scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/settings
{
scope:
{
Description: The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of settings. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of settings. ,
Enum:
{
taginheritance: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Settings_CreateOrUpdateByScope (new)
Description :  Create or update a setting within the given scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/settings/{type}
{
scope:
{
Description: The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope. ,
Required: True ,
}
string ,
type:
{
Description: Setting type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
setting:
{
Description: Setting to be created or updated. ,
Required: True ,
}
{
kind:
{
Description: Specifies the kind of settings. ,
Enum:
{
taginheritance: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Specifies the kind of settings. ,
Enum:
{
taginheritance: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of settings. ,
Enum:
{
taginheritance: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Settings_GetByScope (new)
Description :  Get the setting from the given scope by name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/settings/{type}
{
scope:
{
Description: The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope. ,
Required: True ,
}
string ,
type:
{
Description: Setting type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of settings. ,
Enum:
{
taginheritance: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Settings_DeleteByScope (new)
Description :  Delete a setting within the given scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/settings/{type}
{
scope:
{
Description: The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope. ,
Required: True ,
}
string ,
type:
{
Description: Setting type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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