Restore-AzNetAppFilesBackupFile

Reference

Module:: Az.NetAppFiles

Create a new Backup Restore Files request

Syntax

Restore-AzNetAppFilesBackupFile
       -ResourceGroupName <String>
       -AccountName <String>
       -Name <String>
       [-PoolName <String>]
       [-VolumeName <String>]
       -BackupVaultName <String>
       -FileList <String[]>
       [-RestoreFilePath <String>]
       -DestinationVolumeId <String>
       [-PassThru]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restore-AzNetAppFilesBackupFile
       -Name <String>
       -FileList <String[]>
       [-RestoreFilePath <String>]
       -DestinationVolumeId <String>
       [-VolumeObject <PSNetAppFilesVolume>]
       -BackupVaultObject <PSNetAppFilesBackupVault>
       [-PassThru]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restore-AzNetAppFilesBackupFile
       -FileList <String[]>
       [-RestoreFilePath <String>]
       -DestinationVolumeId <String>
       -ResourceId <String>
       [-PassThru]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restore-AzNetAppFilesBackupFile
       -FileList <String[]>
       [-RestoreFilePath <String>]
       -DestinationVolumeId <String>
       -InputObject <PSNetAppFilesBackup>
       [-PassThru]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Restore the specified files from the specified backup to the active filesystem

Examples

Example 1

$fileList = New-Object string[] 1
$fileList[0] = "/dir1/customer1.db"
Restore-AzNetAppFilesBackupFile -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -BackupName "MyBackup" -FileList $fileList -DestinationVolumeId "destinationVolumeResourceId"

This command Restores the file customer1.db from "MyBackup" to the specified destingation volume

Parameters

-AccountName

The name of the ANF account

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

-BackupVaultName

The name of the ANF BackupVault

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

-BackupVaultObject

The BackupVault object containing the backup to return

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DestinationVolumeId

Resource Id of the destination volume on which the files need to be restored

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

-FileList

List of files to be restored

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

-InputObject

The backup object to restore files from

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

-Name

The name of the ANF backup

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

-PassThru

Return whether the specified files where successfully restored

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

-PoolName

The name of the ANF pool

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

-ResourceGroupName

The resource group of the ANF account

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

-ResourceId

The resource id of the ANF Backup

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

-RestoreFilePath

Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default

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

-VolumeName

The name of the ANF volume

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

-VolumeObject

The volume object containing the backup to restore files from

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSNetAppFilesVolume

PSNetAppFilesBackupVault

PSNetAppFilesBackup

Outputs