PartnerTransfersOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:partner_transfers> attribute.

Inheritance
builtins.object
PartnerTransfersOperations

Constructor

PartnerTransfersOperations(*args, **kwargs)

Methods

cancel

Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
get

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

Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list

Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

cancel

Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

cancel(billing_account_name: str, billing_profile_name: str, customer_name: str, transfer_name: str, **kwargs: Any) -> PartnerTransferDetails

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.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.
transfer_name
Required
str

The ID that uniquely identifies a transfer request. Required.

Returns

Type Description
PartnerTransferDetails

PartnerTransferDetails or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

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

get(billing_account_name: str, billing_profile_name: str, customer_name: str, transfer_name: str, **kwargs: Any) -> PartnerTransferDetails

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.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.
transfer_name
Required
str

The ID that uniquely identifies a transfer request. Required.

Returns

Type Description
PartnerTransferDetails

PartnerTransferDetails or the result of cls(response)

Exceptions

Type Description
HttpResponseError

initiate

Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

initiate(billing_account_name: str, billing_profile_name: str, customer_name: str, transfer_name: str, parameters: _models.PartnerInitiateTransferRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerTransferDetails

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.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.
transfer_name
Required
str

The ID that uniquely identifies a transfer request. Required.
parameters
Required
PartnerInitiateTransferRequest or IO[bytes]

Request parameters that are provided to the initiate transfer operation. Is either a PartnerInitiateTransferRequest type or a IO[bytes] type. Required.

Returns

Type Description
PartnerTransferDetails

PartnerTransferDetails or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

list(billing_account_name: str, billing_profile_name: str, customer_name: str, **kwargs: Any) -> Iterable[PartnerTransferDetails]

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.
customer_name
Required
str

The ID that uniquely identifies a customer. Required.

Returns

Type Description
ItemPaged[PartnerTransferDetails]

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

Exceptions

Type Description
HttpResponseError

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