AssociatedTenantsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:associated_tenants> attribute.
Constructor
AssociatedTenantsOperations(*args, **kwargs)Methods
| begin_create_or_update |
Create or update an associated tenant for the billing account. |
| begin_delete |
Deletes an associated tenant for a billing account. |
| get |
Gets an associated tenant by ID. |
| list_by_billing_account |
Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses. |
begin_create_or_update
Create or update an associated tenant for the billing account.
begin_create_or_update(billing_account_name: str, associated_tenant_name: str, parameters: _models.AssociatedTenant, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AssociatedTenant]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
associated_tenant_name
Required
|
The ID that uniquely identifies a tenant. Required. |
|
parameters
Required
|
An associated tenant. Is either a AssociatedTenant type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either AssociatedTenant or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes an associated tenant for a billing account.
begin_delete(billing_account_name: str, associated_tenant_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
associated_tenant_name
Required
|
The ID that uniquely identifies a tenant. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets an associated tenant by ID.
get(billing_account_name: str, associated_tenant_name: str, **kwargs: Any) -> AssociatedTenantParameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
associated_tenant_name
Required
|
The ID that uniquely identifies a tenant. Required. |
Returns
| Type | Description |
|---|---|
|
AssociatedTenant or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_billing_account
Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
list_by_billing_account(billing_account_name: str, include_revoked: bool = False, 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[AssociatedTenant]Parameters
| Name | Description |
|---|---|
|
billing_account_name
Required
|
The ID that uniquely identifies a billing account. Required. |
|
include_revoked
|
Can be used to get revoked associated tenants. Default value is False. Default value: False
|
|
filter
|
The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None. Default value: None
|
|
order_by
|
The orderby query option allows clients to request resources in a particular order. Default value is None. Default value: None
|
|
top
|
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. Default value: None
|
|
skip
|
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. Default value: None
|
|
count
|
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. Default value: None
|
|
search
|
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. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AssociatedTenant 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'>