CustomersOperations Class

CustomersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

CustomersOperations

Constructor

CustomersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

get	Gets a customer by its ID. 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, customer_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.Customer

Parameters

billing_account_name

str

Required

The ID that uniquely identifies a billing account.

customer_name

str

Required

The ID that uniquely identifies a customer.

expand

str

default value: None

May be used to expand enabledAzurePlans and resellers.

cls

callable

A custom type or function that will be passed the direct response

Returns

Customer, or the result of cls(response)

Return type

Customer

Exceptions

HttpResponseError

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, search: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.CustomerListResult]

Parameters

billing_account_name

str

Required

The ID that uniquely identifies a billing account.

search

str

default value: None

Used for searching customers by their name. Any customer with name containing the search text will be included in the response.

filter

str

default value: None

May be used to filter the list of customers.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[CustomerListResult]

Exceptions

HttpResponseError

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, search: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.CustomerListResult]

Parameters

billing_account_name

str

Required

The ID that uniquely identifies a billing account.

billing_profile_name

str

Required

The ID that uniquely identifies a billing profile.

search

str

default value: None

Used for searching customers by their name. Any customer with name containing the search text will be included in the response.

filter

str

default value: None

May be used to filter the list of customers.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[CustomerListResult]

Exceptions

HttpResponseError

Attributes

models

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