GenerateCostDetailsReport interface
Interface representing a GenerateCostDetailsReport.
Methods
| begin |
This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields |
| begin |
This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields |
| begin |
Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header. |
| begin |
Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header. |
Method Details
beginCreateOperation(string, GenerateCostDetailsReportRequestDefinition, GenerateCostDetailsReportCreateOperationOptionalParams)
This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields
function beginCreateOperation(scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams): Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>Parameters
- scope
-
string
The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
- parameters
- GenerateCostDetailsReportRequestDefinition
Parameters supplied to the Create cost details operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>
beginCreateOperationAndWait(string, GenerateCostDetailsReportRequestDefinition, GenerateCostDetailsReportCreateOperationOptionalParams)
This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields
function beginCreateOperationAndWait(scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams): Promise<CostDetailsOperationResults>Parameters
- scope
-
string
The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
- parameters
- GenerateCostDetailsReportRequestDefinition
Parameters supplied to the Create cost details operation.
The options parameters.
Returns
Promise<CostDetailsOperationResults>
beginGetOperationResults(string, string, GenerateCostDetailsReportGetOperationResultsOptionalParams)
Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
function beginGetOperationResults(scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams): Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>Parameters
- scope
-
string
The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
- operationId
-
string
The target operation Id.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>
beginGetOperationResultsAndWait(string, string, GenerateCostDetailsReportGetOperationResultsOptionalParams)
Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
function beginGetOperationResultsAndWait(scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams): Promise<CostDetailsOperationResults>Parameters
- scope
-
string
The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
- operationId
-
string
The target operation Id.
The options parameters.
Returns
Promise<CostDetailsOperationResults>
Azure SDK for JavaScript