subscriptions

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

Overview

Name	subscriptions
Type	Resource
Id	azure.subscription.subscriptions

Fields

The following fields are returned by SELECT queries:

list_target_directory

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.
acceptedDate	string (date-time)	The UTC date and time when the transfer request was accepted.
createdDate	string (date-time)	The UTC date and time when the transfer request was created.
destinationOwnerId	string	Destination Owner Id where Subscription will be accepted.
destinationTenantId	string	Destination Tenant Id where Subscription will be accepted.
expiresOn	string (date-time)	Subscription Initiate Request Expiry time.
sourceOwnerEmail	string	The email address of the user who initiated the transfer request. If the request was generated by a Service Principal, this field may be null.
sourceOwnerId	string	The object id of the user who initiated the transfer request.
sourceTenantId	string	The id of the tenant where the subscription originally resided.
status	string	Status of the subscription transfer operation. Known values are: "Initialized", "InProgress", and "Completed". (Initialized, InProgress, Completed)
subscriptionId	string	The id of the subscription being transferred.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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
list_target_directory	select	subscription_id		The operation to list Initiator Subscription Changed Request.
get_target_directory	exec	subscription_id		The operation to view Initiator Subscription Changed Request.
put_target_directory	exec	subscription_id		The operation to initiate Subscription Changed Request.
delete_target_directory	exec	subscription_id		The operation to delete Initiator Subscription Changed Request.
accept_target_directory	exec	subscription_id		The operation to accept Subscription Changed Request.
target_directory_status	exec	subscription_id		The operation for Acceptor to view the accepted 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
subscription_id	string	Subscription Id. Required.

SELECT examples

list_target_directory

The operation to list Initiator Subscription Changed Request.

SELECT
id,
name,
acceptedDate,
createdDate,
destinationOwnerId,
destinationTenantId,
expiresOn,
sourceOwnerEmail,
sourceOwnerId,
sourceTenantId,
status,
subscriptionId,
systemData,
type
FROM azure.subscription.subscriptions
WHERE subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

get_target_directory

The operation to view Initiator Subscription Changed Request.

EXEC azure.subscription.subscriptions.get_target_directory 
@subscription_id='{{ subscription_id }}' --required
;

put_target_directory

The operation to initiate Subscription Changed Request.

EXEC azure.subscription.subscriptions.put_target_directory 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_target_directory

The operation to delete Initiator Subscription Changed Request.

EXEC azure.subscription.subscriptions.delete_target_directory 
@subscription_id='{{ subscription_id }}' --required
;

accept_target_directory

The operation to accept Subscription Changed Request.

EXEC azure.subscription.subscriptions.accept_target_directory 
@subscription_id='{{ subscription_id }}' --required
;

target_directory_status

The operation for Acceptor to view the accepted request.

EXEC azure.subscription.subscriptions.target_directory_status 
@subscription_id='{{ subscription_id }}' --required
;