Long Term Retention Backups - Update By Resource Group

Serviço:

SQL Database

Versão da API:

2023-08-01

Atualiza um backup de retenção de longo prazo existente.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/update?api-version=2023-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
backupName	path	True	string	O nome do backup.
locationName	path	True	string	O local do banco de dados.
longTermRetentionDatabaseName	path	True	string	O nome do banco de dados
longTermRetentionServerName	path	True	string	O nome do servidor
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome	Tipo	Description
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de redundância de armazenamento do backup copiado

Respostas

Nome	Tipo	Description
200 OK	LongTermRetentionBackupOperationResult	Atualizou com êxito o backup.
202 Accepted		A atualização do backup está em andamento. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidLongTermRetentionBackupId - Identificador de backup de retenção de longo prazo inválido para BDs SQL. 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro. 400 LongTermRetentionMismatchingSubscriptionId - A ID da assinatura fornecida não correspondeu à ID na outra entrada 400 LongTermRetentionMismatchingResourceGroupName - O nome do grupo de recursos fornecido não correspondeu ao nome na outra entrada 400 LongTermRetentionMismatchingServerName - O nome do servidor fornecido não correspondeu ao nome na outra entrada 400 DeleteLtrSubscriptionMissing – A ID da assinatura é necessária para excluir um backup de retenção de longo prazo. 400 DeleteLtrServerMissing – O nome do servidor é necessário para excluir um backup de retenção de longo prazo. 400 DeleteLtrDatabaseMissing - O nome do banco de dados é necessário para excluir um backup de retenção de longo prazo. 400 LtrBackupResourceIdIncorrect - A ID do recurso de backup de retenção de longo prazo fornecida ou o nome do backup está incorreto. 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage – Não há suporte para o arquivamento de backups de retenção de longo prazo no armazenamento de backup com redundância de zona. Em vez disso, use tipos de armazenamento com redundância geográfica ou com redundância local. 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing – A ID da assinatura é necessária para atualizar o backup de retenção de longo prazo. 400 UpdateBackupStorageAccessTierLtrServerMissing - O nome do servidor é necessário para atualizar o backup de retenção de longo prazo. 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - O nome do banco de dados é necessário para atualizar o backup de retenção de longo prazo. 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - O nome do recurso de backup de retenção de longo prazo fornecido está incorreto. 400 LongTermRetentionMigrationRequestNotSupported - A assinatura não tem permissão para recurso de migração de backup ltr. 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - As assinaturas de origem e de destino não têm permissão para se comunicar com o recurso de cópia de backup ltr. 400 LongTermRetentionMigrationParameterMissing – parâmetro obrigatório ausente para a operação. 400 LongTermRetentionMigrationSameServerNotSupported – Não há suporte para o recurso de cópia LTR para copiar backups LTR no mesmo servidor. 400 LongTermRetentionMigrationTargetServerNotFound - O servidor de destino não existe ou não está pronto para a operação de cópia de backup ltr. 400 LongTermRetentionMigrationTargetDatabaseNotFound – O Banco de Dados de Destino não existe no servidor. 400 LongTermRetentionMigrationStorageTypeNotSupported – Não há suporte para redundância de armazenamento de backup especificada na região de destino. 400 LongTermRetentionMigrationStorageMismatch – A redundância de backup ativo do banco de dados não corresponde à redundância de backup solicitada pelo cliente. 400 LtrOperationFailedBackupImmutable – Falha na exclusão do backup de retenção de longo prazo porque o backup é imutável. 400 LongTermRetentionMigrationDatabaseTypeNotSupported – A migração de LTR só tem suporte para backups LTR da instância gerenciada e do BD SQL do Azure. 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - A alteração da redundância de armazenamento de backup não é permitida para operações de cópia ltr. 400 LtrRestoreFailedArchiveStorageTier – Não há suporte para restaurar o backup de retenção de longo prazo arquivado. A restauração só pode ser executada em backups de retenção de longo prazo ou reidratados ou regulares. 400 LtrArchiveStorageTierNotEnabled – O arquivamento de backups de retenção de longo prazo não está habilitado. 400 LtrArchiveWrongParameters – ChangeLongTermRetentionBackupAccessTier não tem suporte para a combinação desejada (backupStorageAccessTier, operationMode). Somente (Arquivar, Mover) e (Ativar, Copiar) são permitidos. 400 LTRArchiveRedundancyChangeFailed - Não há suporte para atualizar o tipo de redundância de armazenamento de backup para armazenamento com redundância de zona quando uma política de retenção de longo prazo com a camada de acesso de armazenamento de backup 'archive' é definida 400 LongTermRetentionMigrationSubscriptionNotFound – Não foi possível encontrar a assinatura. 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 LongTermRetentionMigrationBackupNotFound – O backup LTR especificado não existe. 404 OperationIdNotFound – A operação com id não existe. 409 LongTermRetentionMigrationRequestConflict – Uma operação de conflito neste backup LTR ainda está em andamento. 409 LongTermRetentionMigrationBackupConflict – Existe outro backup LTR com o mesmo tempo de backup para o banco de dados de destino. 409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado. 409 OperationCancelled – A operação foi cancelada pelo usuário. 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 LongTermRetentionMigrationRequestFailedToStartOnTarget – Falha ao iniciar a solicitação de cópia de backup ltr na região de destino. 500 LongTermRetentionMigrationRequestCopyFailed – Falha na operação de cópia para blobs de backup ltr. 500 LongTermRetentionMigrationRestoreVerExceeded - Falha na verificação de restauração após tentativas máximas. 500 LongTermRetentionMigrationRestoreVerFailed – Falha na verificação de restauração. 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Update the long term retention backup.

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000/update?api-version=2023-08-01

