Microsoft.CostManagement (preview:2020-12-01)

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

Exports_List (new)
Description :  The operation to list all exports at the given scope.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of exports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. ,
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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. ,
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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateDetailedCostReport_CreateOperation (new)
Description :  Generates the detailed cost report for provided date range, billing period(Only enterprise customers) or Invoice Id asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create detailed cost report operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: Billing Period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
invoiceId:
{
Description: Invoice Id for PayAsYouGo customers and Modern billing profile scope. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer Id for Modern (Invoice Id and billing profile is also required for this). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the long running operation. ,
Required: False ,
}
{
status:
{
Description: The status of the long running operation. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Queued: No description available. ,
NoDataFound: No description available. ,
ReadyToDownload: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to download the generated report. ,
Required: False ,
}
string ,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Exports_List (removed)
Description :  The operation to list all exports at the given scope.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of exports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
{
scope:
{
Description: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
exportName:
{
Description: Export Name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Export operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule 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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. ,
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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the export. ,
Required: False ,
}
{
schedule:
{
Description: Has schedule information for the export. ,
Required: False ,
}
{
status:
{
Description: The status of the export's schedule. If 'Inactive', the export's schedule is paused. ,
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: False ,
}
enum ,
recurrencePeriod:
{
Description: Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. ,
Required: False ,
}
{
from:
{
Description: The start date of recurrence. ,
Format: date-time ,
Required: True ,
}
string ,
to:
{
Description: The end date of recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateDetailedCostReport_CreateOperation (removed)
Description :  Generates the detailed cost report for provided date range, billing period(Only enterprise customers) or Invoice Id asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create detailed cost report operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: No description available. ,
AmortizedCost: No description available. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: Billing Period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
invoiceId:
{
Description: Invoice Id for PayAsYouGo customers and Modern billing profile scope. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer Id for Modern (Invoice Id and billing profile is also required for this). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}
{
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2020-12-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the long running operation. ,
Required: False ,
}
{
status:
{
Description: The status of the long running operation. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Queued: No description available. ,
NoDataFound: No description available. ,
ReadyToDownload: No description available. ,
TimedOut: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of the resource generated. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to download the generated report. ,
Required: False ,
}
string ,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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