Restaurer des partages de fichiers Azure à l’aide de l’API REST

Article
06/01/2023

Cet article explique comment restaurer l’intégralité d’un partage de fichiers ou des fichiers spécifiques à partir d’un point de restauration créé par Sauvegarde Azure à l’aide de l’API REST.

À la fin de ce tutoriel, vous aurez appris à effectuer les opérations ci-dessous à l’aide de l’API REST :

Afficher les points de restauration d’un partage de fichiers Azure sauvegardé
Restaurer un partage de fichiers Azure complet
restaurer des fichiers ou dossiers individuels ;

Prérequis

Nous supposons que vous disposez déjà d’un partage de fichiers sauvegardé que vous souhaitez restaurer. Si ce n’est pas le cas, consultez Sauvegarder un partage de fichiers Azure à l’aide de l’API REST pour apprendre à en créer un.

Pour cet article, nous allons utiliser les ressources suivantes :

RecoveryServicesVault : azurefilesvault
Groupe de ressources : azurefiles
Compte de stockage : afsaccount
Partage de fichiers : azurefiles

Extraire ContainerName et ProtectedItemName

Pour la plupart des appels d’API liés à la restauration, vous devez passer des valeurs pour les paramètres d’URI {containerName} et {protectedItemName}. Utilisez l’attribut ID dans le corps de la réponse de l’opération GET backupprotectableitems pour récupérer les valeurs de ces paramètres. Dans notre exemple, l’ID du partage de fichiers que vous souhaitez protéger est le suivant :

"/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/storagecontainer;storage;azurefiles;afsaccount/protectableItems/azurefileshare;azurefiles

Ainsi, les valeurs se traduisent comme suit :

{containername} : storagecontainer;storage;azurefiles;afsaccount
{protectedItemName} : azurefileshare;azurefiles

Pour restaurer un partage de fichiers ou des fichiers sauvegardés, commencez par sélectionner un point de récupération afin d’effectuer l’opération de restauration. L’API REST Recovery Point-List permet de lister les points de récupération disponibles d’un élément sauvegardé. Il s’agit d’une opération GET comportant toutes les valeurs nécessaires.

GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints?api-version=2019-05-13&$filter={$filter}

Définissez les valeurs d’URI comme suit :

{fabricName} : Microsoft Azure
{vaultName} : azurefilesvault
{containername} : storagecontainer;storage;azurefiles;afsaccount
{protectedItemName} : azurefileshare;azurefiles
{ResourceGroupName} : azurefiles

L’URI GET contient tous les paramètres obligatoires. Il n’est pas nécessaire d’ajouter un corps de demande.

GET https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/recoveryPoints?api-version=2019-05-13

Exemple de réponse pour récupérer des points de récupération

Une fois l’URI GET envoyé, une réponse 200 est retournée :

