BillingAccountsClient Interface

Package:

com.azure.resourcemanager.billing.fluent

Maven Artifact:

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

public interface BillingAccountsClient

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

Method Summary

Modifier and Type	Method and Description
abstract BillingAccountInner	addPaymentTerms(String billingAccountName, List<PaymentTerm> parameters) Adds payment terms to all the billing profiles under the billing account.
abstract BillingAccountInner	addPaymentTerms(String billingAccountName, List<PaymentTerm> parameters, Context context) Adds payment terms to all the billing profiles under the billing account.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginAddPaymentTerms(String billingAccountName, List<PaymentTerm> parameters) Adds payment terms to all the billing profiles under the billing account.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginAddPaymentTerms(String billingAccountName, List<PaymentTerm> parameters, Context context) Adds payment terms to all the billing profiles under the billing account.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginCancelPaymentTerms(String billingAccountName, OffsetDateTime parameters) Cancels all the payment terms on billing account that falls after the cancellation date in the request.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginCancelPaymentTerms(String billingAccountName, OffsetDateTime parameters, Context context) Cancels all the payment terms on billing account that falls after the cancellation date in the request.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginUpdate(String billingAccountName, BillingAccountPatch parameters) Updates the properties of a billing account.
abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner>	beginUpdate(String billingAccountName, BillingAccountPatch parameters, Context context) Updates the properties of a billing account.
abstract BillingAccountInner	cancelPaymentTerms(String billingAccountName, OffsetDateTime parameters) Cancels all the payment terms on billing account that falls after the cancellation date in the request.
abstract BillingAccountInner	cancelPaymentTerms(String billingAccountName, OffsetDateTime parameters, Context context) Cancels all the payment terms on billing account that falls after the cancellation date in the request.
abstract TransitionDetailsInner	confirmTransition(String billingAccountName) Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.
abstract Response<TransitionDetailsInner>	confirmTransitionWithResponse(String billingAccountName, Context context) Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.
abstract BillingAccountInner	get(String billingAccountName) Gets a billing account by its ID.
abstract Response<BillingAccountInner>	getWithResponse(String billingAccountName, Context context) Gets a billing account by its ID.
abstract PagedIterable<BillingAccountInner>	list() Lists the billing accounts that a user has access to.
abstract PagedIterable<BillingAccountInner>	list(Boolean includeAll, Boolean includeAllWithoutBillingProfiles, Boolean includeDeleted, Boolean includePendingAgreement, Boolean includeResellee, String legalOwnerTid, String legalOwnerOid, String filter, String expand, Long top, Long skip, String search, Context context) Lists the billing accounts that a user has access to.
abstract PagedIterable<InvoiceSectionWithCreateSubPermissionInner>	listInvoiceSectionsByCreateSubscriptionPermission(String billingAccountName) Lists the invoice sections for which the user has permission to create Azure subscriptions.
abstract PagedIterable<InvoiceSectionWithCreateSubPermissionInner>	listInvoiceSectionsByCreateSubscriptionPermission(String billingAccountName, String filter, Context context) Lists the invoice sections for which the user has permission to create Azure subscriptions.
abstract BillingAccountInner	update(String billingAccountName, BillingAccountPatch parameters) Updates the properties of a billing account.
abstract BillingAccountInner	update(String billingAccountName, BillingAccountPatch parameters, Context context) Updates the properties of a billing account.
abstract PaymentTermsEligibilityResultInner	validatePaymentTerms(String billingAccountName, List<PaymentTerm> parameters) Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
abstract Response<PaymentTermsEligibilityResultInner>	validatePaymentTermsWithResponse(String billingAccountName, List<PaymentTerm> parameters, Context context) Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

Method Details

addPaymentTerms

public abstract BillingAccountInner addPaymentTerms(String billingAccountName, List<PaymentTerm> parameters)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

Returns:

a billing account.

addPaymentTerms

public abstract BillingAccountInner addPaymentTerms(String billingAccountName, List<PaymentTerm> parameters, Context context)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

context - The context to associate with this operation.

Returns:

a billing account.

beginAddPaymentTerms

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginAddPaymentTerms(String billingAccountName, List<PaymentTerm> parameters)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

Returns:

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

beginAddPaymentTerms

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginAddPaymentTerms(String billingAccountName, List<PaymentTerm> parameters, Context context)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

