BillingSubscriptions interface
Interface representing a BillingSubscriptions.
Methods
| begin |
Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement. |
| begin |
Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement. |
| begin |
Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| begin |
Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| begin |
Merges the billing subscription provided in the request with a target billing subscription. |
| begin |
Merges the billing subscription provided in the request with a target billing subscription. |
| begin |
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. |
| begin |
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. |
| begin |
Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0. |
| begin |
Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0. |
| begin |
Updates the properties of a billing subscription. |
| begin |
Updates the properties of a billing subscription. |
| get(string, string, Billing |
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 |
Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| list |
Lists the subscriptions for a billing account. |
| list |
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. |
| list |
Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. |
| list |
Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. |
| list |
Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| list |
Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| validate |
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. |
Method Details
beginCancel(string, string, CancelSubscriptionRequest, BillingSubscriptionsCancelOptionalParams)
Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
function beginCancel(billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscriptionsCancelHeaders>, BillingSubscriptionsCancelHeaders>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- CancelSubscriptionRequest
Request parameters for cancel customer subscription.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscriptionsCancelHeaders>, BillingSubscriptionsCancelHeaders>>
beginCancelAndWait(string, string, CancelSubscriptionRequest, BillingSubscriptionsCancelOptionalParams)
Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
function beginCancelAndWait(billingAccountName: string, billingSubscriptionName: string, parameters: CancelSubscriptionRequest, options?: BillingSubscriptionsCancelOptionalParams): Promise<BillingSubscriptionsCancelHeaders>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- CancelSubscriptionRequest
Request parameters for cancel customer subscription.
The options parameters.
Returns
Promise<BillingSubscriptionsCancelHeaders>
beginDelete(string, string, BillingSubscriptionsDeleteOptionalParams)
Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
function beginDelete(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscriptionsDeleteHeaders>, BillingSubscriptionsDeleteHeaders>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscriptionsDeleteHeaders>, BillingSubscriptionsDeleteHeaders>>
beginDeleteAndWait(string, string, BillingSubscriptionsDeleteOptionalParams)
Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
function beginDeleteAndWait(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsDeleteOptionalParams): Promise<BillingSubscriptionsDeleteHeaders>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
The options parameters.
Returns
Promise<BillingSubscriptionsDeleteHeaders>
beginMerge(string, string, BillingSubscriptionMergeRequest, BillingSubscriptionsMergeOptionalParams)
Merges the billing subscription provided in the request with a target billing subscription.
function beginMerge(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionMergeRequest
Request parameters that are provided to merge the two billing subscriptions.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>
beginMergeAndWait(string, string, BillingSubscriptionMergeRequest, BillingSubscriptionsMergeOptionalParams)
Merges the billing subscription provided in the request with a target billing subscription.
function beginMergeAndWait(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionMergeRequest, options?: BillingSubscriptionsMergeOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionMergeRequest
Request parameters that are provided to merge the two billing subscriptions.
The options parameters.
Returns
Promise<BillingSubscription>
beginMove(string, string, MoveBillingSubscriptionRequest, BillingSubscriptionsMoveOptionalParams)
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.
function beginMove(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- MoveBillingSubscriptionRequest
Request parameters to transfer billing subscription.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>
beginMoveAndWait(string, string, MoveBillingSubscriptionRequest, BillingSubscriptionsMoveOptionalParams)
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.
function beginMoveAndWait(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsMoveOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- MoveBillingSubscriptionRequest
Request parameters to transfer billing subscription.
The options parameters.
Returns
Promise<BillingSubscription>
beginSplit(string, string, BillingSubscriptionSplitRequest, BillingSubscriptionsSplitOptionalParams)
Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
function beginSplit(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionSplitRequest
Request parameters that are provided to split the billing subscription.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>
beginSplitAndWait(string, string, BillingSubscriptionSplitRequest, BillingSubscriptionsSplitOptionalParams)
Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
function beginSplitAndWait(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionSplitRequest, options?: BillingSubscriptionsSplitOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionSplitRequest
Request parameters that are provided to split the billing subscription.
The options parameters.
Returns
Promise<BillingSubscription>
beginUpdate(string, string, BillingSubscriptionPatch, BillingSubscriptionsUpdateOptionalParams)
Updates the properties of a billing subscription.
function beginUpdate(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionPatch
The billing properties of a subscription.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingSubscription>, BillingSubscription>>
beginUpdateAndWait(string, string, BillingSubscriptionPatch, BillingSubscriptionsUpdateOptionalParams)
Updates the properties of a billing subscription.
function beginUpdateAndWait(billingAccountName: string, billingSubscriptionName: string, parameters: BillingSubscriptionPatch, options?: BillingSubscriptionsUpdateOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- BillingSubscriptionPatch
The billing properties of a subscription.
The options parameters.
Returns
Promise<BillingSubscription>
get(string, string, BillingSubscriptionsGetOptionalParams)
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.
function get(billingAccountName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
The options parameters.
Returns
Promise<BillingSubscription>
getByBillingProfile(string, string, string, BillingSubscriptionsGetByBillingProfileOptionalParams)
Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function getByBillingProfile(billingAccountName: string, billingProfileName: string, billingSubscriptionName: string, options?: BillingSubscriptionsGetByBillingProfileOptionalParams): Promise<BillingSubscription>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
The options parameters.
Returns
Promise<BillingSubscription>
listByBillingAccount(string, BillingSubscriptionsListByBillingAccountOptionalParams)
Lists the subscriptions for a billing account.
function listByBillingAccount(billingAccountName: string, options?: BillingSubscriptionsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
The options parameters.
Returns
listByBillingProfile(string, string, BillingSubscriptionsListByBillingProfileOptionalParams)
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.
function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: BillingSubscriptionsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
The options parameters.
Returns
listByCustomer(string, string, string, BillingSubscriptionsListByCustomerOptionalParams)
Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
function listByCustomer(billingAccountName: string, billingProfileName: string, customerName: string, options?: BillingSubscriptionsListByCustomerOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- customerName
-
string
The ID that uniquely identifies a customer.
The options parameters.
Returns
listByCustomerAtBillingAccount(string, string, BillingSubscriptionsListByCustomerAtBillingAccountOptionalParams)
Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
function listByCustomerAtBillingAccount(billingAccountName: string, customerName: string, options?: BillingSubscriptionsListByCustomerAtBillingAccountOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- customerName
-
string
The ID that uniquely identifies a customer.
The options parameters.
Returns
listByEnrollmentAccount(string, string, BillingSubscriptionsListByEnrollmentAccountOptionalParams)
Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function listByEnrollmentAccount(billingAccountName: string, enrollmentAccountName: string, options?: BillingSubscriptionsListByEnrollmentAccountOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- enrollmentAccountName
-
string
The name of the enrollment account.
The options parameters.
Returns
listByInvoiceSection(string, string, string, BillingSubscriptionsListByInvoiceSectionOptionalParams)
Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function listByInvoiceSection(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: BillingSubscriptionsListByInvoiceSectionOptionalParams): PagedAsyncIterableIterator<BillingSubscription, BillingSubscription[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
The options parameters.
Returns
validateMoveEligibility(string, string, MoveBillingSubscriptionRequest, BillingSubscriptionsValidateMoveEligibilityOptionalParams)
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.
function validateMoveEligibility(billingAccountName: string, billingSubscriptionName: string, parameters: MoveBillingSubscriptionRequest, options?: BillingSubscriptionsValidateMoveEligibilityOptionalParams): Promise<MoveBillingSubscriptionEligibilityResult>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingSubscriptionName
-
string
The ID that uniquely identifies a subscription.
- parameters
- MoveBillingSubscriptionRequest
Request parameters to transfer billing subscription.
The options parameters.