MockableCostManagementArmClient.DownloadByBillingAccountAsync Method

Definition

Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers. Migrate to version 2025-03-01 You can use the 2025-03-01 API version with the new URI: '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' With a new schema detailed below, the new version of the price sheet provides additional information and includes prices for Azure Reserved Instances (RI) for the current billing period. We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain an ongoing record of past Azure Reserved Instance (RI) pricing. The EA Azure price sheet is available for billing periods in the past 13 months. To request a price sheet for a billing period older than 13 months, please contact support. The Azure price sheet download experience has been updated from a single .csv file to a zip file containing multiple .csv files, each with max size of 75MB. The 2023-11-01 version has been upgraded to use http POST method; details can be found below. All versions of the Microsoft.Consumption Azure Price Sheet - Download by Billing Account (including 2022-06-01, 2021-10-01, 2020-01-01-preview, 2019-10-01, 2019-05-01) are scheduled to be retired on 01 June 2026 and will no longer be supported after this date.

  • Request Path. : /providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download.
  • Operation Id. : PriceSheetOperationGroup_DownloadByBillingAccount.
  • Default Api Version. : 2025-03-01.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CostManagement.Models.OperationStatus>> DownloadByBillingAccountAsync(Azure.WaitUntil waitUntil, Azure.Core.ResourceIdentifier scope, System.Threading.CancellationToken cancellationToken = default);
abstract member DownloadByBillingAccountAsync : Azure.WaitUntil * Azure.Core.ResourceIdentifier * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CostManagement.Models.OperationStatus>>
override this.DownloadByBillingAccountAsync : Azure.WaitUntil * Azure.Core.ResourceIdentifier * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CostManagement.Models.OperationStatus>>
Public Overridable Function DownloadByBillingAccountAsync (waitUntil As WaitUntil, scope As ResourceIdentifier, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of OperationStatus))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

scope
ResourceIdentifier

The scope that the resource will apply against.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

scope is null.

Applies to