TransfersClient Interface

public interface TransfersClient

An instance of this class provides access to all the operations defined in TransfersClient.

Method Summary

Modifier and Type Method and Description
abstract TransferDetailsInner cancel(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName)

Cancels a transfer request.

abstract Response<TransferDetailsInner> cancelWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, Context context)

Cancels a transfer request.

abstract TransferDetailsInner get(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName)

Gets a transfer request by ID.

abstract Response<TransferDetailsInner> getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, Context context)

Gets a transfer request by ID.

abstract TransferDetailsInner initiate(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, InitiateTransferRequest parameters)

Sends a request to a user in another billing account to transfer billing ownership of their subscriptions.

abstract Response<TransferDetailsInner> initiateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, InitiateTransferRequest parameters, Context context)

Sends a request to a user in another billing account to transfer billing ownership of their subscriptions.

abstract PagedIterable<TransferDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName)

Lists the transfer requests for an invoice section.

abstract PagedIterable<TransferDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName, Context context)

Lists the transfer requests for an invoice section.

Method Details

cancel

public abstract TransferDetailsInner cancel(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.

Returns:

details of the transfer.

cancelWithResponse

public abstract Response<TransferDetailsInner> cancelWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.
context - The context to associate with this operation.

Returns:

details of the transfer along with Response<T>.

get

public abstract TransferDetailsInner get(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.

Returns:

a transfer request by ID.

getWithResponse

public abstract Response<TransferDetailsInner> getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.
context - The context to associate with this operation.

Returns:

a transfer request by ID along with Response<T>.

initiate

public abstract TransferDetailsInner initiate(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, InitiateTransferRequest parameters)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.
parameters - Request parameters that are provided to the initiate transfer operation.

Returns:

details of the transfer.

initiateWithResponse

public abstract Response<TransferDetailsInner> initiateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String transferName, InitiateTransferRequest parameters, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
transferName - The ID that uniquely identifies a transfer request.
parameters - Request parameters that are provided to the initiate transfer operation.
context - The context to associate with this operation.

Returns:

details of the transfer along with Response<T>.

list

public abstract PagedIterable<TransferDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName)

Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.

Returns:

the list of transfers initiated by caller as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<TransferDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName, Context context)

Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
invoiceSectionName - The ID that uniquely identifies an invoice section.
context - The context to associate with this operation.

Returns:

the list of transfers initiated by caller as paginated response with PagedIterable<T>.

Applies to