Restaurar Compartilhamentos de Arquivos do Azure usando a API REST

Artigo
10/15/2024

Este artigo explica como restaurar um compartilhamento de arquivos inteiro ou arquivos específicos de um ponto de restauração criado pelo Backup do Azure usando a API REST.

No final deste artigo, você aprenderá a executar as seguintes operações usando a API REST:

Exiba pontos de restauração para um compartilhamento de arquivos do Azure com backup.
Restaure um compartilhamento de arquivos completo do Azure.
Restaure ficheiros ou pastas individuais.

Pré-requisitos

Supomos que você já tenha um compartilhamento de arquivos de backup que deseja restaurar. Caso contrário, verifique o compartilhamento de arquivos do Backup do Azure usando a API REST para saber como criar um.

Para este artigo, usamos os seguintes recursos:

RecoveryServicesVault: azurefilesvault
Grupo de recursos: azurefiles
Conta de armazenamento: afsaccount
Compartilhamento de arquivos: azurefiles

Fetch ContainerName e ProtectedItemName

Para a maioria das chamadas de API relacionadas à restauração, você precisa passar valores para os parâmetros de URI {containerName} e {protectedItemName}. Use o atributo ID no corpo da resposta da operação GET backupprotectableitems para recuperar valores para esses parâmetros. No nosso exemplo, o ID da partilha de ficheiros que queremos proteger é:

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

Assim, os valores traduzem-se da seguinte forma:

{containername} - recipiente de armazenamento; armazenamento; AzureFiles; AFSACCOUNT
{protectedItemName} - azurefileshare; azurefiles

Para restaurar qualquer compartilhamento de arquivos ou arquivos de backup, primeiro selecione um ponto de recuperação para executar a operação de restauração. Os pontos de recuperação disponíveis de um item de backup podem ser listados usando a chamada da API REST da Lista de Pontos de Recuperação. É uma operação GET com todos os valores relevantes.

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}

Defina os valores de URI da seguinte maneira:

{fabricName}: Azure
{vaultName}: azurefilesvault
{containername}: recipiente de armazenamento; armazenamento; AzureFiles; AFSACCOUNT
{protectedItemName}: azurefileshare; azurefiles
{ResourceGroupName}: azurefiles

O GET URI tem todos os parâmetros necessários. Não há necessidade de outro órgão solicitante.

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

Exemplo de resposta para buscar pontos de recuperação

Depois que o GET URI é enviado, uma resposta 200 é retornada:

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"
  },

O ponto de recuperação é identificado com o campo {name} na resposta acima.

Use esta opção de restauração para restaurar o compartilhamento de arquivos completo no local original ou alternativo. Acionar a restauração é uma solicitação POST e você pode executar essa operação usando a API REST de restauração do gatilho.

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

Os valores {containerName} e {protectedItemName} são os definidos aqui e recoveryPointID é o campo {name} do ponto de recuperação mencionado acima.

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'

Criar corpo de solicitação

Para disparar uma restauração para um compartilhamento de arquivos do Azure, a seguir estão os componentes do corpo da solicitação:

Nome	Tipo	Description
Propriedades	AzureFileShareRestoreRequest	Propriedades RestoreRequestResource

Para obter a lista completa de definições do corpo da solicitação e outros detalhes, consulte o documento Restore REST API do gatilho.

Restaurar para o local original

Exemplo de corpo de solicitação para restaurar para o local original

O corpo da solicitação a seguir define as propriedades necessárias para disparar uma restauração de compartilhamento de arquivos do Azure:

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

Restaurar para local alternativo

Especifique os seguintes parâmetros para recuperação de local alternativo:

targetResourceId: A conta de armazenamento para a qual o conteúdo de backup é restaurado. A conta de armazenamento de destino deve estar no mesmo local do cofre.
name: O compartilhamento de arquivos na conta de armazenamento de destino para a qual o conteúdo de backup é restaurado.
targetFolderPath: A pasta sob o compartilhamento de arquivos para o qual os dados são restaurados.

Exemplo de corpo de solicitação para restauração em local alternativo

O corpo da solicitação a seguir restaura o compartilhamento de arquivos azurefiles na conta de armazenamento afsaccount para o compartilhamento de arquivos azurefiles1 na conta de armazenamento 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

