Microsoft.CostManagement (preview:2022-10-05)

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

Views_List (new)
Description :  Lists all views by tenant and object.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/views
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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:
{
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 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 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 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: False ,
}
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: 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 ,
}
,
}
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: Version of the API to be used with the client request. ,
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:
{
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 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 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 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: False ,
}
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: 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 ,
}
,
}
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 ,
]
,
}
,
}
,
}
,
}
,
$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 ,
}

⚐ 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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 ,
]
,
}
,
}
,
}
,
}
,
$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 ,
}

⚐ 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/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: Version of the API to be used with the client request. ,
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/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: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: BillingProfile ID ,
Required: True ,
}
string ,
startDate:
{
Description: Start Date ,
Required: True ,
}
string ,
endDate:
{
Description: End Date ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
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 ,
}
,
}
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: Version of the API to be used with the client request. ,
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 ,
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.CostManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Dimensions, Query. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
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 ,
}
,
}
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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 ,
}
,
}
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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: Version of the API to be used with the client request. ,
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_List (removed)
Description :  Lists all views by tenant and object.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/views
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
Description :  Gets the view by view name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/views/{viewName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
Description :  The operation to delete a view.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/views/{viewName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
Description :  Lists the alerts for scope defined.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 (removed)
Description :  Gets the alert for the scope by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 (removed)
Description :  Dismisses the specified alert
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 (removed)
Description :  Lists the Alerts for external cloud provider type defined.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
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 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 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 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: False ,
}
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: 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 ,
}
,
}
Forecast_ExternalCloudProviderUsage (removed)
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: Version of the API to be used with the client request. ,
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:
{
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 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 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 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: False ,
}
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: 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 ,
}
,
}
Dimensions_List (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 ,
]
,
}
,
}
,
}
,
}
,
$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 ,
}

⚐ 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 (removed)
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: Version of the API to be used with the client request. ,
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:
{
Tag: No description available. ,
Dimension: No description available. ,
}
,
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 ,
]
,
}
,
}
,
}
,
}
,
$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 ,
}

⚐ 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 (removed)
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/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: Version of the API to be used with the client request. ,
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 (removed)
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/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: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: BillingProfile ID ,
Required: True ,
}
string ,
startDate:
{
Description: Start Date ,
Required: True ,
}
string ,
endDate:
{
Description: End Date ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
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 ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available cost management REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
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 ,
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.CostManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Dimensions, Query. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
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 ,
}
,
}
Settings_List (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 ,
}
,
}
Settings_List (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 (removed)
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: Version of the API to be used with the client request. ,
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 ,
}
,
}