BillingSubscriptionsOperations interface

Package:
@azure/arm-billing

Interface representing a BillingSubscriptions operations.

Properties

beginCancel
beginCancelAndWait
beginDelete
beginDeleteAndWait
beginMerge
beginMergeAndWait
beginMove
beginMoveAndWait
beginSplit
beginSplitAndWait
beginUpdate
beginUpdateAndWait
cancel

Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
delete

Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
get

Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.
getByBillingProfile

Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.
listByBillingAccount

Lists the subscriptions for a billing account.
listByBillingProfile

Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
listByCustomer

Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
listByCustomerAtBillingAccount

Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
listByEnrollmentAccount

Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
listByInvoiceSection

Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
merge

Merges the billing subscription provided in the request with a target billing subscription.
move

Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
split

Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
update

Updates the properties of a billing subscription.
validateMoveEligibility

Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

Property Details

beginCancel

Warning

This API is now deprecated.

use cancel instead

beginCancel: (billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginCancelAndWait

Warning

This API is now deprecated.

use cancel instead

beginCancelAndWait: (billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => Promise<void>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => Promise<void>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => Promise<void>

Property Value

(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => Promise<void>

beginMerge

Warning

This API is now deprecated.

use merge instead

beginMerge: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

beginMergeAndWait

Warning

This API is now deprecated.

use merge instead

beginMergeAndWait: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => Promise<BillingSubscription>

beginMove

Warning

This API is now deprecated.

use move instead

beginMove: (billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

beginMoveAndWait

Warning

This API is now deprecated.

use move instead

beginMoveAndWait: (billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => Promise<BillingSubscription>

beginSplit

Warning

This API is now deprecated.

use split instead

beginSplit: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

beginSplitAndWait

Warning

This API is now deprecated.

use split instead

beginSplitAndWait: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => Promise<BillingSubscription>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => Promise<BillingSubscription>

cancel

Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.

cancel: (billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams) => PollerLike<OperationState<void>, void>

delete

Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.

delete: (billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.

get: (billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetOptionalParams) => Promise<BillingSubscription>

getByBillingProfile

Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.

getByBillingProfile: (billingAccountName: string, billingProfileName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetByBillingProfileOptionalParams) => Promise<BillingSubscription>

Property Value

(billingAccountName: string, billingProfileName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetByBillingProfileOptionalParams) => Promise<BillingSubscription>

listByBillingAccount

Lists the subscriptions for a billing account.

listByBillingAccount: (billingAccountName: string, options?: BillingSubscriptionsListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, options?: BillingSubscriptionsListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

listByBillingProfile

Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

listByBillingProfile: (billingAccountName: string, billingProfileName: string, options?: BillingSubscriptionsListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, options?: BillingSubscriptionsListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

listByCustomer

Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

listByCustomer: (billingAccountName: string, billingProfileName: string, customerName: string, options?: BillingSubscriptionsListByCustomerOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, customerName: string, options?: BillingSubscriptionsListByCustomerOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

listByCustomerAtBillingAccount

Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

listByCustomerAtBillingAccount: (billingAccountName: string, customerName: string, options?: BillingSubscriptionsListByCustomerAtBillingAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, customerName: string, options?: BillingSubscriptionsListByCustomerAtBillingAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

listByEnrollmentAccount

Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.

listByEnrollmentAccount: (billingAccountName: string, enrollmentAccountName: string, options?: BillingSubscriptionsListByEnrollmentAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, enrollmentAccountName: string, options?: BillingSubscriptionsListByEnrollmentAccountOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

listByInvoiceSection

Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

listByInvoiceSection: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: BillingSubscriptionsListByInvoiceSectionOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: BillingSubscriptionsListByInvoiceSectionOptionalParams) => PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>

merge

Merges the billing subscription provided in the request with a target billing subscription.

merge: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

move

Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

move: (billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

split

Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.

split: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

update

Updates the properties of a billing subscription.

update: (billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams) => PollerLike<OperationState<BillingSubscription>, BillingSubscription>

validateMoveEligibility

Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

validateMoveEligibility: (billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsValidateMoveEligibilityOptionalParams) => Promise<MoveBillingSubscriptionEligibilityResult>

Property Value

(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsValidateMoveEligibilityOptionalParams) => Promise<MoveBillingSubscriptionEligibilityResult>