BillingExtensions.DownloadDocumentsByBillingSubscriptionInvoiceAsync Method

Definition

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

  • Request Path: /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments
  • Operation Id: Invoices_DownloadDocumentsByBillingSubscription
  • Default Api Version: 2024-04-01
public static System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Billing.Models.BillingDocumentDownloadResult>> DownloadDocumentsByBillingSubscriptionInvoiceAsync (this Azure.ResourceManager.Resources.TenantResource tenantResource, Azure.WaitUntil waitUntil, string subscriptionId, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Billing.Models.BillingDocumentDownloadRequestContent> arrayOfDocumentDownloadRequest, System.Threading.CancellationToken cancellationToken = default);
static member DownloadDocumentsByBillingSubscriptionInvoiceAsync : Azure.ResourceManager.Resources.TenantResource * Azure.WaitUntil * string * seq<Azure.ResourceManager.Billing.Models.BillingDocumentDownloadRequestContent> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Billing.Models.BillingDocumentDownloadResult>>
<Extension()>
Public Function DownloadDocumentsByBillingSubscriptionInvoiceAsync (tenantResource As TenantResource, waitUntil As WaitUntil, subscriptionId As String, arrayOfDocumentDownloadRequest As IEnumerable(Of BillingDocumentDownloadRequestContent), Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of BillingDocumentDownloadResult))

Parameters

tenantResource
TenantResource

The TenantResource instance the method will execute against.

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.

subscriptionId
String

The ID that uniquely identifies a billing subscription.

arrayOfDocumentDownloadRequest
IEnumerable<BillingDocumentDownloadRequestContent>

A list of download details for individual documents.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

subscriptionId is an empty string, and was expected to be non-empty.

tenantResource, subscriptionId or arrayOfDocumentDownloadRequest is null.

Applies to