Package com.azure.resourcemanager.costmanagement.models

Interface GenerateCostDetailsReports

public interface GenerateCostDetailsReports
Resource collection API of GenerateCostDetailsReports.

  • Method Details

    • createOperation

      CostDetailsOperationResults createOperation(String scope, GenerateCostDetailsReportRequestDefinition parameters)
      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.
      Parameters:
      scope - The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
      parameters - Parameters supplied to the Create cost details operation.
      Returns:
      the result of the long running operation for cost details Api.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOperation

      CostDetailsOperationResults createOperation(String scope, GenerateCostDetailsReportRequestDefinition parameters, com.azure.core.util.Context context)
      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.
      Parameters:
      scope - The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
      parameters - Parameters supplied to the Create cost details operation.
      context - The context to associate with this operation.
      Returns:
      the result of the long running operation for cost details Api.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getOperationResults

      CostDetailsOperationResults getOperationResults(String scope, String operationId)
      Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
      Parameters:
      scope - The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
      operationId - The target operation Id.
      Returns:
      the result of the specified operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getOperationResults

      CostDetailsOperationResults getOperationResults(String scope, String operationId, com.azure.core.util.Context context)
      Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
      Parameters:
      scope - The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
      operationId - The target operation Id.
      context - The context to associate with this operation.
      Returns:
      the result of the specified operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.