Gérer des bases de données SQL Server dans des machines virtuelles Azure à l’aide de l’API REST

Cet article explique comment gérer et surveiller les bases de données SQL Server sauvegardées par Sauvegarde Azure à l’aide de l’API REST. Vous pouvez également utiliser Azure CLI et le portail Azure pour gérer les sauvegardes de base de données SQL.

Pour voir les scénarios de sauvegarde et de restauration que nous prenons en charge, consultez la matrice de prise en charge. Pour les questions courantes, consultez les questions fréquemment posées.

Surveiller des travaux

Le service Sauvegarde Azure déclenche des travaux qui s’exécutent en arrière-plan. Cela comprend des scénarios tels que le déclenchement de la sauvegarde, les opérations de restauration et la désactivation de la sauvegarde. Vous pouvez suivre ces tâches à l’aide de leurs ID. Découvrez plus d’informations sur la gestion des travaux de sauvegarde et restauration.

Récupérer des informations sur les travaux à partir des opérations

Une opération, telle que le déclenchement d'une sauvegarde, renvoie une jobID en réponse.

Par exemple, la réponse finale d’une opération de déclenchement de la sauvegarde par l’API REST est comme suit :

{
  "id": "cd2a3b13-d392-4e81-86ac-02ea91cc70b9",
  "name": "cd2a3b13-d392-4e81-86ac-02ea91cc70b9",
  "status": "Succeeded",
  "startTime": "2018-05-28T11:43:21.6516182Z",
  "endTime": "2018-05-28T11:43:21.6516182Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "c22eca5d-0c1c-48a0-a40d-69bef708d92a"
  }
}

Le travail de sauvegarde est identifié par le champ jobId et peut être suivi comme mentionné ici en utilisant une requête GET.

Suivre le travail

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}?api-version=2016-12-01

L’{jobName} est jobId comme indiqué précédemment. La réponse est toujours 200 (OK) avec le champ état indiquant l’état actuel du travail. Lorsque l’état est Completed ou CompletedWithWarnings, la section extendedInfo révèle plus de détails sur le travail.

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/Microsoft.RecoveryServices/vaults/SQLServer2012/backupJobs/c22eca5d-0c1c-48a0-a40d-69bef708d92a?api-version=2016-12-01

réponse

Nom Type Descriptif
200 OK JobResource Ok

Exemple de réponse

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

HTTP/1.1 200 OK
Pragma: no-cache
X-Content-Type-Options: nosniff
x-ms-request-id: e057b496-8ceb-45b6-bd9e-367f7dd73d6d
x-ms-client-request-id: 1ffda117-b2c0-4a80-a9ba-43ba66eaec9b; 1ffda117-b2c0-4a80-a9ba-43ba66eaec9b
Strict-Transport-Security: max-age=31536000; includeSubDomains
x-ms-ratelimit-remaining-subscription-reads: 14999
x-ms-correlation-request-id: e057b496-8ceb-45b6-bd9e-367f7dd73d6d
x-ms-routing-request-id: SOUTHINDIA:20180528T115536Z:e057b496-8ceb-45b6-bd9e-367f7dd73d6d
Cache-Control: no-cache
Date: Mon, 28 May 2018 11:55:35 GMT
Server: Microsoft-IIS/8.0
X-Powered-By: ASP.NET

{
  "id": "/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/microsoft.recoveryservices/vaults/SQLServer2012/backupJobs/c22eca5d-0c1c-48a0-a40d-69bef708d92a",
  "name": "c22eca5d-0c1c-48a0-a40d-69bef708d92a",
  "type": "Microsoft.RecoveryServices/vaults/backupJobs",
  "properties": {
    "jobType": "AzureWorkloadJob",
    "workloadType": "SQLDataBase",
    "duration": "00:03:13.6439467",
    "actionsInfo": [
      1
    ],
    "errorDetails": [
      {
        "errorCode": 510008,
        "errorString": "Operation cancelled as a conflicting operation was already running on the same database.",
        "errorTitle": "OperationCancelledBecauseConflictingOperationRunningUserError",
        "recommendations": [
          "Please try again after sometime."
        ]
      }
    ],
    "extendedInfo": {
      "tasksList": [
        {
          "taskId": "Transfer data to vault",
          "status": "Failed"
        }
      ],
      "propertyBag": {
        "Data Transferred (in MB)": "0"
      }
    },
    "entityFriendlyName": "MSSQLSERVER/msDB [sqlserver-0.contoso.com]",
    "backupManagementType": "AzureWorkload",
    "operation": "Backup (Full)",
    "status": "Failed",
    "startTime": "2018-05-28T11:43:21.6516182Z",
    "endTime": "2018-05-28T11:46:35.2955649Z",
    "activityId": "6b033cf6-f875-4c03-8985-9add07ec2845"
  }
} 
}

