BillingRoleDefinitionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:billing_role_definitions> attribute.

Inheritance
builtins.object
BillingRoleDefinitionsOperations

Constructor

BillingRoleDefinitionsOperations(*args, **kwargs)

Methods

get_by_billing_account

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

get_by_billing_profile

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

get_by_invoice_section

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

list_by_billing_account

Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

list_by_billing_profile

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

list_by_invoice_section

Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

get_by_billing_account

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

get_by_billing_account(billing_account_name: str, billing_role_definition_name: str, **kwargs: Any) -> BillingRoleDefinition

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

billing_role_definition_name
Required
str

The ID that uniquely identifies a role definition. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

BillingRoleDefinition or the result of cls(response)

Exceptions

Type Description

get_by_billing_profile

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

get_by_billing_profile(billing_account_name: str, billing_profile_name: str, billing_role_definition_name: str, **kwargs: Any) -> BillingRoleDefinition

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_definition_name
Required
str

The ID that uniquely identifies a role definition. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

BillingRoleDefinition or the result of cls(response)

Exceptions

Type Description

get_by_invoice_section

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

get_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, billing_role_definition_name: str, **kwargs: Any) -> BillingRoleDefinition

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_definition_name
Required
str

The ID that uniquely identifies a role definition. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

BillingRoleDefinition or the result of cls(response)

Exceptions

Type Description

list_by_billing_account

Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

list_by_billing_account(billing_account_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

list_by_billing_profile

Lists the role definitions for 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, **kwargs: Any) -> Iterable[BillingRoleDefinition]

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.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

list_by_invoice_section

Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]

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.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

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