context - The context to associate with this operation.

Returns:

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

beginCancelPaymentTerms

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginCancelPaymentTerms(String billingAccountName, OffsetDateTime parameters)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - Date after which any payment terms that needs to be cancelled.

Returns:

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

beginCancelPaymentTerms

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginCancelPaymentTerms(String billingAccountName, OffsetDateTime parameters, Context context)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - Date after which any payment terms that needs to be cancelled.

context - The context to associate with this operation.

Returns:

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

beginUpdate

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginUpdate(String billingAccountName, BillingAccountPatch parameters)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - A billing account.

Returns:

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

beginUpdate

public abstract SyncPoller<PollResult<BillingAccountInner>,BillingAccountInner> beginUpdate(String billingAccountName, BillingAccountPatch parameters, Context context)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - A billing account.

context - The context to associate with this operation.

Returns:

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

cancelPaymentTerms

public abstract BillingAccountInner cancelPaymentTerms(String billingAccountName, OffsetDateTime parameters)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - Date after which any payment terms that needs to be cancelled.

Returns:

a billing account.

cancelPaymentTerms

public abstract BillingAccountInner cancelPaymentTerms(String billingAccountName, OffsetDateTime parameters, Context context)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - Date after which any payment terms that needs to be cancelled.

context - The context to associate with this operation.

Returns:

a billing account.

confirmTransition

public abstract TransitionDetailsInner confirmTransition(String billingAccountName)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

confirmTransitionWithResponse

public abstract Response<TransitionDetailsInner> confirmTransitionWithResponse(String billingAccountName, Context context)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

context - The context to associate with this operation.

Returns:

the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement along with Response<T>.

get

public abstract BillingAccountInner get(String billingAccountName)

Gets a billing account by its ID.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

a billing account by its ID.

getWithResponse

public abstract Response<BillingAccountInner> getWithResponse(String billingAccountName, Context context)

Gets a billing account by its ID.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

context - The context to associate with this operation.

Returns:

a billing account by its ID along with Response<T>.

list

public abstract PagedIterable<BillingAccountInner> list()

Lists the billing accounts that a user has access to.

Returns:

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

list

public abstract PagedIterable<BillingAccountInner> list(Boolean includeAll, Boolean includeAllWithoutBillingProfiles, Boolean includeDeleted, Boolean includePendingAgreement, Boolean includeResellee, String legalOwnerTid, String legalOwnerOid, String filter, String expand, Long top, Long skip, String search, Context context)

Lists the billing accounts that a user has access to.

Parameters:

includeAll - When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.

includeAllWithoutBillingProfiles - When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.

includeDeleted - When true, results will include any billing accounts in a deleted state.

includePendingAgreement - Includes billing accounts with agreement pending signature that the user has access to.

includeResellee - Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.

legalOwnerTid - Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.

legalOwnerOid - Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.

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

expand - Expand is allowed for SoldTo and EnrollmentDetails/PONumber.

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.

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>.

listInvoiceSectionsByCreateSubscriptionPermission

public abstract PagedIterable<InvoiceSectionWithCreateSubPermissionInner> listInvoiceSectionsByCreateSubscriptionPermission(String billingAccountName)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

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

listInvoiceSectionsByCreateSubscriptionPermission

public abstract PagedIterable<InvoiceSectionWithCreateSubPermissionInner> listInvoiceSectionsByCreateSubscriptionPermission(String billingAccountName, String filter, Context context)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

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

context - The context to associate with this operation.

Returns:

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

update

public abstract BillingAccountInner update(String billingAccountName, BillingAccountPatch parameters)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - A billing account.

Returns:

a billing account.

update

public abstract BillingAccountInner update(String billingAccountName, BillingAccountPatch parameters, Context context)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - A billing account.

context - The context to associate with this operation.

Returns:

a billing account.

validatePaymentTerms

public abstract PaymentTermsEligibilityResultInner validatePaymentTerms(String billingAccountName, List<PaymentTerm> parameters)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

Returns:

result of the payment terms eligibility.

validatePaymentTermsWithResponse

public abstract Response<PaymentTermsEligibilityResultInner> validatePaymentTermsWithResponse(String billingAccountName, List<PaymentTerm> parameters, Context context)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

parameters - The properties of payment term.

context - The context to associate with this operation.

Returns:

result of the payment terms eligibility along with Response<T>.