Microsoft.CostManagement (preview:2018-08-01)

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

Reports_List (new)
Description :  Lists all reports for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByResourceGroupName (new)
Description :  Lists all reports for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByBillingAccount (new)
Description :  Lists all reports for a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByDepartment (new)
Description :  Lists all reports for a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_Get (new)
Description :  Gets the report for a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdate (new)
Description :  The operation to create or update a report. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_Delete (new)
Description :  The operation to delete a report.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByResourceGroupName (new)
Description :  Gets the report for a resource group under a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByResourceGroupName (new)
Description :  The operation to create or update a report. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByResourceGroupName (new)
Description :  The operation to delete a report.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByBillingAccount (new)
Description :  Gets the report for a billing account by report name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByBillingAccount (new)
Description :  The operation to create or update a report for billingAccount. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByBillingAccount (new)
Description :  The operation to delete a report for billing account.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByDepartment (new)
Description :  Gets the report for a department by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByDepartment (new)
Description :  The operation to create or update a report for department. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByDepartment (new)
Description :  The operation to delete a report for department.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_Execute (new)
Description :  The operation to execute a report.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByResourceGroupName (new)
Description :  The operation to execute a report.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByBillingAccount (new)
Description :  The operation to execute a report by billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByDepartment (new)
Description :  The operation to execute a report by department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistory (new)
Description :  Gets the execution history of a report for a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByResourceGroupName (new)
Description :  Gets the execution history of a report for a resource group by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByBillingAccount (new)
Description :  Gets the execution history of a report for a billing account by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByDepartment (new)
Description :  Gets the execution history of a report for a department by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BillingAccountDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
SubscriptionDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
ResourceGroupDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
QuerySubscription (new)
Description :  Lists 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 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
QueryResourceGroup (new)
Description :  Lists 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 2018-08-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 operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
QueryBillingAccount (new)
Description :  Lists 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 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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_List (new)
Description :  List all connector definitions for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/connectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_ListByResourceGroupName (new)
Description :  List all connector definitions for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of 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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_Get (new)
Description :  Get a connector definition
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_CreateOrUpdate (new)
Description :  Create or update a connector definition
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_Delete (new)
Description :  Delete a connector definition
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
}
,
]
,
}
,
}
Connector_Update (new)
Description :  Update a connector definition
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
}
,
]
,
}
,
}
Alerts_List (new)
Description :  List all alerts for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByResourceGroupName (new)
Description :  List all alerts for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByEnrollment (new)
Description :  List all alerts for an enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByDepartment (new)
Description :  List all alerts for a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-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 alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByAccount (new)
Description :  List all alerts for an account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-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 alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByManagementGroups (new)
Description :  List all alerts for Management Groups.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetBySubscription (new)
Description :  Gets the alert for a subscription by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByResourceGroupName (new)
Description :  Gets the alert for a resource group under a subscription by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByEnrollment (new)
Description :  Gets the alert for an enrollment by alert ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByDepartment (new)
Description :  Gets the alert for a department by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByAccount (new)
Description :  Gets the alert for an account by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account Id ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetAlertByManagementGroups (new)
Description :  Gets an alert for Management Groups by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateSubscriptionAlertStatus (new)
Description :  Update alerts status for a subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateResourceGroupNameAlertStatus (new)
Description :  Update alerts status for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateBillingAccountAlertStatus (new)
Description :  Update alerts status for billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateDepartmentsAlertStatus (new)
Description :  Update alerts status for a department.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateEnrollmentAccountAlertStatus (new)
Description :  Update alerts status for an enrollment account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account Id ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateManagementGroupAlertStatus (new)
Description :  Update alerts status for management group.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}/UpdateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available cost management REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CostManagement 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: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_List (removed)
Description :  Lists all reports for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByResourceGroupName (removed)
Description :  Lists all reports for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByBillingAccount (removed)
Description :  Lists all reports for a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_ListByDepartment (removed)
Description :  Lists all reports for a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_Get (removed)
Description :  Gets the report for a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdate (removed)
Description :  The operation to create or update a report. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_Delete (removed)
Description :  The operation to delete a report.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByResourceGroupName (removed)
Description :  Gets the report for a resource group under a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByResourceGroupName (removed)
Description :  The operation to create or update a report. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByResourceGroupName (removed)
Description :  The operation to delete a report.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByBillingAccount (removed)
Description :  Gets the report for a billing account by report name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByBillingAccount (removed)
Description :  The operation to create or update a report for billingAccount. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByBillingAccount (removed)
Description :  The operation to delete a report for billing account.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetByDepartment (removed)
Description :  Gets the report for a department by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_CreateOrUpdateByDepartment (removed)
Description :  The operation to create or update a report for department. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the report. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the report. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recurrence:
{
Description: The schedule recurrence. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
Annually: No description available. ,
}
,
Required: True ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_DeleteByDepartment (removed)
Description :  The operation to delete a report for department.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_Execute (removed)
Description :  The operation to execute a report.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByResourceGroupName (removed)
Description :  The operation to execute a report.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByBillingAccount (removed)
Description :  The operation to execute a report by billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_ExecuteByDepartment (removed)
Description :  The operation to execute a report by department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}/run
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistory (removed)
Description :  Gets the execution history of a report for a subscription by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByResourceGroupName (removed)
Description :  Gets the execution history of a report for a resource group by report name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByBillingAccount (removed)
Description :  Gets the execution history of a report for a billing account by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Reports_GetExecutionHistoryByDepartment (removed)
Description :  Gets the execution history of a report for a department by report name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.CostManagement/reports/{reportName}/runHistory
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
reportName:
{
Description: Report Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BillingAccountDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
SubscriptionDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
ResourceGroupDimensions_List (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 2018-08-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 ,
}
{
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 ,
}
,
]
,
}
,
}
QuerySubscription (removed)
Description :  Lists 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 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
QueryResourceGroup (removed)
Description :  Lists 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 2018-08-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 operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
QueryBillingAccount (removed)
Description :  Lists 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 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Report operation. ,
Required: True ,
}
{
type:
{
Description: The type of the report. ,
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. ,
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. ,
Required: False ,
}
{
granularity:
{
Description: The granularity of rows in the report. ,
Enum:
{
Daily: No description available. ,
Hourly: 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. ,
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. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
tag:
{
Description: Has comparison expression for a tag ,
Required: False ,
}
{
name:
{
Description: The name of the column to use in comparison. ,
Required: True ,
}
string ,
operator:
{
Description: The operator to use for comparison. ,
Enum:
{
In: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: Array of values to use for comparison ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of usage data. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
nextLink:
{
Required: False ,
}
string ,
columns:
{
Description: Array of columns ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
}
,
]
,
rows:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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_List (removed)
Description :  List all connector definitions for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/connectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_ListByResourceGroupName (removed)
Description :  List all connector definitions for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of 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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_Get (removed)
Description :  Get a connector definition
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
connectorName:
{
Description: Connector Name. ,
Required: True ,
}
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_CreateOrUpdate (removed)
Description :  Create or update a connector definition
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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_Delete (removed)
Description :  Delete a connector definition
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
}
,
]
,
}
,
}
Connector_Update (removed)
Description :  Update a connector definition
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/connectors/{connectorName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
location:
{
Description: Connector location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Connector properties ,
Required: False ,
}
{
displayName:
{
Description: Connector DisplayName (defaults to Name) ,
Required: False ,
}
string ,
providerAccountId:
{
Description: Connector providerAccountId (determined from credentials) ,
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. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
collection:
{
Description: Collection information ,
Required: False ,
}
{
lastRun:
{
Description: Last time the data acquisition process completed (even if no new data was found) ,
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 ,
errorCode:
{
Description: Short error message ,
Required: False ,
}
string ,
errorStartTime:
{
Description: Time the error started occurring (Last time error occurred in lastRun) ,
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 ,
}
,
]
,
}
,
}
Alerts_List (removed)
Description :  List all alerts for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByResourceGroupName (removed)
Description :  List all alerts for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByEnrollment (removed)
Description :  List all alerts for an enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByDepartment (removed)
Description :  List all alerts for a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-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 alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByAccount (removed)
Description :  List all alerts for an account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-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 alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_ListByManagementGroups (removed)
Description :  List all alerts for Management Groups.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. ,
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 alerts. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Alerts. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetBySubscription (removed)
Description :  Gets the alert for a subscription by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByResourceGroupName (removed)
Description :  Gets the alert for a resource group under a subscription by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByEnrollment (removed)
Description :  Gets the alert for an enrollment by alert ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByDepartment (removed)
Description :  Gets the alert for a department by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetByAccount (removed)
Description :  Gets the alert for an account by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account Id ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_GetAlertByManagementGroups (removed)
Description :  Gets an alert for Management Groups by alert ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateSubscriptionAlertStatus (removed)
Description :  Update alerts status for a subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateResourceGroupNameAlertStatus (removed)
Description :  Update alerts status for a resource group under a subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure Resource Group Name. ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateBillingAccountAlertStatus (removed)
Description :  Update alerts status for billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateDepartmentsAlertStatus (removed)
Description :  Update alerts status for a department.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
departmentId:
{
Description: Department ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateEnrollmentAccountAlertStatus (removed)
Description :  Update alerts status for an enrollment account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
enrollmentAccountId:
{
Description: Enrollment Account Id ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Alerts_UpdateManagementGroupAlertStatus (removed)
Description :  Update alerts status for management group.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}/UpdateStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-08-01-preview. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management Group ID ,
Required: True ,
}
string ,
alertId:
{
Description: Alert ID. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update alerts status operation. ,
Required: True ,
}
{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Alert id ,
Required: False ,
}
string ,
name:
{
Description: Alert name ,
Required: False ,
}
string ,
type:
{
Description: Alert type ,
Required: False ,
}
string ,
properties:
{
Description: Alert properties ,
Required: False ,
}
{
costEntityId:
{
Description: The id of the creating cost-entity (budget, invoice, credit). ,
Required: False ,
}
string ,
definition:
{
Description: The definition (rule) of an Alert ,
Required: False ,
}
{
category:
{
Description: Category of the alert. ,
Enum:
{
Cost: No description available. ,
Usage: No description available. ,
Billing: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of cost-entity the alert is defined on. ,
Enum:
{
Budget: No description available. ,
Invoice: No description available. ,
Credit: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Criteria (condition) of the alert. ,
Enum:
{
CostThresholdExceeded: No description available. ,
UsageThresholdExceeded: No description available. ,
CreditThresholdReached: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Description of an alert. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of an alert. ,
Required: False ,
}
string ,
source:
{
Description: The source of an Alert ,
Enum:
{
Preset: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Specific details of an alert - key-value dictionary. ,
Required: False ,
}
object ,
creationTime:
{
Description: The time when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
closeTime:
{
Description: The time when the alert was closed (resolved / overridden). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the alert. ,
Enum:
{
Active: No description available. ,
Overridden: No description available. ,
Resolved: No description available. ,
Dismissed: No description available. ,
}
,
Required: False ,
}
enum ,
statusModificationTime:
{
Description: The current status when alert status was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationTime:
{
Description: The current status when alert was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modificationUsername:
{
Description: The username who modified the alert. ,
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available cost management REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CostManagement 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: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}