CustomersClient Interface

Package:

com.azure.resourcemanager.billing.fluent

Maven Artifact:

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

public interface CustomersClient

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

Method Summary

Modifier and Type	Method and Description
abstract CustomerInner	get(String billingAccountName, String billingProfileName, String customerName) Gets a customer by its ID.
abstract CustomerInner	getByBillingAccount(String billingAccountName, String customerName) Gets a customer by its ID at billing account level.
abstract Response<CustomerInner>	getByBillingAccountWithResponse(String billingAccountName, String customerName, Context context) Gets a customer by its ID at billing account level.
abstract Response<CustomerInner>	getWithResponse(String billingAccountName, String billingProfileName, String customerName, Context context) Gets a customer by its ID.
abstract PagedIterable<CustomerInner>	listByBillingAccount(String billingAccountName) Lists the customers that are billed to a billing account.
abstract PagedIterable<CustomerInner>	listByBillingAccount(String billingAccountName, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the customers that are billed to a billing account.
abstract PagedIterable<CustomerInner>	listByBillingProfile(String billingAccountName, String billingProfileName) Lists the customers that are billed to a billing profile.
abstract PagedIterable<CustomerInner>	listByBillingProfile(String billingAccountName, String billingProfileName, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the customers that are billed to a billing profile.

Method Details

get

public abstract CustomerInner get(String billingAccountName, String billingProfileName, String customerName)

Gets a customer by its ID. 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 customer by its ID.

getByBillingAccount

public abstract CustomerInner getByBillingAccount(String billingAccountName, String customerName)

Gets a customer by its ID 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 customer by its ID at billing account level.

getByBillingAccountWithResponse

public abstract Response<CustomerInner> getByBillingAccountWithResponse(String billingAccountName, String customerName, Context context)

Gets a customer by its ID 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.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response<CustomerInner> getWithResponse(String billingAccountName, String billingProfileName, String customerName, Context context)

Gets a customer by its ID. 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.

context - The context to associate with this operation.

Returns:

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

listByBillingAccount

public abstract PagedIterable<CustomerInner> listByBillingAccount(String billingAccountName)

Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type 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<CustomerInner> listByBillingAccount(String billingAccountName, String expand, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

expand - May be used to expand enabledAzurePlans and resellers.

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

Lists the customers that are billed to a billing profile. 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.

Returns:

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

listByBillingProfile

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

Lists the customers that are billed to a billing profile. 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.

expand - May be used to expand enabledAzurePlans and resellers.

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