PartnerTransfers interface

Interface representing a PartnerTransfers.

Methods

cancel(string, string, string, string, PartnerTransfersCancelOptionalParams)

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

get(string, string, string, string, PartnerTransfersGetOptionalParams)

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

initiate(string, string, string, string, PartnerInitiateTransferRequest, PartnerTransfersInitiateOptionalParams)

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(string, string, string, PartnerTransfersListOptionalParams)

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

Method Details

cancel(string, string, string, string, PartnerTransfersCancelOptionalParams)

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

function cancel(billingAccountName: string, billingProfileName: string, customerName: string, transferName: string, options?: PartnerTransfersCancelOptionalParams): Promise<PartnerTransferDetails>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

customerName

string

The ID that uniquely identifies a customer.

transferName

string

The ID that uniquely identifies a transfer request.

options
PartnerTransfersCancelOptionalParams

The options parameters.

Returns

get(string, string, string, string, PartnerTransfersGetOptionalParams)

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

function get(billingAccountName: string, billingProfileName: string, customerName: string, transferName: string, options?: PartnerTransfersGetOptionalParams): Promise<PartnerTransferDetails>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

customerName

string

The ID that uniquely identifies a customer.

transferName

string

The ID that uniquely identifies a transfer request.

options
PartnerTransfersGetOptionalParams

The options parameters.

Returns

initiate(string, string, string, string, PartnerInitiateTransferRequest, PartnerTransfersInitiateOptionalParams)

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.

function initiate(billingAccountName: string, billingProfileName: string, customerName: string, transferName: string, parameters: PartnerInitiateTransferRequest, options?: PartnerTransfersInitiateOptionalParams): Promise<PartnerTransferDetails>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

customerName

string

The ID that uniquely identifies a customer.

transferName

string

The ID that uniquely identifies a transfer request.

parameters
PartnerInitiateTransferRequest

Request parameters that are provided to the initiate transfer operation.

options
PartnerTransfersInitiateOptionalParams

The options parameters.

Returns

list(string, string, string, PartnerTransfersListOptionalParams)

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

function list(billingAccountName: string, billingProfileName: string, customerName: string, options?: PartnerTransfersListOptionalParams): PagedAsyncIterableIterator<PartnerTransferDetails, PartnerTransferDetails[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

customerName

string

The ID that uniquely identifies a customer.

options
PartnerTransfersListOptionalParams

The options parameters.

Returns