ProductsClient Interface

Package:

com.azure.resourcemanager.billing.fluent

Maven Artifact:

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

public interface ProductsClient

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

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<ProductInner>,ProductInner>	beginMove(String billingAccountName, String productName, MoveProductRequest parameters) Moves a product's charges to a new invoice section.
abstract SyncPoller<PollResult<ProductInner>,ProductInner>	beginMove(String billingAccountName, String productName, MoveProductRequest parameters, Context context) Moves a product's charges to a new invoice section.
abstract ProductInner	get(String billingAccountName, String productName) Gets a product by ID.
abstract Response<ProductInner>	getWithResponse(String billingAccountName, String productName, Context context) Gets a product by ID.
abstract PagedIterable<ProductInner>	listByBillingAccount(String billingAccountName) Lists the products for a billing account.
abstract PagedIterable<ProductInner>	listByBillingAccount(String billingAccountName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the products for a billing account.
abstract PagedIterable<ProductInner>	listByBillingProfile(String billingAccountName, String billingProfileName) Lists the products for a billing profile.
abstract PagedIterable<ProductInner>	listByBillingProfile(String billingAccountName, String billingProfileName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the products for a billing profile.
abstract PagedIterable<ProductInner>	listByCustomer(String billingAccountName, String customerName) Lists the products for a customer.
abstract PagedIterable<ProductInner>	listByCustomer(String billingAccountName, String customerName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the products for a customer.
abstract PagedIterable<ProductInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName) Lists the products for an invoice section.
abstract PagedIterable<ProductInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the products for an invoice section.
abstract ProductInner	move(String billingAccountName, String productName, MoveProductRequest parameters) Moves a product's charges to a new invoice section.
abstract ProductInner	move(String billingAccountName, String productName, MoveProductRequest parameters, Context context) Moves a product's charges to a new invoice section.
abstract ProductInner	update(String billingAccountName, String productName, ProductPatch parameters) Updates the properties of a Product.
abstract Response<ProductInner>	updateWithResponse(String billingAccountName, String productName, ProductPatch parameters, Context context) Updates the properties of a Product.
abstract MoveProductEligibilityResultInner	validateMoveEligibility(String billingAccountName, String productName, MoveProductRequest parameters) Validates if a product's charges can be moved to a new invoice section.
abstract Response<MoveProductEligibilityResultInner>	validateMoveEligibilityWithResponse(String billingAccountName, String productName, MoveProductRequest parameters, Context context) Validates if a product's charges can be moved to a new invoice section.

Method Details

beginMove

public abstract SyncPoller<PollResult<ProductInner>,ProductInner> beginMove(String billingAccountName, String productName, MoveProductRequest parameters)

Moves a product's charges 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 only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

Returns:

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

beginMove

public abstract SyncPoller<PollResult<ProductInner>,ProductInner> beginMove(String billingAccountName, String productName, MoveProductRequest parameters, Context context)

Moves a product's charges 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 only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

context - The context to associate with this operation.

Returns:

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

get

public abstract ProductInner get(String billingAccountName, String productName)

Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

Returns:

a product by ID.

getWithResponse

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

Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

context - The context to associate with this operation.

Returns:

a product by ID along with Response<T>.

listByBillingAccount

public abstract PagedIterable<ProductInner> listByBillingAccount(String billingAccountName)

Lists the products for a billing account. These don't include products billed based on usage. 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.

Returns:

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

listByBillingAccount

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

Lists the products for a billing account. These don't include products billed based on usage. 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.

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<ProductInner> listByBillingProfile(String billingAccountName, String billingProfileName)

Lists the products for a billing profile. These don't include products billed based on usage. 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<ProductInner> listByBillingProfile(String billingAccountName, String billingProfileName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

Lists the products for a billing profile. These don't include products billed based on usage. 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.

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<ProductInner> listByCustomer(String billingAccountName, String customerName)

Lists the products for a customer. These don't include products billed based on usage.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>.

listByCustomer

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

Lists the products for a customer. These don't include products billed based on usage.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.

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<ProductInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName)

Lists the products for an invoice section. These don't include products billed based on usage. 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<ProductInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

Lists the products for an invoice section. These don't include products billed based on usage. 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.

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

move

public abstract ProductInner move(String billingAccountName, String productName, MoveProductRequest parameters)

Moves a product's charges 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 only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

Returns:

a product.

move

public abstract ProductInner move(String billingAccountName, String productName, MoveProductRequest parameters, Context context)

Moves a product's charges 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 only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

context - The context to associate with this operation.

Returns:

a product.

update

public abstract ProductInner update(String billingAccountName, String productName, ProductPatch parameters)

Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - A product.

Returns:

a product.

updateWithResponse

public abstract Response<ProductInner> updateWithResponse(String billingAccountName, String productName, ProductPatch parameters, Context context)

Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - A product.

context - The context to associate with this operation.

Returns:

a product along with Response<T>.

validateMoveEligibility

public abstract MoveProductEligibilityResultInner validateMoveEligibility(String billingAccountName, String productName, MoveProductRequest parameters)

Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

Returns:

result of the transfer eligibility validation.

validateMoveEligibilityWithResponse

public abstract Response<MoveProductEligibilityResultInner> validateMoveEligibilityWithResponse(String billingAccountName, String productName, MoveProductRequest parameters, Context context)

Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

productName - The ID that uniquely identifies a product.

parameters - The properties of the product to initiate a transfer.

context - The context to associate with this operation.

Returns:

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