{
  "properties": {
    "requestedBackupStorageRedundancy": "Geo"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ResourceGroupBasedLongTermRetentionBackupUpdate.json
// this example is just showing the usage of "LongTermRetentionBackups_UpdateByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupLongTermRetentionBackupResource created on azure
// for more information of creating ResourceGroupLongTermRetentionBackupResource, please refer to the document of ResourceGroupLongTermRetentionBackupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testResourceGroup";
AzureLocation locationName = new AzureLocation("japaneast");
string longTermRetentionServerName = "testserver";
string longTermRetentionDatabaseName = "testDatabase";
string backupName = "55555555-6666-7777-8888-999999999999;131637960820000000";
ResourceIdentifier resourceGroupLongTermRetentionBackupResourceId = ResourceGroupLongTermRetentionBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName);
ResourceGroupLongTermRetentionBackupResource resourceGroupLongTermRetentionBackup = client.GetResourceGroupLongTermRetentionBackupResource(resourceGroupLongTermRetentionBackupResourceId);

// invoke the operation
UpdateLongTermRetentionBackupContent content = new UpdateLongTermRetentionBackupContent
{
    RequestedBackupStorageRedundancy = SqlBackupStorageRedundancy.Geo,
};
ArmOperation<LongTermRetentionBackupOperationResult> lro = await resourceGroupLongTermRetentionBackup.UpdateByResourceGroupAsync(WaitUntil.Completed, content);
LongTermRetentionBackupOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "name": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "type": "Microsoft.Sql/locations/longTermRetentionBackupOperationResults",
  "properties": {
    "requestId": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
    "fromBackupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionServers/testserver/longterRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
    "operationType": "UpdateBackup",
    "status": "Succeeded",
    "targetBackupStorageRedundancy": "Geo"
  }
}

Código de status:

202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706?api-version=2021-05-01

Definições

Nome	Description
BackupStorageRedundancy	O tipo de redundância de armazenamento do backup copiado
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LongTermRetentionBackupOperationResult	Um recurso de resultado da operação LongTermRetentionBackup.
UpdateLongTermRetentionBackupParameters	Contém as informações necessárias para executar a operação de atualização de backup de retenção de longo prazo.

BackupStorageRedundancy

Enumeração

O tipo de redundância de armazenamento do backup copiado

Valor	Description
Geo
GeoZone
Local
Zone

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

LongTermRetentionBackupOperationResult

Objeto

Um recurso de resultado da operação LongTermRetentionBackup.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.fromBackupResourceId	string	ID do recurso de backup de origem
properties.message	string	Mensagem de progresso
properties.operationType	string	Tipo de operação.
properties.requestId	string (uuid)	ID da solicitação.
properties.status	string	Status da operação
properties.targetBackupStorageRedundancy	BackupStorageRedundancy	O tipo de redundância de armazenamento do backup copiado
properties.toBackupResourceId	string	ID do recurso de backup de destino
type	string	Tipo de recurso.

UpdateLongTermRetentionBackupParameters

Objeto

Contém as informações necessárias para executar a operação de atualização de backup de retenção de longo prazo.

Nome	Tipo	Description
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de redundância de armazenamento do backup copiado