Listez les instances et bases de données SQL protégées

Pour lister les instances SQL et leurs bases de données pour la protection des instantanés au niveau des instances, utilisez la version de l’API 2024-01-31-preview. Remplacez les espaces réservés de l’URI par les informations de votre coffre. Les exemples suivants montrent des champs de réponse sélectionnés.

Lister les instances SQL protégées

Filtrez les articles protégés par itemType eq 'SQLInstance':

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2024-01-31-preview&$filter=backupManagementType eq 'AzureWorkload' and itemType eq 'SQLInstance'

La réponse contient un value tableau. Chaque instance inclut son nom d’élément protégé, le nom du conteneur, les bases de données enfants et son statut de protection. Par exemple:

{
  "value": [
    {
      "name": "SQLInstance;mssqlserver",
      "properties": {
        "childDBList": ["MSSQLSERVER;testdb", "MSSQLSERVER;testdb1", "MSSQLSERVER;testdb2"],
        "instanceProtectionReadiness": "Ready",
        "friendlyName": "mssqlserver",
        "serverName": "sqlserver-0",
        "protectedItemType": "AzureVmWorkloadSQLInstance",
        "backupManagementType": "AzureWorkload",
        "workloadType": "SQLInstance",
        "containerName": "VMAppContainer;Compute;SQLServerPMDemo;sqlserver-0",
        "protectionStatus": "Healthy",
        "protectionState": "IRPending",
        "protectedItemDataSourceId": "2265943933205758867"
      }
    }
  ]
}

Sauvegardez les noms du conteneur retourné et de l’élément protégé pour les demandes ultérieures. Par exemple, pour les requêtes de récupération à un instant donné, enregistrez également protectedItemDataSourceId.

Lister les bases de données protégées pour une instance

Listez les éléments de base de données protégés dans le coffre :

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2024-01-31-preview&$filter=backupManagementType eq 'AzureWorkload' and itemType eq 'SQLDatabase'

Dans le tableau retourné value , identifiez les bases de données avec protectionLevel défini sur DatabaseUnderInstance. Utilisez parentProtectedItem, ainsi que les détails du conteneur et du serveur, pour identifier l’instance parente. Les propriétés d’un élément de base de données peuvent inclure :

{
  "parentProtectedItem": "mssqlserver",
  "protectionLevel": "DatabaseUnderInstance",
  "friendlyName": "testdb",
  "serverName": "sqlserver-0",
  "parentName": "MSSQLSERVER",
  "protectedItemType": "AzureVmWorkloadSQLDatabase",
  "backupManagementType": "AzureWorkload",
  "workloadType": "SQLDataBase"
}

Obtenez une instance SQL protégée

Pour récupérer une seule instance, utilisez les noms du conteneur renvoyé et de l’élément protégé :

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview

Par exemple, {protectedItemName} peut être SQLInstance;mssqlserver. La réponse inclut childDBList, instanceProtectionReadiness, et protectionState. Si l’élément est programmé pour suppression différée, inspectez isScheduledForDeferredDelete, deferredDeleteTimeInUTC, et softDeleteRetentionPeriod également.

Modifier la stratégie

Pour modifier la stratégie qui protège la base de données, utilisez le même format qu’activer la protection. Cependant, indiquez l'ID de la nouvelle politique dans le corps de la demande et soumettez la demande. Par exemple, pour changer la politique de testVM de HourlyLogPolicy à ProdPolicy, fournissez l'ID de ProdPolicy dans le corps de la demande.

{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLDataBase",
    "policyId": "/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/microsoft.recoveryservices/vaults/SQLServer2012/backupPolicies/ProdPolicy"
  },
  "location": "westcentralus"
}

La réponse suivra le même format que celui mentionné pour l’activation de la protection.

Modifier la stratégie pour une instance protégée par un instantané

Soumettez une requête PUT pour l’élément protégé de l’instance et fournissez le nouvel identifiant de stratégie d’instantané :

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview
{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLInstance",
    "protectedItemType": "AzureVmWorkloadSQLInstance",
    "friendlyName": "MSSQLSERVER",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{newPolicyName}",
    "childDatabaseNameList": ["model"]
  }
}

Remplacez les placeholders dans le corps JSON ainsi que dans l’URI. Utilisez les noms de bases de données sélectionnés de l’instance dans childDatabaseNameList.

Résumé de sauvegarde pour une instance SQL

