TransfersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:transfers> attribute.
Constructor
TransfersOperations(*args, **kwargs)Methods
| cancel |
Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| get |
Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| initiate |
Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| list |
Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
cancel
Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
async cancel(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, transfer_name: str, **kwargs: Any) -> TransferDetailsParameters
| 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. |
|
transfer_name
Required
|
The ID that uniquely identifies a transfer request. Required. |
Returns
| Type | Description |
|---|---|
|
TransferDetails or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
async get(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, transfer_name: str, **kwargs: Any) -> TransferDetailsParameters
| 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. |
|
transfer_name
Required
|
The ID that uniquely identifies a transfer request. Required. |
Returns
| Type | Description |
|---|---|
|
TransferDetails or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
initiate
Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
async initiate(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, transfer_name: str, parameters: _models.InitiateTransferRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TransferDetailsParameters
| 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. |
|
transfer_name
Required
|
The ID that uniquely identifies a transfer request. Required. |
|
parameters
Required
|
Request parameters that are provided to the initiate transfer operation. Is either a InitiateTransferRequest type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
TransferDetails or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> AsyncIterable[TransferDetails]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 TransferDetails 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'>