BillingRoleDefinitionOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:billing_role_definition> attribute.
Constructor
BillingRoleDefinitionOperations(*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, Microsoft Customer Agreement or Enterprise 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_customer |
Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement. |
| get_by_department |
Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| get_by_enrollment_account |
Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise 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, Microsoft Customer Agreement or Enterprise 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, Microsoft Customer Agreement or Enterprise Agreement. |
| list_by_customer |
Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement. |
| list_by_department |
List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| list_by_enrollment_account |
List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise 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, Microsoft Customer Agreement or Enterprise Agreement.
get_by_billing_account(billing_account_name: str, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
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, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
Returns
| Type | Description |
|---|---|
|
BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_by_customer
Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
get_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
|
customer_name
Required
|
The ID that uniquely identifies a customer. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
Returns
| Type | Description |
|---|---|
|
BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_by_department
Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get_by_department(billing_account_name: str, department_name: str, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
department_name
Required
|
The name of the department. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
Returns
| Type | Description |
|---|---|
|
BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_by_enrollment_account
Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
enrollment_account_name
Required
|
The name of the enrollment account. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
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, role_definition_name: str, **kwargs: Any) -> BillingRoleDefinitionParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
|
invoice_section_name
Required
|
The ID that uniquely identifies an invoice section. Required. |
|
role_definition_name
Required
|
The ID that uniquely identifies a role definition. Required. |
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, Microsoft Customer Agreement or Enterprise Agreement.
list_by_billing_account(billing_account_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
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, Microsoft Customer Agreement or Enterprise Agreement.
list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_customer
Lists the role definitions for a 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, **kwargs: Any) -> Iterable[BillingRoleDefinition]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
|
customer_name
Required
|
The ID that uniquely identifies a customer. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_department
List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_department(billing_account_name: str, department_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
department_name
Required
|
The name of the department. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either BillingRoleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_enrollment_account
List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, **kwargs: Any) -> Iterable[BillingRoleDefinition]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
enrollment_account_name
Required
|
The name of the enrollment account. Required. |
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
|
The ID that uniquely identifies a billing account. Required. |
|
billing_profile_name
Required
|
The ID that uniquely identifies a billing profile. Required. |
|
invoice_section_name
Required
|
The ID that uniquely identifies an invoice section. Required. |
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:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv80\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>