BillingSubscriptionsClient Interface

Package:

com.azure.resourcemanager.billing.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

public interface BillingSubscriptionsClient

An instance of this class provides access to all the operations defined in BillingSubscriptionsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<Void>,Void>	beginCancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters) Cancels a usage-based subscription.
abstract SyncPoller<PollResult<Void>,Void>	beginCancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters, Context context) Cancels a usage-based subscription.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String billingAccountName, String billingSubscriptionName) Cancels a billing subscription.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String billingAccountName, String billingSubscriptionName, Context context) Cancels a billing subscription.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginMerge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters) Merges the billing subscription provided in the request with a target billing subscription.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginMerge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters, Context context) Merges the billing subscription provided in the request with a target billing subscription.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginMove(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters) Moves charges for a subscription to a new invoice section.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginMove(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context) Moves charges for a subscription to a new invoice section.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginSplit(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters) Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginSplit(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters, Context context) Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginUpdate(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters) Updates the properties of a billing subscription.
abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner>	beginUpdate(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters, Context context) Updates the properties of a billing subscription.
abstract void	cancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters) Cancels a usage-based subscription.
abstract void	cancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters, Context context) Cancels a usage-based subscription.
abstract void	delete(String billingAccountName, String billingSubscriptionName) Cancels a billing subscription.
abstract void	delete(String billingAccountName, String billingSubscriptionName, Context context) Cancels a billing subscription.
abstract BillingSubscriptionInner	get(String billingAccountName, String billingSubscriptionName) Gets a subscription by its ID.
abstract BillingSubscriptionInner	getByBillingProfile(String billingAccountName, String billingProfileName, String billingSubscriptionName) Gets a subscription by its billing profile and ID.
abstract Response<BillingSubscriptionInner>	getByBillingProfileWithResponse(String billingAccountName, String billingProfileName, String billingSubscriptionName, String expand, Context context) Gets a subscription by its billing profile and ID.
abstract Response<BillingSubscriptionInner>	getWithResponse(String billingAccountName, String billingSubscriptionName, String expand, Context context) Gets a subscription by its ID.
abstract PagedIterable<BillingSubscriptionInner>	listByBillingAccount(String billingAccountName) Lists the subscriptions for a billing account.
abstract PagedIterable<BillingSubscriptionInner>	listByBillingAccount(String billingAccountName, Boolean includeDeleted, Boolean includeTenantSubscriptions, Boolean includeFailed, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions for a billing account.
abstract PagedIterable<BillingSubscriptionInner>	listByBillingProfile(String billingAccountName, String billingProfileName) Lists the subscriptions that are billed to a billing profile.
abstract PagedIterable<BillingSubscriptionInner>	listByBillingProfile(String billingAccountName, String billingProfileName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions that are billed to a billing profile.
abstract PagedIterable<BillingSubscriptionInner>	listByCustomer(String billingAccountName, String billingProfileName, String customerName) Lists the subscriptions for a customer.
abstract PagedIterable<BillingSubscriptionInner>	listByCustomer(String billingAccountName, String billingProfileName, String customerName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions for a customer.
abstract PagedIterable<BillingSubscriptionInner>	listByCustomerAtBillingAccount(String billingAccountName, String customerName) Lists the subscriptions for a customer at billing account level.
abstract PagedIterable<BillingSubscriptionInner>	listByCustomerAtBillingAccount(String billingAccountName, String customerName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions for a customer at billing account level.
abstract PagedIterable<BillingSubscriptionInner>	listByEnrollmentAccount(String billingAccountName, String enrollmentAccountName) Lists the subscriptions for an enrollment account.
abstract PagedIterable<BillingSubscriptionInner>	listByEnrollmentAccount(String billingAccountName, String enrollmentAccountName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions for an enrollment account.
abstract PagedIterable<BillingSubscriptionInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName) Lists the subscriptions that are billed to an invoice section.
abstract PagedIterable<BillingSubscriptionInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the subscriptions that are billed to an invoice section.
abstract BillingSubscriptionInner	merge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters) Merges the billing subscription provided in the request with a target billing subscription.
abstract BillingSubscriptionInner	merge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters, Context context) Merges the billing subscription provided in the request with a target billing subscription.
abstract BillingSubscriptionInner	move(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters) Moves charges for a subscription to a new invoice section.
abstract BillingSubscriptionInner	move(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context) Moves charges for a subscription to a new invoice section.
abstract BillingSubscriptionInner	split(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters) Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
abstract BillingSubscriptionInner	split(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters, Context context) Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
abstract BillingSubscriptionInner	update(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters) Updates the properties of a billing subscription.
abstract BillingSubscriptionInner	update(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters, Context context) Updates the properties of a billing subscription.
abstract MoveBillingSubscriptionEligibilityResultInner	validateMoveEligibility(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters) Validates if charges for a subscription can be moved to a new invoice section.
abstract Response<MoveBillingSubscriptionEligibilityResultInner>	validateMoveEligibilityWithResponse(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context) Validates if charges for a subscription can be moved to a new invoice section.

Method Details

beginCancel

public abstract SyncPoller<PollResult<Void>,Void> beginCancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters for cancel customer subscription.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCancel

public abstract SyncPoller<PollResult<Void>,Void> beginCancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters for cancel customer subscription.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String billingAccountName, String billingSubscriptionName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String billingAccountName, String billingSubscriptionName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginMerge

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginMerge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to merge the two billing subscriptions.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginMerge

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginMerge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to merge the two billing subscriptions.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginMove

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginMove(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginMove

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginMove(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginSplit

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginSplit(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to split the billing subscription.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginSplit

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginSplit(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to split the billing subscription.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginUpdate

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginUpdate(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters)

Updates the properties of a billing subscription.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - The billing properties of a subscription.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

beginUpdate

public abstract SyncPoller<PollResult<BillingSubscriptionInner>,BillingSubscriptionInner> beginUpdate(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters, Context context)

Updates the properties of a billing subscription.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - The billing properties of a subscription.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the billing properties of a subscription.

cancel

public abstract void cancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters for cancel customer subscription.

cancel

public abstract void cancel(String billingAccountName, String billingSubscriptionName, CancelSubscriptionRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters for cancel customer subscription.

context - The context to associate with this operation.

delete

public abstract void delete(String billingAccountName, String billingSubscriptionName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

delete

public abstract void delete(String billingAccountName, String billingSubscriptionName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

context - The context to associate with this operation.

get

public abstract BillingSubscriptionInner get(String billingAccountName, String billingSubscriptionName)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

Returns:

a subscription by its ID.

getByBillingProfile

public abstract BillingSubscriptionInner getByBillingProfile(String billingAccountName, String billingProfileName, String billingSubscriptionName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

billingSubscriptionName - The ID that uniquely identifies a subscription.

Returns:

a subscription by its billing profile and ID.

getByBillingProfileWithResponse

public abstract Response<BillingSubscriptionInner> getByBillingProfileWithResponse(String billingAccountName, String billingProfileName, String billingSubscriptionName, String expand, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

billingSubscriptionName - The ID that uniquely identifies a subscription.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

context - The context to associate with this operation.

Returns:

a subscription by its billing profile and ID along with Response<T>.

getWithResponse

public abstract Response<BillingSubscriptionInner> getWithResponse(String billingAccountName, String billingSubscriptionName, String expand, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

context - The context to associate with this operation.

Returns:

a subscription by its ID along with Response<T>.

listByBillingAccount

public abstract PagedIterable<BillingSubscriptionInner> listByBillingAccount(String billingAccountName)

Lists the subscriptions for a billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByBillingAccount

public abstract PagedIterable<BillingSubscriptionInner> listByBillingAccount(String billingAccountName, Boolean includeDeleted, Boolean includeTenantSubscriptions, Boolean includeFailed, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

Lists the subscriptions for a billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

includeDeleted - Can be used to get deleted billing subscriptions.

includeTenantSubscriptions - Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts.

includeFailed - Can be used to get failed billing subscriptions.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<BillingSubscriptionInner> listByBillingProfile(String billingAccountName, String billingProfileName)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<BillingSubscriptionInner> listByBillingProfile(String billingAccountName, String billingProfileName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

includeDeleted - Can be used to get deleted billing subscriptions.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomer

public abstract PagedIterable<BillingSubscriptionInner> listByCustomer(String billingAccountName, String billingProfileName, String customerName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

customerName - The ID that uniquely identifies a customer.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomer

public abstract PagedIterable<BillingSubscriptionInner> listByCustomer(String billingAccountName, String billingProfileName, String customerName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

customerName - The ID that uniquely identifies a customer.

includeDeleted - Can be used to get deleted billing subscriptions.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomerAtBillingAccount

public abstract PagedIterable<BillingSubscriptionInner> listByCustomerAtBillingAccount(String billingAccountName, String customerName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

customerName - The ID that uniquely identifies a customer.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomerAtBillingAccount

public abstract PagedIterable<BillingSubscriptionInner> listByCustomerAtBillingAccount(String billingAccountName, String customerName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

customerName - The ID that uniquely identifies a customer.

includeDeleted - Can be used to get deleted billing subscriptions.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByEnrollmentAccount

public abstract PagedIterable<BillingSubscriptionInner> listByEnrollmentAccount(String billingAccountName, String enrollmentAccountName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

enrollmentAccountName - The name of the enrollment account.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByEnrollmentAccount

public abstract PagedIterable<BillingSubscriptionInner> listByEnrollmentAccount(String billingAccountName, String enrollmentAccountName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

enrollmentAccountName - The name of the enrollment account.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoiceSection

public abstract PagedIterable<BillingSubscriptionInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

invoiceSectionName - The ID that uniquely identifies an invoice section.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoiceSection

public abstract PagedIterable<BillingSubscriptionInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeDeleted, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

invoiceSectionName - The ID that uniquely identifies an invoice section.

includeDeleted - Can be used to get deleted billing subscriptions.

expand - Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

top - The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

search - The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

merge

public abstract BillingSubscriptionInner merge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to merge the two billing subscriptions.

Returns:

the billing properties of a subscription.

merge

public abstract BillingSubscriptionInner merge(String billingAccountName, String billingSubscriptionName, BillingSubscriptionMergeRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to merge the two billing subscriptions.

context - The context to associate with this operation.

Returns:

the billing properties of a subscription.

move

public abstract BillingSubscriptionInner move(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

Returns:

the billing properties of a subscription.

move

public abstract BillingSubscriptionInner move(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

context - The context to associate with this operation.

Returns:

the billing properties of a subscription.

split

public abstract BillingSubscriptionInner split(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to split the billing subscription.

Returns:

the billing properties of a subscription.

split

public abstract BillingSubscriptionInner split(String billingAccountName, String billingSubscriptionName, BillingSubscriptionSplitRequest parameters, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters that are provided to split the billing subscription.

context - The context to associate with this operation.

Returns:

the billing properties of a subscription.

update

public abstract BillingSubscriptionInner update(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters)

Updates the properties of a billing subscription.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - The billing properties of a subscription.

Returns:

the billing properties of a subscription.

update

public abstract BillingSubscriptionInner update(String billingAccountName, String billingSubscriptionName, BillingSubscriptionPatch parameters, Context context)

Updates the properties of a billing subscription.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - The billing properties of a subscription.

context - The context to associate with this operation.

Returns:

the billing properties of a subscription.

validateMoveEligibility

public abstract MoveBillingSubscriptionEligibilityResultInner validateMoveEligibility(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

Returns:

result of the transfer eligibility validation.

validateMoveEligibilityWithResponse

public abstract Response<MoveBillingSubscriptionEligibilityResultInner> validateMoveEligibilityWithResponse(String billingAccountName, String billingSubscriptionName, MoveBillingSubscriptionRequest parameters, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingSubscriptionName - The ID that uniquely identifies a subscription.

parameters - Request parameters to transfer billing subscription.

context - The context to associate with this operation.

Returns:

result of the transfer eligibility validation along with Response<T>.