Gerenciar bancos de dados do SQL Server em VMs do Azure usando a API REST

Este artigo descreve como gerenciar e monitorar os bancos de dados do SQL Server cujo backup é feito pelo Backup do Azure usando a API REST. Você também pode usar a CLI do Azure e o portal do Azure para gerenciar backups do banco de dados SQL.

Para visualizar os cenários de backup e restauração aos quais damos suporte atualmente, consulte a matriz de suporte. Para perguntas comuns, consulte as perguntas frequentes.

Monitorizar trabalhos

O serviço de Backup do Azure dispara trabalhos que são executados em segundo plano. Isso inclui cenários, como disparar operações de backup, restauração e desabilitar o backup. Você pode acompanhar esses trabalhos usando seus IDs. Saiba mais sobre como gerenciar tarefas de backup e restauração.

Obter informações sobre tarefas das operações

Uma operação, como acionar o backup, retorna um jobID em resposta.

Por exemplo, a resposta final de uma operação de API REST de ativação de backup é a seguinte:

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

Você pode identificar a tarefa de backup pelo campo jobId e acompanhar conforme aqui mencionado usando uma solicitação GET.

Acompanhe o trabalho

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

O {jobName} é o jobId mencionado acima. A resposta é 200 (OK) com o campo status indicando o status do trabalho. Depois de Concluído ou ConcluídoComAvisos, a secção extendedInfo mostra mais detalhes do trabalho.

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

Resposta

Nome Tipo Descrição
200 OK JobResource OK

Exemplo de resposta

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

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

Listar instâncias e bases de dados SQL protegidas

Para listar instâncias SQL e as suas bases de dados para proteção de instantâneos ao nível das instâncias, use a versão 2024-01-31-previewda API . Substitui os marcadores de posição URI pelos detalhes do teu cofre. Os exemplos seguintes mostram campos de resposta selecionados.

Listar instâncias SQL protegidas

Filtrar itens protegidos por 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'

A resposta contém um value array. Cada instância inclui o nome do item protegido, nome do contentor, bases de dados filhas e estado de proteção. Por exemplo:

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

Guarde o contentor devolvido e os nomes dos itens protegidos para solicitações subsequentes. Por exemplo, guarde também as consultas de recuperação em ponto no tempo protectedItemDataSourceId.

Listar bases de dados protegidas sob uma instância

Liste itens de base de dados protegidos no cofre:

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'

No array devolvido value , identifique bases de dados com protectionLevel definido como DatabaseUnderInstance. Utilize parentProtectedItem, juntamente com os detalhes do contentor e do servidor, para identificar a instância pai. As propriedades de um item de base de dados podem incluir:

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

Obtenha uma instância SQL protegida

Para recuperar uma única instância, use o seu contentor de devolução e os nomes dos itens protegidos:

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

Por exemplo, {protectedItemName} pode ser SQLInstance;mssqlserver. A resposta inclui childDBList, instanceProtectionReadiness, e protectionState. Se o item estiver agendado para eliminação diferida, inspecione isScheduledForDeferredDelete, deferredDeleteTimeInUTC, e softDeleteRetentionPeriod também.

Modificar política

Para alterar a política que protege o banco de dados, use o mesmo formato para habilitar a proteção. No entanto, forneça o novo ID da política no corpo da solicitação e envie a solicitação. Por exemplo, para alterar a política de testVM de HourlyLogPolicy para ProdPolicy, forneça o ID ProdPolicy no corpo da solicitação.

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

A resposta seguirá o mesmo formato mencionado para permitir a proteção.

Modificar a política para uma instância protegida por snapshots

Submeta um pedido PUT para o item protegido da instância e forneça o novo ID da política snapshot:

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

Substitua os marcadores no corpo JSON, bem como no URI. Utilize os nomes de base de dados selecionados da instância em childDatabaseNameList.

Retomar a cópia de segurança para uma instância SQL

Para retomar a cópia de segurança, submeta um pedido PUT ao item protegido da instância com o ID da política snapshot. O exemplo seguinte usa um childDatabaseNameList vazio para a operação de retomar:

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": []
  }
}

Utilize o nome do item protegido da instância, como SQLInstance;mssqlserver, e substitua os marcadores de posição do ID da política pelos detalhes do seu cofre. Acompanhe a operação e a tarefa resultantes conforme descrito em Monitorizar tarefas.

Pare a proteção e retenha os dados existentes

Para remover a proteção de um banco de dados protegido e reter os dados já submetidos a backup, remova a política no corpo da solicitação usada para habilitar o backup e enviar a solicitação. Depois de remover a associação com a política, os backups não são mais acionados e nenhum novo ponto de recuperação é criado.

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

Resposta da amostra

Interromper a proteção de um banco de dados é uma operação assíncrona. A operação cria outra operação que precisa ser rastreada. Ele retorna duas respostas: 202 (Aceito) quando outra operação é criada e 200 quando essa operação é concluída.

Cabeçalho de resposta quando a operação é aceita com êxito:

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

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

Corpo da resposta

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

Parar a proteção para uma base de dados protegida por uma instância

Para uma base de dados protegida através de uma política de snapshot de instância, submeta um pedido PUT ao item protegido da base de dados , e não ao item da instância:

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

Definir protectionState para ProtectionStopped e incluir o ID da política snapshot da instância:

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

Substitua o nome do item de exemplo da base de dados pelo nome devolvido para a sua base de dados e substitua os marcadores de posição do ID da política. Esta operação interrompe a proteção enquanto mantém os dados de backup existentes. Acompanhe a operação assíncrona conforme descrito anteriormente nesta secção.

Pare a proteção e exclua dados de backup

Para remover a proteção de um compartilhamento de arquivos protegido e excluir os dados de backup também, execute uma operação de exclusão.

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

Os parâmetros containerName e protectedItemName são os definidos na etapa de configuração de backup neste artigo.

Respostas

A proteção contra exclusão é uma operação assíncrona. A operação cria outra operação que precisa ser rastreada separadamente. Ele retorna duas respostas: 202 (Accepted) quando outra operação é criada e 204 (NoContent) quando essa operação é concluída.

Próximos passos