Microsoft.CostManagement (stable:2019-01-01)

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

Dimensions_ListBySubscription (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 and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
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. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of dimensions. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
description:
{
Required: False ,
}
string ,
filterEnabled:
{
Required: False ,
}
boolean ,
groupingEnabled:
{
Required: False ,
}
boolean ,
data:
{
Required: False ,
}
[
string ,
]
,
total:
{
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Required: False ,
}
string ,
usageStart:
{
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Format: date-time ,
Required: False ,
}
string ,
nextLink:
{
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_UsageByScope (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 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 and '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
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. ,
}
,
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:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
TheLastWeek: No description available. ,
TheLastMonth: No description available. ,
TheLastYear: No description available. ,
Custom: No description available. ,
BillingMonthToDate: No description available. ,
TheLastBillingMonth: 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: False ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
Hourly: 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 ,
}
,
]
,
sorting:
{
Description: Array of sorting by columns in query. ,
Required: False ,
}
[
{
querySortingDirection:
{
Description: The sorting direction ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to use in sorting. ,
Required: False ,
}
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 ,
]
,
not:
{
Required: False ,
}
string ,
dimension:
{
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 ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
Exports_List (new)
Description :  Lists all exports at the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of exports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Exports_CreateOrUpdate (new)
Description :  The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of export executions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export execution. ,
Required: False ,
}
{
executionType:
{
Description: The type of the export execution. ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the export execution. ,
Enum:
{
Queued: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Timeout: No description available. ,
NewDataNotAvailable: No description available. ,
DataNotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
submittedBy:
{
Description: The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System. ,
Required: False ,
}
string ,
submittedTime:
{
Description: The time when export was queued to be executed. ,
Format: date-time ,
Required: False ,
}
string ,
processingStartTime:
{
Description: The time when export was picked up to be executed. ,
Format: date-time ,
Required: False ,
}
string ,
processingEndTime:
{
Description: The time when export execution finished. ,
Format: date-time ,
Required: False ,
}
string ,
fileName:
{
Description: The name of the file export got written to. ,
Required: False ,
}
string ,
runSettings:
{
Description: The common properties of the export. ,
Required: False ,
}
{
format:
{
Description: The format of the export being delivered. ,
Enum:
{
Csv: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Has delivery information for the export. ,
Required: True ,
}
{
destination:
{
Description: Has destination for the export being delivered. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the storage account where exports will be delivered. ,
Required: True ,
}
string ,
container:
{
Description: The name of the container where exports will be uploaded. ,
Required: True ,
}
string ,
rootFolderPath:
{
Description: The name of the directory where exports will be uploaded. ,
Required: False ,
}
string ,
}
,
}
,
definition:
{
Description: Has definition for the export. ,
Required: True ,
}
{
type:
{
Description: The type of the query. ,
Enum:
{
Usage: 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:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
TheLastWeek: No description available. ,
TheLastMonth: No description available. ,
TheLastYear: No description available. ,
Custom: No description available. ,
BillingMonthToDate: No description available. ,
TheLastBillingMonth: 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: False ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
Hourly: 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 ,
}
,
]
,
sorting:
{
Description: Array of sorting by columns in query. ,
Required: False ,
}
[
{
querySortingDirection:
{
Description: The sorting direction ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to use in sorting. ,
Required: False ,
}
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 ,
]
,
not:
{
Required: False ,
}
string ,
dimension:
{
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 ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details 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. The current version is 2018-05-31. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of cost management operations supported by the Microsoft.CostManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.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 ,
}
,
}
,
]
,
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 ,
}
,
}
Dimensions_ListBySubscription (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 and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
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. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of dimensions. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
description:
{
Required: False ,
}
string ,
filterEnabled:
{
Required: False ,
}
boolean ,
groupingEnabled:
{
Required: False ,
}
boolean ,
data:
{
Required: False ,
}
[
string ,
]
,
total:
{
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Required: False ,
}
string ,
usageStart:
{
Format: date-time ,
Required: False ,
}
string ,
usageEnd:
{
Format: date-time ,
Required: False ,
}
string ,
nextLink:
{
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_UsageByScope (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 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 and '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope.. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
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. ,
}
,
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:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
TheLastWeek: No description available. ,
TheLastMonth: No description available. ,
TheLastYear: No description available. ,
Custom: No description available. ,
BillingMonthToDate: No description available. ,
TheLastBillingMonth: 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: False ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
Hourly: 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 ,
}
,
]
,
sorting:
{
Description: Array of sorting by columns in query. ,
Required: False ,
}
[
{
querySortingDirection:
{
Description: The sorting direction ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to use in sorting. ,
Required: False ,
}
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 ,
]
,
not:
{
Required: False ,
}
string ,
dimension:
{
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 ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
}
Exports_List (removed)
Description :  Lists all exports at the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of exports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Exports_CreateOrUpdate (removed)
Description :  The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-05-31. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of export executions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export execution. ,
Required: False ,
}
{
executionType:
{
Description: The type of the export execution. ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the export execution. ,
Enum:
{
Queued: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Timeout: No description available. ,
NewDataNotAvailable: No description available. ,
DataNotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
submittedBy:
{
Description: The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System. ,
Required: False ,
}
string ,
submittedTime:
{
Description: The time when export was queued to be executed. ,
Format: date-time ,
Required: False ,
}
string ,
processingStartTime:
{
Description: The time when export was picked up to be executed. ,
Format: date-time ,
Required: False ,
}
string ,
processingEndTime:
{
Description: The time when export execution finished. ,
Format: date-time ,
Required: False ,
}
string ,
fileName:
{
Description: The name of the file export got written to. ,
Required: False ,
}
string ,
runSettings:
{
Description: The common properties of the export. ,
Required: False ,
}
{
format:
{
Description: The format of the export being delivered. ,
Enum:
{
Csv: No description available. ,
}
,
Required: False ,
}
enum ,
deliveryInfo:
{
Description: Has delivery information for the export. ,
Required: True ,
}
{
destination:
{
Description: Has destination for the export being delivered. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the storage account where exports will be delivered. ,
Required: True ,
}
string ,
container:
{
Description: The name of the container where exports will be uploaded. ,
Required: True ,
}
string ,
rootFolderPath:
{
Description: The name of the directory where exports will be uploaded. ,
Required: False ,
}
string ,
}
,
}
,
definition:
{
Description: Has definition for the export. ,
Required: True ,
}
{
type:
{
Description: The type of the query. ,
Enum:
{
Usage: 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:
{
WeekToDate: No description available. ,
MonthToDate: No description available. ,
YearToDate: No description available. ,
TheLastWeek: No description available. ,
TheLastMonth: No description available. ,
TheLastYear: No description available. ,
Custom: No description available. ,
BillingMonthToDate: No description available. ,
TheLastBillingMonth: 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: False ,
}
{
granularity:
{
Description: The granularity of rows in the query. ,
Enum:
{
Daily: No description available. ,
Hourly: 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 ,
}
,
]
,
sorting:
{
Description: Array of sorting by columns in query. ,
Required: False ,
}
[
{
querySortingDirection:
{
Description: The sorting direction ,
Enum:
{
Ascending: No description available. ,
Descending: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the column to use in sorting. ,
Required: False ,
}
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 ,
]
,
not:
{
Required: False ,
}
string ,
dimension:
{
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 ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details 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. The current version is 2018-05-31. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of cost management operations supported by the Microsoft.CostManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.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 ,
}
,
}
,
]
,
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 ,
}
,
}