Get-AzRecoveryServicesBackupItem

Module:

Az.RecoveryServices Module

Gets the items from a container in Backup.

Get-AzRecoveryServicesBackupItem
 [-Container] <ContainerBase>
 [[-Name] <String>]
 [[-ProtectionStatus] <ItemProtectionStatus>]
 [[-ProtectionState] <ItemProtectionState>]
 [-WorkloadType] <WorkloadType>
 [[-DeleteState] <ItemDeleteState>]
 [-FriendlyName <String>]
 [-VaultId <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-UseSecondaryRegion]
 [<CommonParameters>]

Get-AzRecoveryServicesBackupItem
 [-BackupManagementType] <BackupManagementType>
 [[-Name] <String>]
 [[-ProtectionStatus] <ItemProtectionStatus>]
 [[-ProtectionState] <ItemProtectionState>]
 [-WorkloadType] <WorkloadType>
 [[-DeleteState] <ItemDeleteState>]
 [-FriendlyName <String>]
 [-VaultId <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-UseSecondaryRegion]
 [<CommonParameters>]

Get-AzRecoveryServicesBackupItem
 [-Policy] <PolicyBase>
 [[-Name] <String>]
 [[-ProtectionStatus] <ItemProtectionStatus>]
 [[-ProtectionState] <ItemProtectionState>]
 [[-DeleteState] <ItemDeleteState>]
 [-FriendlyName <String>]
 [-VaultId <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-UseSecondaryRegion]
 [<CommonParameters>]

The Get-AzRecoveryServicesBackupItem cmdlet gets the list of protected items in a container and the protection status of the items. A container that is registered to an Azure Recovery Services vault can have one or more items that can be protected. For Azure virtual machines, there can be only one backup item in the virtual machine container. Set the vault context by using the -VaultId parameter.

$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -FriendlyName "V2VM" -VaultId $vault.ID
$BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureVM -VaultId $vault.ID

The first command gets the container of type AzureVM, and then stores it in the $Container variable. The second command gets the Backup item named V2VM in $Container, and then stores it in the $BackupItem variable.

$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureStorage -FriendlyName "StorageAccount1" -VaultId $vault.ID
$BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureFiles -VaultId $vault.ID -FriendlyName "FileShareName"

The first command gets the container of type AzureStorage, and then stores it in the $Container variable. The second command gets the Backup item whose friendlyName matches the value passed in FriendlyName Parameter, and then stores it in the $BackupItem variable. Using FriendlyName parameter can result in returning more than one Azure File Share. In such cases, execute the cmdlet by passing value for -Name parameter as the Name property returned in the result set of $BackupItem.

$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureStorage -FriendlyName "StorageAccount1" -VaultId $vault.ID
$softDeletedItems = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureFiles -VaultId $vault.ID -DeleteState SoftDeleted

Lists Azure File Share backup items that have been disabled with Disable-AzRecoveryServicesBackupProtection -RemoveRecoveryPoints and are currently in the soft-deleted state. These items can be rehydrated with Undo-AzRecoveryServicesBackupItemDeletion while still within the soft-delete retention window.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.