recipient_transfers

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

Overview

Name	`recipient_transfers`
Type	Resource
Id	`azure.billing.recipient_transfers`

Fields

The following fields are returned by SELECT queries:

get
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.
`allowedProductType`	`array`	Type of subscriptions that can be transferred.
`canceledBy`	`string`	The email ID of the user who canceled the transfer request.
`customerTenantId`	`string`	The customer tenant id.
`detailedTransferStatus`	`array`	Detailed transfer status.
`expirationTime`	`string (date-time)`	The time at which the transfer request expires.
`initiatorCustomerType`	`string`	The type of customer who sent the transfer request. Known values are: "Partner" and "EA". (Partner, EA)
`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.
`resellerId`	`string`	Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.
`resellerName`	`string`	Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.
`supportedAccounts`	`array`	List of supported account types.
`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".

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.
`allowedProductType`	`array`	Type of subscriptions that can be transferred.
`canceledBy`	`string`	The email ID of the user who canceled the transfer request.
`customerTenantId`	`string`	The customer tenant id.
`detailedTransferStatus`	`array`	Detailed transfer status.
`expirationTime`	`string (date-time)`	The time at which the transfer request expires.
`initiatorCustomerType`	`string`	The type of customer who sent the transfer request. Known values are: "Partner" and "EA". (Partner, EA)
`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.
`resellerId`	`string`	Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.
`resellerName`	`string`	Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.
`supportedAccounts`	`array`	List of supported account types.
`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	Description
`get`	`select`	`transfer_name`	Gets a transfer request by ID. The caller must be the recipient of the transfer request. Gets a transfer request by ID. The caller must be the recipient of the transfer request.
`list`	`select`		Lists the transfer requests received by the caller. Lists the transfer requests received by the caller.
`accept`	`exec`	`transfer_name`	Accepts a transfer request. Accepts a transfer request.
`validate`	`exec`	`transfer_name`	Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation. Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
`decline`	`exec`	`transfer_name`	Declines a transfer request. Declines a transfer request.

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
`transfer_name`	`string`	The ID that uniquely identifies a transfer request. Required.

`SELECT` examples

get
list

Gets a transfer request by ID. The caller must be the recipient of the transfer request. Gets a transfer request by ID. The caller must be the recipient of the transfer request.

SELECT
id,
name,
allowedProductType,
canceledBy,
customerTenantId,
detailedTransferStatus,
expirationTime,
initiatorCustomerType,
initiatorEmailId,
recipientEmailId,
resellerId,
resellerName,
supportedAccounts,
systemData,
tags,
transferStatus,
type
FROM azure.billing.recipient_transfers
WHERE transfer_name = '{{ transfer_name }}' -- required
;

Lists the transfer requests received by the caller. Lists the transfer requests received by the caller.

SELECT
id,
name,
allowedProductType,
canceledBy,
customerTenantId,
detailedTransferStatus,
expirationTime,
initiatorCustomerType,
initiatorEmailId,
recipientEmailId,
resellerId,
resellerName,
supportedAccounts,
systemData,
tags,
transferStatus,
type
FROM azure.billing.recipient_transfers
;

Lifecycle Methods

accept
validate
decline

Accepts a transfer request. Accepts a transfer request.

EXEC azure.billing.recipient_transfers.accept 
@transfer_name='{{ transfer_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation. Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.

EXEC azure.billing.recipient_transfers.validate 
@transfer_name='{{ transfer_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

Declines a transfer request. Declines a transfer request.

EXEC azure.billing.recipient_transfers.decline 
@transfer_name='{{ transfer_name }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Lifecycle Methods​