HTTP/1.1" 200 None
'Cache-Control': 'no-cache'
'Pragma': 'no-cache'
'Transfer-Encoding': 'chunked'
'Content-Type': 'application/json'
'Content-Encoding': 'gzip'
'Expires': '-1'
'Vary': 'Accept-Encoding'
'X-Content-Type-Options': 'nosniff'
'x-ms-request-id': 'd68d7951-7d97-4c49-9a2d-7fbaab55233a'
'x-ms-client-request-id': '4edb5a58-47ea-11ea-a27a-0a580af41908, 4edb5a58-47ea-11ea-a27a-0a580af41908'
'Strict-Transport-Security': 'max-age=31536000; includeSubDomains'
'Server': 'Microsoft-IIS/10.0'
'X-Powered-By': 'ASP.NET'
'x-ms-ratelimit-remaining-subscription-reads': '11998'
'x-ms-correlation-request-id': 'd68d7951-7d97-4c49-9a2d-7fbaab55233a'
'x-ms-routing-request-id': 'WESTEUROPE:20200205T073708Z:d68d7951-7d97-4c49-9a2d-7fbaab55233a'
'Date': 'Wed, 05 Feb 2020 07:37:08 GMT'
{
“value”:[
  {
    "eTag": null,
    "id": "/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/recoveryPoints/932881138555802864",
    "location": null,
    "name": "932881138555802864",
    "properties": {
      "fileShareSnapshotUri": "https://afsaccount.file.core.windows.net/azurefiles?sharesnapshot=2020-02-04T08:01:35.0000000Z",
      "objectType": "AzureFileShareRecoveryPoint",
      "recoveryPointSizeInGb": 1,
      "recoveryPointTime": "2020-02-04T08:01:35+00:00",
      "recoveryPointType": "FileSystemConsistent"
    },
    "resourceGroup": "azurefiles",
    "tags": null,
    "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints"
  },
  {
    "eTag": null,
    "id": "/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/recoveryPoints/932878582606969225",
    "location": null,
    "name": "932878582606969225",
    "properties": {
      "fileShareSnapshotUri": "https://afsaccount.file.core.windows.net/azurefiles?sharesnapshot=2020-02-03T08:05:30.0000000Z",
      "objectType": "AzureFileShareRecoveryPoint",
      "recoveryPointSizeInGb": 1,
      "recoveryPointTime": "2020-02-03T08:05:30+00:00",
      "recoveryPointType": "FileSystemConsistent"
    },
    "resourceGroup": "azurefiles",
    "tags": null,
    "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints"
  },
  {
    "eTag": null,
    "id": "/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/recoveryPoints/932890167574511261",
    "location": null,
    "name": "932890167574511261",
    "properties": {
      "fileShareSnapshotUri": "https://afsaccount.file.core.windows.net/azurefiles?sharesnapshot=2020-02-02T08:03:50.0000000Z",
      "objectType": "AzureFileShareRecoveryPoint",
      "recoveryPointSizeInGb": 1,
      "recoveryPointTime": "2020-02-02T08:03:50+00:00",
      "recoveryPointType": "FileSystemConsistent"
    },
    "resourceGroup": "azurefiles",
    "tags": null,
    "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints"
  },

Le point de récupération est identifié par le champ {name} dans la réponse ci-dessus.

Utilisez cette option de restauration pour restaurer l’intégralité du partage de fichiers dans l’emplacement d’origine ou dans un autre emplacement. Le déclenchement de la restauration étant une demande POST, vous pouvez effectuer cette opération à l’aide de l’API REST Déclencher la restauration.

POST https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore?api-version=2019-05-13

Les valeurs {containerName} et {protectedItemName} sont définies ici et recoveryPointID est le champ {name} du point de récupération mentionné ci-dessus.

POST https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare%3Bazurefiles/recoveryPoints/932886657837421071/restore?api-version=2019-05-13'

Créer un corps de demande

Pour déclencher une restauration d’un partage de fichiers Azure, voici les composants du corps de la demande :

Nom	Type	Description
Propriétés	AzureFileShareRestoreRequest	Propriétés RestoreRequestResource

Pour obtenir la liste complète des définitions du corps de la demande et d’autres détails, consultez le document API REST Déclencher la restauration.

Restaurer dans l’emplacement d’origine

Exemple de corps de demande pour restaurer à l'emplacement d'origine

Le corps de demande suivant définit les propriétés requises pour déclencher une restauration d’un partage de fichiers Azure :

{
   "properties":{
      "objectType":"AzureFileShareRestoreRequest",
      "recoveryType":"OriginalLocation",
      "sourceResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/AzureFiles/providers/Microsoft.Storage/storageAccounts/afsaccount",
      "copyOptions":"Overwrite",
      "restoreRequestType":"FullShareRestore"
}
}

Restaurer à un autre emplacement

Spécifiez les paramètres suivants pour la récupération dans un autre emplacement :

targetResourceId : Compte de stockage sur lequel le contenu sauvegardé est restauré. Le compte de stockage cible doit se trouver au même emplacement que le coffre.
nom : Partage de fichiers du compte de stockage cible sur lequel le contenu sauvegardé est restauré.
targetFolderPath : Dossier situé sous le partage de fichiers sur lequel les données sont restaurées.

Exemple de corps de demande pour restaurer à un autre emplacement

Le corps de demande suivant restaure le partage de fichiers azurefiles dans le compte de stockageafsaccount sur le partage de fichiers azurefiles1 dans le compte de stockage afaccount1.

{
   "properties":{
      "objectType":"AzureFileShareRestoreRequest",
      "recoveryType":"AlternateLocation",
      "sourceResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/AzureFiles/providers/Microsoft.Storage/storageAccounts/afsaccount",
      "copyOptions":"Overwrite",
      "restoreRequestType":"FullShareRestore",
      "restoreFileSpecs":[
         {
            "targetFolderPath":"restoredata"
}
],
      "targetDetails":{
         "name":"azurefiles1",
         "targetResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/AzureFiles/providers/Microsoft.Storage/storageAccounts/afaccount1"
}
}
}

response

Le déclenchement d’une opération de restauration est une opération asynchrone. Cette opération crée une autre opération qui doit faire l’objet d’un suivi distinct. Elle retourne deux réponses : 202 (Accepté) lors de la création d’une autre opération, et 200 (OK) quand cette opération est terminée.

Exemple de réponse

Une fois l’URI POST envoyé pour déclencher une restauration, la réponse initiale est 202 (Accepté) avec un en-tête d’emplacement ou Azure-async-header.

HTTP/1.1" 202
'Cache-Control': 'no-cache'
'Pragma': 'no-cache'
'Expires': '-1'
'Location': 'https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/operationResults/68ccfbc1-a64f-4b29-b955-314b5790cfa9?api-version=2019-05-13'
'Retry-After': '60'
'Azure-AsyncOperation': 'https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare;azurefiles/operationsStatus/68ccfbc1-a64f-4b29-b955-314b5790cfa9?api-version=2019-05-13'
'X-Content-Type-Options': 'nosniff'
'x-ms-request-id': '2426777d-c5ec-44b6-a324-384f8947460c'
'x-ms-client-request-id': '3c743096-47eb-11ea-ae90-0a580af41908, 3c743096-47eb-11ea-ae90-0a580af41908'
'Strict-Transport-Security': 'max-age=31536000; includeSubDomains'
'X-Powered-By': 'ASP.NET'
'x-ms-ratelimit-remaining-subscription-writes': '1198'
'x-ms-correlation-request-id': '2426777d-c5ec-44b6-a324-384f8947460c'
'x-ms-routing-request-id': 'WESTEUROPE:20200205T074347Z:2426777d-c5ec-44b6-a324-384f8947460c'
'Date': 'Wed, 05 Feb 2020 07:43:47 GMT'

Effectuez ensuite le suivi de l’opération qui en résulte en utilisant l’en-tête d’emplacement ou l’en-tête Azure-AsyncOperation avec une commande GET.

GET https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupOperations/68ccfbc1-a64f-4b29-b955-314b5790cfa9?api-version=2016-12-01

Une fois terminée, l’opération retourne 200 (OK) avec l’ID de la tâche de restauration obtenue dans le corps de la réponse.

HTTP/1.1" 200
'Cache-Control': 'no-cache'
'Pragma': 'no-cache'
'Transfer-Encoding': 'chunked'
'Content-Type': 'application/json'
'Content-Encoding': 'gzip'
'Expires': '-1'
'Vary': 'Accept-Encoding'
'X-Content-Type-Options': 'nosniff'
'x-ms-request-id': '41ee89b2-3be4-40d8-8ff6-f5592c2571e3'
'x-ms-client-request-id': '3c743096-47eb-11ea-ae90-0a580af41908, 3c743096-47eb-11ea-ae90-0a580af41908'
'Strict-Transport-Security': 'max-age=31536000; includeSubDomains'
'Server': 'Microsoft-IIS/10.0'
'X-Powered-By': 'ASP.NET'
'x-ms-ratelimit-remaining-subscription-reads': '11998'
'x-ms-correlation-request-id': '41ee89b2-3be4-40d8-8ff6-f5592c2571e3'
'x-ms-routing-request-id': 'WESTEUROPE:20200205T074348Z:41ee89b2-3be4-40d8-8ff6-f5592c2571e3'
'Date': 'Wed, 05 Feb 2020 07:43:47 GMT'
{
  "id": "/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupJobs/a7e97e42-4e54-4d4b-b449-26fcf946f42c",
  "location": null,
  "name": "a7e97e42-4e54-4d4b-b449-26fcf946f42c",
  "properties": {
    "actionsInfo": [
      "Cancellable"
    ],
    "activityId": "3c743096-47eb-11ea-ae90-0a580af41908",
    "backupManagementType": "AzureStorage",
    "duration": "0:00:01.863098",
    "endTime": null,
    "entityFriendlyName": "azurefiles",
    "errorDetails": null,
    "extendedInfo": {
      "dynamicErrorMessage": null,
      "propertyBag": {},
      "tasksList": []
    },
    "jobType": "AzureStorageJob",
    "operation": "Restore",
    "startTime": "2020-02-05T07:43:47.144961+00:00",
    "status": "InProgress",
    "storageAccountName": "afsaccount",
    "storageAccountVersion": "Storage"
  },
  "resourceGroup": "azurefiles",
  "tags": null,
  "type": "Microsoft.RecoveryServices/vaults/backupJobs"
}

Pour une récupération à un autre emplacement, le corps de la réponse se présente comme suit :

{
  "id": "/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupJobs/7e0ee41e-6e31-4728-a25c-98ff6b777641",
  "location": null,
  "name": "7e0ee41e-6e31-4728-a25c-98ff6b777641",
  "properties": {
    "actionsInfo": [
      "Cancellable"
    ],
    "activityId": "6077be6e-483a-11ea-a915-0a580af4ad72",
    "backupManagementType": "AzureStorage",
    "duration": "0:00:02.171965",
    "endTime": null,
    "entityFriendlyName": "azurefiles",
    "errorDetails": null,
    "extendedInfo": {
      "dynamicErrorMessage": null,
      "propertyBag": {
        "Data Transferred (in MB)": "0",
        "Job Type": "Recover to an alternate file share",
        "Number Of Failed Files": "0",
        "Number Of Restored Files": "0",
        "Number Of Skipped Files": "0",
        "RestoreDestination": "afaccount1/azurefiles1/restoredata",
        "Source File Share Name": "azurefiles",
        "Source Storage Account Name": "afsaccount",
        "Target File Share Name": "azurefiles1",
        "Target Storage Account Name": "afaccount1"
      },
      "tasksList": []
    },
    "jobType": "AzureStorageJob",
    "operation": "Restore",
    "startTime": "2020-02-05T17:10:18.106532+00:00",
    "status": "InProgress",
    "storageAccountName": "afsaccount",
    "storageAccountVersion": "ClassicCompute"
  },
  "resourceGroup": "azurefiles",
  "tags": null,
  "type": "Microsoft.RecoveryServices/vaults/backupJobs"
}

Comme la tâche de sauvegarde est une opération longue, elle doit faire l’objet d’un suivi, qui est détaillé dans le document Surveiller les tâches avec l’API REST.

Récupération au niveau d’un élément avec l’API REST

Vous pouvez utiliser cette option de restauration pour restaurer des fichiers ou dossiers individuels à l’emplacement d’origine ou dans un autre emplacement.

POST https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore?api-version=2019-05-13

Les valeurs {containerName} et {protectedItemName} sont définies ici et recoveryPointID est le champ {name} du point de récupération mentionné ci-dessus.

POST https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;azurefiles;afsaccount/protectedItems/AzureFileShare%3Bazurefiles/recoveryPoints/932886657837421071/restore?api-version=2019-05-13'

Créer un corps de demande pour la récupération au niveau de l'élément à l'aide de l'API REST

Pour déclencher une restauration d’un partage de fichiers Azure, voici les composants du corps de la demande :

Nom	Type	Description
Propriétés	AzureFileShareRestoreRequest	Propriétés RestoreRequestResource

Pour obtenir la liste complète des définitions du corps de la demande et d’autres détails, consultez le document API REST Déclencher la restauration.

Restaurer à l'emplacement d'origine pour la récupération au niveau de l'élément à l'aide de l'API REST

Le corps de demande suivant consiste à restaurer le fichier Restoretest.txt qui se trouve dans le partage de fichiers azurefiles associé au compte de stockage afsaccount.

Créer un corps de demande

{
   "properties":{
      "objectType":"AzureFileShareRestoreRequest",
      "copyOptions":"Overwrite",
      "recoveryType":"OriginalLocation",
      "restoreFileSpecs":[
         {
            "fileSpecType":"File",
            "path":"RestoreTest.txt",
            "targetFolderPath":null
}
],
      "restoreRequestType":"ItemLevelRestore",
      "sourceResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.storage/storageAccounts/afsaccount",
      "targetDetails":null
}
}

Restaurer à un autre emplacement pour la récupération au niveau de l'élément à l'aide de l'API REST

Le corps de demande suivant consiste à restaurer le fichier Restoretest.txt, qui se trouve dans le partage de fichiers azurefiles associé au compte de stockage afsaccount, sur le dossier restoredata du partage de fichiers azurefiles1 associé au compte de stockage afaccount1.

Créer un corps de demande

{
   "properties":{
      "objectType":"AzureFileShareRestoreRequest",
      "recoveryType":"AlternateLocation",
      "sourceResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/AzureFiles/providers/Microsoft.Storage/storageAccounts/afsaccount",
      "copyOptions":"Overwrite",
      "restoreRequestType":"ItemLevelRestore",
      "restoreFileSpecs":[
         {
            "path":"Restore/RestoreTest.txt",
            "fileSpecType":"File",
            "targetFolderPath":"restoredata"
}
],
      "targetDetails":{
         "name":"azurefiles1",
         "targetResourceId":"/subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/AzureFiles/providers/Microsoft.Storage/storageAccounts/afaccount1"
}
}
}

La réponse doit être gérée comme pour les restaurations de partages complets.

Étapes suivantes

Découvrez comment gérer la sauvegarde de partages de fichiers Azure à l’aide de l’API REST.

Partager via

Restaurer des partages de fichiers Azure à l’aide de l’API REST

Prérequis

Extraire ContainerName et ProtectedItemName

Exemple de réponse pour récupérer des points de récupération

Créer un corps de demande

Restaurer dans l’emplacement d’origine

Exemple de corps de demande pour restaurer à l'emplacement d'origine

Restaurer à un autre emplacement

Exemple de corps de demande pour restaurer à un autre emplacement

response

Exemple de réponse

Récupération au niveau d’un élément avec l’API REST

Créer un corps de demande pour la récupération au niveau de l'élément à l'aide de l'API REST

Restaurer à l'emplacement d'origine pour la récupération au niveau de l'élément à l'aide de l'API REST

Restaurer à un autre emplacement pour la récupération au niveau de l'élément à l'aide de l'API REST

Étapes suivantes

Commentaires

Ressources supplémentaires

Partager via

Restaurer des partages de fichiers Azure à l’aide de l’API REST

Prérequis

Extraire ContainerName et ProtectedItemName

Extraire des points de récupération pour le partage de fichiers Azure sauvegardé

Exemple de réponse pour récupérer des points de récupération

Récupération de partage complet avec l’API REST

Créer un corps de demande

Restaurer dans l’emplacement d’origine

Exemple de corps de demande pour restaurer à l'emplacement d'origine

Restaurer à un autre emplacement

Exemple de corps de demande pour restaurer à un autre emplacement

response

Exemple de réponse

Récupération au niveau d’un élément avec l’API REST

Créer un corps de demande pour la récupération au niveau de l'élément à l'aide de l'API REST

Restaurer à l'emplacement d'origine pour la récupération au niveau de l'élément à l'aide de l'API REST

Restaurer à un autre emplacement pour la récupération au niveau de l'élément à l'aide de l'API REST

Étapes suivantes

Commentaires

Ressources supplémentaires