CustomersOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:customers> attribute.

Inheritance
builtins.object
CustomersOperations

Constructor

CustomersOperations(*args, **kwargs)

Methods

get

Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
get_by_billing_account

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_billing_account

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

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

get

Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

get(billing_account_name: str, billing_profile_name: str, customer_name: str, **kwargs: Any) -> Customer

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.

Returns

Type Description
Customer

Customer or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

get_by_billing_account

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

get_by_billing_account(billing_account_name: str, customer_name: str, **kwargs: Any) -> Customer

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.

Returns

Type Description
Customer

Customer or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_account

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

list_by_billing_account(billing_account_name: str, expand: str | None = None, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> Iterable[Customer]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
expand
Required
str

May be used to expand enabledAzurePlans and resellers. Default value is None.
filter
Required
str

The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by
Required
str

The orderby query option allows clients to request resources in a particular order. Default value is None.
top
Required
int

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. Default value is None.
skip
Required
int

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
count
Required
bool

The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
search
Required
str

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. Default value is None.

Returns

Type Description
ItemPaged[Customer]

An iterator like instance of either Customer or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_profile

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

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, expand: str | None = None, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> Iterable[Customer]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
billing_profile_name
Required
str

The ID that uniquely identifies a billing profile. Required.
expand
Required
str

May be used to expand enabledAzurePlans and resellers. Default value is None.
filter
Required
str

The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by
Required
str

The orderby query option allows clients to request resources in a particular order. Default value is None.
top
Required
int

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. Default value is None.
skip
Required
int

The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
count
Required
bool

The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
search
Required
str

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. Default value is None.

Returns

Type Description
ItemPaged[Customer]

An iterator like instance of either Customer or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

Attributes

models 

models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>