Microsoft.Billing (preview:2019-03-01)

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

Dimensions_ListByBillingAccount (new)
Description :  Lists the dimensions by billingAccount Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByEnrollmentAccount (new)
Description :  Lists the dimensions by Enrollment Account Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByDepartment (new)
Description :  Lists the dimensions by Department Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByManagementGroup (new)
Description :  Lists the dimensions by managementGroup Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListBySubscription (new)
Description :  Lists the dimensions by subscription Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageBySubscription (new)
Description :  Query the usage data for subscriptionId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageBySubscription (new)
Description :  Forecast the usage data for subscriptionId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByResourceGroup (new)
Description :  Lists the dimensions by resource group Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByResourceGroup (new)
Description :  Query the usage data for subscriptionId and resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByResourceGroup (new)
Description :  Forecast the usage data for subscriptionId and resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByBillingAccount (new)
Description :  Query the usage data for billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByBillingAccount (new)
Description :  Forecast the usage data for billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByEnrollmentAccount (new)
Description :  Query the usage data for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByEnrollmentAccount (new)
Description :  Forecast the usage data for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByDepartment (new)
Description :  Query the usage data for department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByDepartment (new)
Description :  Forecast the usage data for department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByManagementGroup (new)
Description :  Lists the usage data for management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByManagementGroup (new)
Description :  Lists the usage data for management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByExternalBillingAccount (new)
Description :  Forecast the usage data for external billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_List (new)
Description :  List all cloud connector definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/cloudConnectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of connector definitions. ,
Required: False ,
}
[
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Get (new)
Description :  Get a cloud connector definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_CreateOrUpdate (new)
Description :  Create or update a cloud connector definition
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
connector:
{
Description: Connector details ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Delete (new)
Description :  Delete a cloud connector definition
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Update (new)
Description :  Update a cloud connector definition
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
connector:
{
Description: Connector details ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Connector_CheckEligibility (new)
Description :  Check if a connector already exists and return it's definition
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/checkConnectorEligibility
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorCredentials:
{
Description: Connector credentials ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalBillingAccount_List (new)
Description :  List all ExternalBillingAccount definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalBillingAccount definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalBillingAccount id ,
Required: False ,
}
string ,
name:
{
Description: ExternalBillingAccount name ,
Required: False ,
}
string ,
type:
{
Description: ExternalBillingAccount type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalBillingAccount kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalBillingAccount properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalBillingAccount DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
connectorId:
{
Description: Underlying ConnectorId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalBillingAccount_Get (new)
Description :  Get a ExternalBillingAccount definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ExternalBillingAccount id ,
Required: False ,
}
string ,
name:
{
Description: ExternalBillingAccount name ,
Required: False ,
}
string ,
type:
{
Description: ExternalBillingAccount type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalBillingAccount kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalBillingAccount properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalBillingAccount DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
connectorId:
{
Description: Underlying ConnectorId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_ListByExternalBillingAccount (new)
Description :  List all ExternalSubscriptions by ExternalBillingAccount definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_List (new)
Description :  List all ExternalSubscription definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_Get (new)
Description :  Get an ExternalSubscription definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalSubscriptionName:
{
Description: External Subscription Name. (eg 'aws-{UsageAccountId}') ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_ListByManagementGroup (new)
Description :  List all ExternalSubscription definitions for Management Group
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
$recurse:
{
Description: The $recurse=true query string parameter allows returning externalSubscriptions associated with the specified managementGroup, or any of its descendants. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_UpdateManagementGroup (new)
Description :  Updates the management group of an ExternalSubscription
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
externalSubscriptionName:
{
Description: External Subscription Name. (eg 'aws-{UsageAccountId}') ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRules_List (new)
Description :  Get list all Showback Rules.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of showback rules. ,
Required: False ,
}
[
{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRule_GetBillingAccountId (new)
Description :  Gets the showback rule by rule name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Showback rule name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRule_CreateUpdateRule (new)
Description :  Create/Update showback rule for billing account.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Showback rule name ,
Required: True ,
}
string ,
showbackRule:
{
Description: Showback rule to create or update. ,
Required: True ,
}
{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available consumption 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 2019-03-01-preview ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByBillingAccount (removed)
Description :  Lists the dimensions by billingAccount Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByEnrollmentAccount (removed)
Description :  Lists the dimensions by Enrollment Account Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByDepartment (removed)
Description :  Lists the dimensions by Department Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByManagementGroup (removed)
Description :  Lists the dimensions by managementGroup Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListBySubscription (removed)
Description :  Lists the dimensions by subscription Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageBySubscription (removed)
Description :  Query the usage data for subscriptionId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageBySubscription (removed)
Description :  Forecast the usage data for subscriptionId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Dimensions_ListByResourceGroup (removed)
Description :  Lists the dimensions by resource group Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/dimensions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByResourceGroup (removed)
Description :  Query the usage data for subscriptionId and resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByResourceGroup (removed)
Description :  Forecast the usage data for subscriptionId and resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByBillingAccount (removed)
Description :  Query the usage data for billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByBillingAccount (removed)
Description :  Forecast the usage data for billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByEnrollmentAccount (removed)
Description :  Query the usage data for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByEnrollmentAccount (removed)
Description :  Forecast the usage data for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByDepartment (removed)
Description :  Query the usage data for department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByDepartment (removed)
Description :  Forecast the usage data for department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Query_UsageByManagementGroup (removed)
Description :  Lists the usage data for management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Query
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByManagementGroup (removed)
Description :  Lists the usage data for management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Forecast_UsageByExternalBillingAccount (removed)
Description :  Forecast the usage data for external billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/Forecast
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report Config operation. ,
Required: True ,
}
{
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 ,
]
,
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. ,
Contains: 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. ,
Contains: 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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_List (removed)
Description :  List all cloud connector definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/cloudConnectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of connector definitions. ,
Required: False ,
}
[
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Get (removed)
Description :  Get a cloud connector definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_CreateOrUpdate (removed)
Description :  Create or update a cloud connector definition
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
connector:
{
Description: Connector details ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Delete (removed)
Description :  Delete a cloud connector definition
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
CloudConnector_Update (removed)
Description :  Update a cloud connector definition
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.CostManagement/cloudConnectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
string ,
connector:
{
Description: Connector details ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Connector_CheckEligibility (removed)
Description :  Check if a connector already exists and return it's definition
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/checkConnectorEligibility
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
connectorCredentials:
{
Description: Connector credentials ,
Required: True ,
}
{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Connector kind (eg aws) ,
Required: False ,
}
string ,
id:
{
Description: Connector id ,
Required: False ,
}
string ,
name:
{
Description: Connector name ,
Required: False ,
}
string ,
type:
{
Description: Connector type ,
Required: False ,
}
string ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Connector providerBillingAccountId, determined from credentials (eg AWS Consolidated account number) ,
Required: False ,
}
string ,
providerBillingAccountDisplayName:
{
Description: The display name of the providerBillingAccountId as defined on the external provider ,
Required: False ,
}
string ,
credentialsKey:
{
Description: Credentials authentication key (eg AWS ARN) ,
Required: False ,
}
string ,
credentialsSecret:
{
Description: Credentials secret (eg AWS ExternalId) ,
Required: False ,
}
string ,
reportId:
{
Description: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) ,
Required: False ,
}
string ,
createdOn:
{
Description: Connector definition creation datetime ,
Format: date-time ,
Required: False ,
}
string ,
modifiedOn:
{
Description: Connector last modified datetime ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Connector status ,
Enum:
{
active: No description available. ,
error: No description available. ,
expired: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
externalBillingAccountId:
{
Description: Associated ExternalBillingAccountId ,
Required: False ,
}
string ,
defaultManagementGroupId:
{
Description: Default ManagementGroupId ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Billing SubscriptionId ,
Required: False ,
}
string ,
billingModel:
{
Description: Connector billing model ,
Enum:
{
trial: No description available. ,
autoUpgrade: No description available. ,
premium: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
daysTrialRemaining:
{
Description: Number of days remaining of trial ,
Required: False ,
}
integer ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalBillingAccount_List (removed)
Description :  List all ExternalBillingAccount definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalBillingAccount definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalBillingAccount id ,
Required: False ,
}
string ,
name:
{
Description: ExternalBillingAccount name ,
Required: False ,
}
string ,
type:
{
Description: ExternalBillingAccount type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalBillingAccount kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalBillingAccount properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalBillingAccount DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
connectorId:
{
Description: Underlying ConnectorId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalBillingAccount_Get (removed)
Description :  Get a ExternalBillingAccount definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ExternalBillingAccount id ,
Required: False ,
}
string ,
name:
{
Description: ExternalBillingAccount name ,
Required: False ,
}
string ,
type:
{
Description: ExternalBillingAccount type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalBillingAccount kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalBillingAccount properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalBillingAccount DisplayName ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
connectorId:
{
Description: Underlying ConnectorId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_ListByExternalBillingAccount (removed)
Description :  List all ExternalSubscriptions by ExternalBillingAccount definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalBillingAccountName:
{
Description: External Billing Account Name. (eg 'aws-{PayerAccountId}') ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_List (removed)
Description :  List all ExternalSubscription definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_Get (removed)
Description :  Get an ExternalSubscription definition
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
externalSubscriptionName:
{
Description: External Subscription Name. (eg 'aws-{UsageAccountId}') ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the collectionInfo property. By default, collectionInfo is not included. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_ListByManagementGroup (removed)
Description :  List all ExternalSubscription definitions for Management Group
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
$recurse:
{
Description: The $recurse=true query string parameter allows returning externalSubscriptions associated with the specified managementGroup, or any of its descendants. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
value:
{
Description: The list of ExternalSubscription definitions. ,
Required: False ,
}
[
{
id:
{
Description: ExternalSubscription id ,
Required: False ,
}
string ,
name:
{
Description: ExternalSubscription name ,
Required: False ,
}
string ,
type:
{
Description: ExternalSubscription type ,
Required: False ,
}
string ,
kind:
{
Description: ExternalSubscription kind (eg aws) ,
Required: False ,
}
string ,
properties:
{
Description: ExternalSubscription properties ,
Required: False ,
}
{
displayName:
{
Description: ExternalSubscription DisplayName ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Assigned ManagementGroupId ,
Required: False ,
}
string ,
providerBillingAccountId:
{
Description: Provider BillingAccountId (eg AWS Consolidated Account number) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Provider AccountId (eg AWS Linked Account number) ,
Required: False ,
}
string ,
externalBillingAccountId:
{
Description: Parent ExternalBillingAccountId ,
Required: False ,
}
string ,
collectionInfo:
{
Description: Collection information ,
Required: False ,
}
{
lastChecked:
{
Description: Last time the data acquisition process initiated connecting to the external provider ,
Format: date-time ,
Required: False ,
}
string ,
sourceLastUpdated:
{
Description: Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time the external data was updated into Azure ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information of last collection ,
Required: False ,
}
{
errorMessage:
{
Description: Detailed error message ,
Required: False ,
}
string ,
errorInnerMessage:
{
Description: External Provider error message ,
Required: False ,
}
string ,
errorCode:
{
Description: Short error code ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastChecked) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExternalSubscription_UpdateManagementGroup (removed)
Description :  Updates the management group of an ExternalSubscription
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
managementGroupId:
{
Description: ManagementGroup ID ,
Required: True ,
}
string ,
externalSubscriptionName:
{
Description: External Subscription Name. (eg 'aws-{UsageAccountId}') ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRules_List (removed)
Description :  Get list all Showback Rules.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of showback rules. ,
Required: False ,
}
[
{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRule_GetBillingAccountId (removed)
Description :  Gets the showback rule by rule name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Showback rule name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ShowbackRule_CreateUpdateRule (removed)
Description :  Create/Update showback rule for billing account.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/showbackRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2019-03-01-preview ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Showback rule name ,
Required: True ,
}
string ,
showbackRule:
{
Description: Showback rule to create or update. ,
Required: True ,
}
{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Rule id ,
Required: False ,
}
string ,
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Rule type ,
Required: False ,
}
string ,
properties:
{
Description: Showback rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a showback rule. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the showback rule. ,
Enum:
{
NotActive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The current version of showback rule. ,
Required: False ,
}
integer ,
scopes:
{
Description: List of authorized assigned scopes. ,
Required: False ,
}
[
{
id:
{
Description: Scope id ,
Required: False ,
}
string ,
name:
{
Description: Scope name ,
Required: False ,
}
string ,
type:
{
Description: Scope type ,
Required: False ,
}
string ,
childScope:
{
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: The time when the showback rule was created. ,
Format: date-time ,
Required: False ,
}
string ,
deprecationTime:
{
Description: The current time when showback rule was deprecate. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when showback rule was modified. ,
Format: date-time ,
Required: False ,
}
string ,
ruleType:
{
Description: The rule type of the showback rule solution. ,
Enum:
{
CustomPrice: No description available. ,
CostAllocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available consumption 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 2019-03-01-preview ,
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: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: A machine readable error code. ,
Required: False ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: False ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}