Pour reprendre la sauvegarde, soumettez une requête PUT à l’élément protégé de l’instance avec l’identifiant de la stratégie de capture instantanée. L’exemple suivant utilise un childDatabaseNameList vide pour l’opération de reprise :

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview
{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLInstance",
    "protectedItemType": "AzureVmWorkloadSQLInstance",
    "friendlyName": "MSSQLSERVER",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/SQLInstanceSnapPolicy",
    "childDatabaseNameList": []
  }
}

Utilisez le nom de l’article protégé de l’instance, comme SQLInstance;mssqlserver, et remplacez les espaces réservés de l’ID de stratégie par les détails de votre coffre-fort. Suivez l’opération et la tâche résultantes telles que décrites dans Surveiller les tâches.

Arrêter la protection tout en conservant les données existantes

Pour supprimer la protection d’une base de données protégée et conserver les données déjà protégées, supprimez la stratégie dans le corps de la demande que vous avez utilisé pour activer la sauvegarde et envoyer la demande. Une fois l’association à la stratégie supprimée, les sauvegardes ne sont plus déclenchées et aucun point de récupération n’est créé.

{
  "properties": {
    "protectedItemType": "AzureVmWorkloadSQLDatabase",
    "protectionState": "ProtectionStopped",
    "sourceResourceId":
"/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerPMDemo/providers/Microsoft.Compute/virtualMachines/sqlserver-0",
    "policyId": ""
  }
}

Exemple de réponse

L’arrêt de la protection d’une base de données est une opération asynchrone. L’opération crée une autre opération qui doit faire l’objet d’un suivi. Elle retourne deux réponses : 202 (Accepté) lors de la création d’une autre opération et 200 quand cette opération est terminée.

En-tête de réponse lorsque l’opération est acceptée avec succès :

Status Code:
OK

Headers:
Pragma                        : no-cache
X-Content-Type-Options        : nosniff
x-ms-request-id               : 388c9359-e237-4644-8f6c-38ae5eb0dfcb
x-ms-client-request-id        : 5ef896e6-d812-431a-ad58-9d9ee1bb8bb3,5ef896e6-d812-431a-ad58-9d9ee1bb8bb3
Strict-Transport-Security     : max-age=31536000; includeSubDomains
x-ms-ratelimit-remaining-subscription-resource-requests: 107
x-ms-correlation-request-id   : 388c9359-e237-4644-8f6c-38ae5eb0dfcb
x-ms-routing-request-id       : SOUTHINDIA:20211126T054036Z:388c9359-e237-4644-8f6c-38ae5eb0dfcb
Cache-Control                 : no-cache
Date                          : Fri, 26 Nov 2021 05:40:36 GMT
Server                        : Microsoft-IIS/10.0
X-Powered-By                  : ASP.NET

Body:
{
  "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "name": "TestOBJ",
  "status": "Succeeded",
  "startTime": "2021-11-26T05:36:36.5262731Z",
  "endTime": "2021-11-26T05:36:36.5262731Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "68178d86-d564-460b-9643-829046aac1b1"
  }
}

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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupoperations/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e?api-version=2016-12-01

Corps de réponse

{
  "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "name": "TestOBJ",
  "status": "Succeeded",
  "startTime": "2021-11-26T05:36:36.5262731Z",
  "endTime": "2021-11-26T05:36:36.5262731Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "68178d86-d564-460b-9643-829046aac1b1"
  }
}

Arrêter la protection d’une base de données protégée sous une instance

Pour une base de données protégée par une politique d’instantané d’instance, soumettez une requête PUT à l’élément protégé de la base de données , et non à l’élément d’instance :

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/SQLDatabase;MSSQLSERVER;tdb2?api-version=2024-01-31-preview

Définissez protectionState sur ProtectionStopped, puis incluez l’ID de politique d’instantané d’instance :

{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLDataBase",
    "friendlyName": "MSSQLSERVER;tdb2",
    "protectedItemType": "AzureVmWorkloadSQLDatabase",
    "protectionState": "ProtectionStopped",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/SQLInstanceSnapPolicy"
  }
}

Remplacez le nom d’article de base de données par le nom retourné pour votre base de données et remplacez les espaces réservés d’ID de stratégie. Cette opération arrête la protection tout en conservant les données de sauvegarde existantes. Suivez l’opération asynchrone telle que décrite précédemment dans cette section.

Arrêter la protection et supprimer les données de sauvegarde

Pour supprimer la protection sur un partage de fichiers protégé ainsi que les données de sauvegarde, effectuez une opération de suppression.

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

Les paramètres containerName et protectedItemName sont tels qu’ils sont configurés à l’étape de configuration de sauvegarde de cet article.

Réponses

La suppression de la protection est une opération asynchrone. L’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, puis 204 (Pas de contenu) quand cette opération est terminée.

Étapes suivantes