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.

cancel(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, transfer_name: str, **kwargs: Any) -> TransferDetails

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.
transfer_name Required	str The ID that uniquely identifies a transfer request. Required.

Returns

Type	Description
TransferDetails	TransferDetails. The TransferDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

get(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, transfer_name: str, **kwargs: Any) -> TransferDetails

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.
transfer_name Required	str The ID that uniquely identifies a transfer request. Required.

Returns

Type	Description
TransferDetails	TransferDetails. The TransferDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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.

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.TransferDetails

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.
transfer_name Required	str The ID that uniquely identifies a transfer request. Required.
parameters Required	InitiateTransferRequest or <xref:JSON> or IO[bytes] Request parameters that are provided to the initiate transfer operation. Is one of the following types: InitiateTransferRequest, JSON, IO[bytes] Required.

Returns

Type	Description
TransferDetails	TransferDetails. The TransferDetails is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[TransferDetails]

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.

Returns

Type	Description
ItemPaged[TransferDetails]	An iterator like instance of TransferDetails

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?