transfers

Creates, updates, deletes, gets or lists a transfers resource.

Overview

Name	transfers
Type	Resource
Id	azure.billing.transfers

Fields

The following fields are returned by SELECT queries:

get

Details of transfer.

Name	Datatype	Description
properties	object	Details of the transfer.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list

List of transfers initiated from this invoice section.

Name	Datatype	Description
properties	object	Details of the transfer.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billingAccountName, billingProfileName, invoiceSectionName, transferName		Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list	select	billingAccountName, billingProfileName, invoiceSectionName		Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
initiate	exec	billingAccountName, billingProfileName, invoiceSectionName, transferName		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.
cancel	exec	billingAccountName, billingProfileName, invoiceSectionName, transferName		Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.

SELECT examples

get

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

SELECT
properties,
tags
FROM azure.billing.transfers
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND transferName = '{{ transferName }}' -- required
;

list

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

SELECT
properties,
tags
FROM azure.billing.transfers
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
;

Lifecycle Methods

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.

EXEC azure.billing.transfers.initiate 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required, 
@transferName='{{ transferName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

cancel

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

EXEC azure.billing.transfers.cancel 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required, 
@transferName='{{ transferName }}' --required
;