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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
canceledBy	string	The email ID of the user who canceled the transfer request.
detailedTransferStatus	array	Detailed transfer status.
expirationTime	string (date-time)	The time at which the transfer request expires.
initiatorEmailId	string	The email ID of the user who sent the transfer request.
recipientEmailId	string	The email ID of the user to whom the transfer request was sent.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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 < > % & \ ? /.
transferStatus	string	Overall transfer status. Known values are: "Expired", "Pending", "InProgress", "Completed", "CompletedWithErrors", "Failed", "Canceled", and "Declined". (Expired, Pending, InProgress, Completed, CompletedWithErrors, Failed, Canceled, Declined)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
canceledBy	string	The email ID of the user who canceled the transfer request.
detailedTransferStatus	array	Detailed transfer status.
expirationTime	string (date-time)	The time at which the transfer request expires.
initiatorEmailId	string	The email ID of the user who sent the transfer request.
recipientEmailId	string	The email ID of the user to whom the transfer request was sent.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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 < > % & \ ? /.
transferStatus	string	Overall transfer status. Known values are: "Expired", "Pending", "InProgress", "Completed", "CompletedWithErrors", "Failed", "Canceled", and "Declined". (Expired, Pending, InProgress, Completed, CompletedWithErrors, Failed, Canceled, Declined)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account_name, billing_profile_name, invoice_section_name, transfer_name		Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list	select	billing_account_name, billing_profile_name, invoice_section_name		Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
initiate	exec	billing_account_name, billing_profile_name, invoice_section_name, transfer_name		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	billing_account_name, billing_profile_name, invoice_section_name, transfer_name		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
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.
invoice_section_name	string	The ID that uniquely identifies an invoice section. Required.
transfer_name	string	The ID that uniquely identifies a transfer request. Required.

SELECT examples

get

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

SELECT
id,
name,
canceledBy,
detailedTransferStatus,
expirationTime,
initiatorEmailId,
recipientEmailId,
systemData,
tags,
transferStatus,
type
FROM azure.billing.transfers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
AND transfer_name = '{{ transfer_name }}' -- 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
id,
name,
canceledBy,
detailedTransferStatus,
expirationTime,
initiatorEmailId,
recipientEmailId,
systemData,
tags,
transferStatus,
type
FROM azure.billing.transfers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- 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 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_profile_name='{{ billing_profile_name }}' --required, 
@invoice_section_name='{{ invoice_section_name }}' --required, 
@transfer_name='{{ transfer_name }}' --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 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_profile_name='{{ billing_profile_name }}' --required, 
@invoice_section_name='{{ invoice_section_name }}' --required, 
@transfer_name='{{ transfer_name }}' --required
;