O acionamento de uma operação de restauração é uma operação assíncrona. Esta operação cria outra operação que precisa ser rastreada separadamente. Ele retorna duas respostas: 202 (Aceito) quando outra operação é criada e 200 (OK) quando essa operação é concluída.

Exemplo de resposta

Depois de enviar o URI POST para acionar uma restauração, a resposta inicial é 202 (Aceito) com um cabeçalho de local 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'

Em seguida, acompanhe a operação resultante usando o cabeçalho location ou o cabeçalho Azure-AsyncOperation com um comando 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

Quando a operação for concluída, ela retornará 200 (OK) com a ID do trabalho de restauração resultante no corpo da resposta.

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"
}

Para recuperação de localização alternativa, o corpo de resposta será assim:

{
  "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"
}

Como o trabalho de backup é uma operação de longa execução, ele deve ser rastreado conforme explicado nos trabalhos de monitor usando o documento da API REST.

Recuperação no nível do item usando a API REST

Você pode usar essa opção de restauração para restaurar arquivos ou pastas individuais no local original ou alternativo.

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

Os valores {containerName} e {protectedItemName} são os definidos aqui e recoveryPointID é o campo {name} do ponto de recuperação mencionado acima.

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'

Criar corpo de solicitação para recuperação no nível do item usando a API REST

Para disparar uma restauração para um compartilhamento de arquivos do Azure, a seguir estão os componentes do corpo da solicitação:

Nome	Tipo	Description
Propriedades	AzureFileShareRestoreRequest	Propriedades RestoreRequestResource

Para obter a lista completa de definições do corpo da solicitação e outros detalhes, consulte o documento Restore REST API do gatilho.

Restaurar para o local original para recuperação no nível do item usando a API REST

O corpo da solicitação a seguir é restaurar o arquivo Restoretest.txt no compartilhamento de arquivos azurefiles na conta de armazenamento afsaccount .

Criar corpo de solicitação

{
   "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
}
}

Restaurar para um local alternativo para recuperação no nível do item usando a API REST

O corpo da solicitação a seguir é restaurar o arquivo Restoretest.txt no compartilhamento de arquivos azurefiles na conta de armazenamento afsaccount para a pasta restoredata do compartilhamento de arquivos azurefiles1 na conta de armazenamento afaccount1 .

Criar corpo de solicitação

{
   "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"
}
}
}

A resposta deve ser tratada da mesma forma que explicado acima para restaurações completas de ações.

Próximos passos

Saiba como gerenciar o backup de compartilhamentos de arquivos do Azure usando a API REST.

Partilhar via

Restaurar Compartilhamentos de Arquivos do Azure usando a API REST

Pré-requisitos

Fetch ContainerName e ProtectedItemName

Exemplo de resposta para buscar pontos de recuperação

Criar corpo de solicitação

Restaurar para o local original

Exemplo de corpo de solicitação para restaurar para o local original

Restaurar para local alternativo

Exemplo de corpo de solicitação para restauração em local alternativo

Response

Exemplo de resposta

Recuperação no nível do item usando a API REST

Criar corpo de solicitação para recuperação no nível do item usando a API REST

Restaurar para o local original para recuperação no nível do item usando a API REST

Restaurar para um local alternativo para recuperação no nível do item usando a API REST

Próximos passos

Comentários

Recursos adicionais

Partilhar via

Restaurar Compartilhamentos de Arquivos do Azure usando a API REST

Pré-requisitos

Fetch ContainerName e ProtectedItemName

Buscar pontos de recuperação para backup do compartilhamento de arquivos do Azure

Exemplo de resposta para buscar pontos de recuperação

Recuperação completa de compartilhamento usando a API REST

Criar corpo de solicitação

Restaurar para o local original

Exemplo de corpo de solicitação para restaurar para o local original

Restaurar para local alternativo

Exemplo de corpo de solicitação para restauração em local alternativo

Response

Exemplo de resposta

Recuperação no nível do item usando a API REST

Criar corpo de solicitação para recuperação no nível do item usando a API REST

Restaurar para o local original para recuperação no nível do item usando a API REST

Restaurar para um local alternativo para recuperação no nível do item usando a API REST

Próximos passos

Comentários

Recursos adicionais