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
Details of the transfers with given Id.
| 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 of transfers received by caller.
| 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 | transferName | ||
list | select | |||
accept | exec | transferName | ||
validate | exec | transferName | ||
decline | exec | transferName |
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 |
|---|---|---|
transferName | string | The ID that uniquely identifies a transfer request. |
SELECT examples
- get
- list
Details of the transfers with given Id.
SELECT
properties,
tags
FROM azure.billing.recipient_transfers
WHERE transferName = '{{ transferName }}' -- required
;
List of transfers received by caller.
SELECT
properties,
tags
FROM azure.billing.recipient_transfers
;
Lifecycle Methods
- accept
- validate
- decline
Details of the accepted transfer.
EXEC azure.billing.recipient_transfers.accept
@transferName='{{ transferName }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;
Results of the transfer validation.
EXEC azure.billing.recipient_transfers.validate
@transferName='{{ transferName }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;
Details of the declined transfer.
EXEC azure.billing.recipient_transfers.decline
@transferName='{{ transferName }}' --required
;