Get-AzDataProtectionSoftDeletedBackupInstance

Reference

Module:: Az.DataProtection

Gets a deleted backup instance with name in a backup vault

Syntax

Get-AzDataProtectionSoftDeletedBackupInstance
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -VaultName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzDataProtectionSoftDeletedBackupInstance
   -BackupInstanceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -VaultName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzDataProtectionSoftDeletedBackupInstance
   -InputObject <IDataProtectionIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a deleted backup instance with name in a backup vault

Examples

Example 1: Get soft deleted backup instances for a backup vault

Get-AzDataProtectionSoftDeletedBackupInstance -ResourceGroupName $resourceGroupName -SubscriptionId $subscriptionId -VaultName $vaultName

Name
----
alrpstestvm-datadisk-000-xxxxxxxx-xxxx-alrpstestvm-datadisk-000-xxxx-xxxx-xxxxxxxx-066c-xxxx-91fc-xxxxxxxxxxxx

This cmdlet is used to fetch the list of backup instances which are in soft deleted state for the backup vault.

Parameters

-BackupInstanceName

The name of the deleted backup instance

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IDataProtectionIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

The name of the backup vault.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDataProtectionIdentity

Outputs

IDeletedBackupInstanceResource

Share via