EnrollmentAccountsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:enrollment_accounts> attribute.

Inheritance
builtins.object
EnrollmentAccountsOperations

Constructor

EnrollmentAccountsOperations(*args, **kwargs)

Methods

get

Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
get_by_department

Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_billing_account

Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_department

Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

get

Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

get(billing_account_name: str, enrollment_account_name: str, **kwargs: Any) -> EnrollmentAccount

Parameters

Name Description
billing_account_name
Required
str

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

The name of the enrollment account. Required.

Returns

Type Description
EnrollmentAccount

EnrollmentAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

get_by_department

Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

get_by_department(billing_account_name: str, department_name: str, enrollment_account_name: str, **kwargs: Any) -> EnrollmentAccount

Parameters

Name Description
billing_account_name
Required
str

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

The name of the department. Required.
enrollment_account_name
Required
str

The name of the enrollment account. Required.

Returns

Type Description
EnrollmentAccount

EnrollmentAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list_by_billing_account

Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

list_by_billing_account(billing_account_name: str, 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[EnrollmentAccount]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
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[EnrollmentAccount]

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

Exceptions

Type Description
HttpResponseError
See also

list_by_department

Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

list_by_department(billing_account_name: str, department_name: str, 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[EnrollmentAccount]

Parameters

Name Description
billing_account_name
Required
str

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

The name of the department. Required.
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[EnrollmentAccount]

An iterator like instance of either EnrollmentAccount 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'>