GenerateCostDetailsReportOperations interface

Package:

@azure/arm-costmanagement

Interface representing a GenerateCostDetailsReport operations.

Properties

beginCreateOperation
beginCreateOperationAndWait
beginGetOperationResults
beginGetOperationResultsAndWait
createOperation	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
getOperationResults	Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.

Property Details

beginCreateOperation

Warning

This API is now deprecated.

use createOperation instead

beginCreateOperation: (scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>

Property Value

(scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>

beginCreateOperationAndWait

Warning

This API is now deprecated.

use createOperation instead

beginCreateOperationAndWait: (scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => Promise<CostDetailsOperationResults>

Property Value

(scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => Promise<CostDetailsOperationResults>

beginGetOperationResults

Warning

This API is now deprecated.

use getOperationResults instead

beginGetOperationResults: (scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>

Property Value

(scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => Promise<SimplePollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>>

beginGetOperationResultsAndWait

Warning

This API is now deprecated.

use getOperationResults instead

beginGetOperationResultsAndWait: (scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => Promise<CostDetailsOperationResults>

Property Value

(scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => Promise<CostDetailsOperationResults>

createOperation

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

createOperation: (scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => PollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>

Property Value

(scope: string, parameters: GenerateCostDetailsReportRequestDefinition, options?: GenerateCostDetailsReportCreateOperationOptionalParams) => PollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>

getOperationResults

Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.

getOperationResults: (scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => PollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>

Property Value

(scope: string, operationId: string, options?: GenerateCostDetailsReportGetOperationResultsOptionalParams) => PollerLike<OperationState<CostDetailsOperationResults>, CostDetailsOperationResults>