Share via


Backups Under Backup Vault - Restore Files

Create a new Backup Restore Files request
Restore the specified files from the specified backup to the active filesystem

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles?api-version=2025-03-01

URI Parameters

Name In Required Type Description
accountName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$

The name of the NetApp account

backupName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$

The name of the backup

backupVaultName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$

The name of the Backup Vault

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

subscriptionId
path True

string (uuid)

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

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
destinationVolumeId True

string

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

fileList True

string[]

minLength: 1
maxLength: 1024

List of files to be restored

restoreFilePath

string

pattern: ^\/.*$

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

Responses

Name Type Description
202 Accepted

Accepted

Headers

Location: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Backups_SingleFileRestore

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1/restoreFiles?api-version=2025-03-01

{
  "fileList": [
    "/dir1/customer1.db",
    "/dir1/customer2.db"
  ],
  "destinationVolumeId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"
}

Sample response

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2025-03-01&operationResultResponseType=Location

Definitions

Name Description
backupRestoreFiles

Restore payload for Single File Backup Restore

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

backupRestoreFiles

Restore payload for Single File Backup Restore

Name Type Description
destinationVolumeId

string

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

fileList

string[]

minLength: 1
maxLength: 1024

List of files to be restored

restoreFilePath

string

pattern: ^\/.*$

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

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.