BillingRoleAssignmentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_role_assignments> attribute.

Inheritance
builtins.object
BillingRoleAssignmentsOperations

Constructor

BillingRoleAssignmentsOperations(*args, **kwargs)

Methods

begin_create_by_billing_account

Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

begin_create_by_billing_profile

Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

begin_create_by_customer

Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

begin_create_by_invoice_section

Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

begin_create_or_update_by_billing_account

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

begin_create_or_update_by_department

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

begin_create_or_update_by_enrollment_account

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

begin_resolve_by_billing_account

Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

begin_resolve_by_billing_profile

Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

begin_resolve_by_customer

Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

begin_resolve_by_invoice_section

Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

delete_by_billing_account

Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

delete_by_billing_profile

Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

delete_by_customer

Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

delete_by_department

Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

delete_by_enrollment_account

Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

delete_by_invoice_section

Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

get_by_billing_account

Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

get_by_billing_profile

Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

get_by_customer

Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

get_by_department

Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

get_by_enrollment_account

Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

get_by_invoice_section

Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

list_by_billing_account

Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

list_by_billing_profile

Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

list_by_customer

Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

list_by_department

Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.

list_by_enrollment_account

Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.

list_by_invoice_section

Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

begin_create_by_billing_account

Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

async begin_create_by_billing_account(billing_account_name: str, parameters: _models.BillingRoleAssignmentProperties, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignmentProperties type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_by_billing_profile

Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

async begin_create_by_billing_profile(billing_account_name: str, billing_profile_name: str, parameters: _models.BillingRoleAssignmentProperties, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

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.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignmentProperties type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_by_customer

Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

async begin_create_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, parameters: _models.BillingRoleAssignmentProperties, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

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.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignmentProperties type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_by_invoice_section

Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

async begin_create_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, parameters: _models.BillingRoleAssignmentProperties, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

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.

invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignmentProperties type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_or_update_by_billing_account

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async begin_create_or_update_by_billing_account(billing_account_name: str, billing_role_assignment_name: str, parameters: _models.BillingRoleAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_or_update_by_department

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async begin_create_or_update_by_department(billing_account_name: str, department_name: str, billing_role_assignment_name: str, parameters: _models.BillingRoleAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_create_or_update_by_enrollment_account

Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async begin_create_or_update_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, billing_role_assignment_name: str, parameters: _models.BillingRoleAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BillingRoleAssignment]

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

parameters
Required

The properties of the billing role assignment. Is either a BillingRoleAssignment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

begin_resolve_by_billing_account

Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

async begin_resolve_by_billing_account(billing_account_name: str, resolve_scope_display_names: bool = False, filter: str | None = None, **kwargs: Any) -> AsyncLROPoller[BillingRoleAssignmentListResult]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

resolve_scope_display_names
Required

Resolves the scope display name for each of the role assignments. Default value is False.

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.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignmentListResult or the result of cls(response)

Exceptions

Type Description
See also

begin_resolve_by_billing_profile

Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

async begin_resolve_by_billing_profile(billing_account_name: str, billing_profile_name: str, resolve_scope_display_names: bool = False, filter: str | None = None, **kwargs: Any) -> AsyncLROPoller[BillingRoleAssignmentListResult]

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.

resolve_scope_display_names
Required

Resolves the scope display name for each of the role assignments. Default value is False.

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.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignmentListResult or the result of cls(response)

Exceptions

Type Description
See also

begin_resolve_by_customer

Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

async begin_resolve_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, resolve_scope_display_names: bool = False, filter: str | None = None, **kwargs: Any) -> AsyncLROPoller[BillingRoleAssignmentListResult]

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.

resolve_scope_display_names
Required

Resolves the scope display name for each of the role assignments. Default value is False.

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.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignmentListResult or the result of cls(response)

Exceptions

Type Description
See also

begin_resolve_by_invoice_section

Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

async begin_resolve_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, resolve_scope_display_names: bool = False, filter: str | None = None, **kwargs: Any) -> AsyncLROPoller[BillingRoleAssignmentListResult]

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.

invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

resolve_scope_display_names
Required

Resolves the scope display name for each of the role assignments. Default value is False.

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.

Returns

Type Description

An instance of AsyncLROPoller that returns either BillingRoleAssignmentListResult or the result of cls(response)

Exceptions

Type Description
See also

delete_by_billing_account

Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

async delete_by_billing_account(billing_account_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_by_billing_profile

Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

async delete_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_by_customer

Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

async delete_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_by_department

Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async delete_by_department(billing_account_name: str, department_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_by_enrollment_account

Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async delete_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_by_invoice_section

Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

async delete_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_assignment_name: str, **kwargs: Any) -> None

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.

invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

get_by_billing_account

Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

async get_by_billing_account(billing_account_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

get_by_billing_profile

Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

async get_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

get_by_customer

Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

async get_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

get_by_department

Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async get_by_department(billing_account_name: str, department_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

get_by_enrollment_account

Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

async get_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

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.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

get_by_invoice_section

Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

async get_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_assignment_name: str, **kwargs: Any) -> BillingRoleAssignment

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.

invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. Required.

billing_role_assignment_name
Required
str

The ID that uniquely identifies a role assignment. Required.

Returns

Type Description

BillingRoleAssignment or the result of cls(response)

Exceptions

Type Description
See also

list_by_billing_account

Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

list_by_billing_account(billing_account_name: str, filter: str | None = None, top: int | None = None, skip: int | None = None, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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.

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.

Returns

Type Description

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

Exceptions

Type Description
See also

list_by_billing_profile

Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, filter: str | None = None, top: int | None = None, skip: int | None = None, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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.

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.

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.

Returns

Type Description

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

Exceptions

Type Description
See also

list_by_customer

Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.

list_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, filter: str | None = None, top: int | None = None, skip: int | None = None, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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.

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.

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.

Returns

Type Description

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

Exceptions

Type Description
See also

list_by_department

Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.

list_by_department(billing_account_name: str, department_name: str, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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.

Returns

Type Description

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

Exceptions

Type Description
See also

list_by_enrollment_account

Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.

list_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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

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

Exceptions

Type Description
See also

list_by_invoice_section

Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, filter: str | None = None, top: int | None = None, skip: int | None = None, **kwargs: Any) -> AsyncIterable[BillingRoleAssignment]

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.

invoice_section_name
Required
str

The ID that uniquely identifies an invoice section. 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.

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.

Returns

Type Description

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

Exceptions

Type Description
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'>