deleted_vaults

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

Overview

Name	deleted_vaults
Type	Resource
Id	azure.recovery_services.deleted_vaults

Fields

The following fields are returned by SELECT queries:

get_operation_status

Name	Datatype	Description
id	string	It should match what is used to GET the operation result.
name	string	It must match the last segment of the "id" field, and will typically be a GUID / system generated value.
endTime	string (date-time)	End time of the operation.
error	object	Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.
startTime	string (date-time)	Start time of the operation.
status	string	The status of the operation. (InProgress/Success/Failed/Cancelled).

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.
purgeAt	string (date-time)	Time in UTC at which the DeletedVault will be purged.
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".
vaultDeletionTime	string (date-time)	Time in UTC at which the Vault was deleted.
vaultId	string	ARM Id of the Vault which was deleted.

list_by_subscription_id

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.
purgeAt	string (date-time)	Time in UTC at which the DeletedVault will be purged.
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".
vaultDeletionTime	string (date-time)	Time in UTC at which the Vault was deleted.
vaultId	string	ARM Id of the Vault which was deleted.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_operation_status	select	location, deleted_vault_name, operation_id, subscription_id		Get the operation status of a deleted vault.
get	select	location, deleted_vault_name, subscription_id		Get a specific deleted vault.
list_by_subscription_id	select	location, subscription_id		List deleted vaults in a subscription.
undelete	exec	location, deleted_vault_name, subscription_id, properties		Start undelete of a deleted vault.

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
deleted_vault_name	string	The name of the DeletedVault. Required.
location	string	The location name. Required.
operation_id	string	Required.
subscription_id	string

SELECT examples

get_operation_status

Get the operation status of a deleted vault.

SELECT
id,
name,
endTime,
error,
startTime,
status
FROM azure.recovery_services.deleted_vaults
WHERE location = '{{ location }}' -- required
AND deleted_vault_name = '{{ deleted_vault_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a specific deleted vault.

SELECT
id,
name,
purgeAt,
systemData,
type,
vaultDeletionTime,
vaultId
FROM azure.recovery_services.deleted_vaults
WHERE location = '{{ location }}' -- required
AND deleted_vault_name = '{{ deleted_vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_id

List deleted vaults in a subscription.

SELECT
id,
name,
purgeAt,
systemData,
type,
vaultDeletionTime,
vaultId
FROM azure.recovery_services.deleted_vaults
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

undelete

Start undelete of a deleted vault.

EXEC azure.recovery_services.deleted_vaults.undelete 
@location='{{ location }}' --required, 
@deleted_vault_name='{{ deleted_vault_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;