deleted_backup_instances

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

Overview

Name	deleted_backup_instances
Type	Resource
Id	azure.data_protection.deleted_backup_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	DeletedBackupInstanceResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

list

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	DeletedBackupInstanceResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, backupInstanceName		Gets a deleted backup instance with name in a backup vault
list	select	subscriptionId, resourceGroupName, vaultName		Gets deleted backup instances belonging to a backup vault
undelete	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName

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
backupInstanceName	string	The name of the deleted backup instance
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The name of the backup vault.

SELECT examples

get

Gets a deleted backup instance with name in a backup vault

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.deleted_backup_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND backupInstanceName = '{{ backupInstanceName }}' -- required
;

list

Gets deleted backup instances belonging to a backup vault

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.deleted_backup_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

Lifecycle Methods

undelete

OK

EXEC azure.data_protection.deleted_backup_instances.undelete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required
;