Transfers interface
Interface representing a Transfers.
Methods
| cancel(string, string, string, string, Transfers |
Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| get(string, string, string, string, Transfers |
Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| initiate(string, string, string, string, 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(string, string, string, Transfers |
Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
Method Details
cancel(string, string, string, string, TransfersCancelOptionalParams)
Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function cancel(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, transferName: string, options?: TransfersCancelOptionalParams): Promise<TransferDetails>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
- transferName
-
string
The ID that uniquely identifies a transfer request.
- options
- TransfersCancelOptionalParams
The options parameters.
Returns
Promise<TransferDetails>
get(string, string, string, string, TransfersGetOptionalParams)
Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, transferName: string, options?: TransfersGetOptionalParams): Promise<TransferDetails>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
- transferName
-
string
The ID that uniquely identifies a transfer request.
- options
- TransfersGetOptionalParams
The options parameters.
Returns
Promise<TransferDetails>
initiate(string, string, string, string, InitiateTransferRequest, TransfersInitiateOptionalParams)
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.
function initiate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, transferName: string, parameters: InitiateTransferRequest, options?: TransfersInitiateOptionalParams): Promise<TransferDetails>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
- transferName
-
string
The ID that uniquely identifies a transfer request.
- parameters
- InitiateTransferRequest
Request parameters that are provided to the initiate transfer operation.
- options
- TransfersInitiateOptionalParams
The options parameters.
Returns
Promise<TransferDetails>
list(string, string, string, TransfersListOptionalParams)
Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: TransfersListOptionalParams): PagedAsyncIterableIterator<TransferDetails, TransferDetails[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
- options
- TransfersListOptionalParams
The options parameters.