partner_transfers

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

Overview

Name	partner_transfers
Type	Resource
Id	azure.billing.partner_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, customerName, transferName		Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list	select	billingAccountName, billingProfileName, customerName		Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
initiate	exec	billingAccountName, billingProfileName, customerName, transferName		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.
cancel	exec	billingAccountName, billingProfileName, customerName, transferName		Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner 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.
customerName	string	The ID that uniquely identifies a customer.
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 Partner Agreement.

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

list

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

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

Lifecycle Methods

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.

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

cancel

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

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