Long Term Retention Backups - Update By Resource Group

Service:: SQL Database

Version d'API:: 2025-01-01

Met à jour une sauvegarde de rétention à long terme existante.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
backupName	path	True	string	Nom de sauvegarde.
locationName	path	True	string	Emplacement de la base de données.
longTermRetentionDatabaseName	path	True	string	Le nom de la base de données,
longTermRetentionServerName	path	True	string	Nom du serveur
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Type de redondance de stockage de la sauvegarde copiée

Réponses

Nom	Type	Description
200 OK	LongTermRetentionBackupOperationResult	Opération Azure terminée avec succès.
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

LongTermRetentionBackupOperationResult

Opération Azure terminée avec succès.

202 Accepted

Exploitation des ressources acceptée.

En-têtes

Location: string

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Update the long term retention backup.

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=2025-01-01

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

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/SQL/stable/2025-01-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

Exemple de réponse

Code d’état:: 200

{
  "name": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "type": "Microsoft.Sql/locations/longTermRetentionBackupOperationResults",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "properties": {
    "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",
    "requestId": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
    "status": "Succeeded",
    "targetBackupStorageRedundancy": "Geo"
  }
}

Code d’état:: 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

Définitions

Nom	Description
BackupStorageRedundancy	Type de compte de stockage utilisé pour stocker des sauvegardes pour cette base de données.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LongTermRetentionBackupOperationResult	Ressource de résultat de l’opération LongTermRetentionBackup.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UpdateLongTermRetentionBackupParameters	Contient les informations nécessaires pour effectuer une opération de mise à jour de sauvegarde de rétention à long terme.

BackupStorageRedundancy

Énumération

Type de compte de stockage utilisé pour stocker des sauvegardes pour cette base de données.

Valeur	Description
Geo	Zone géographique
Local	Local
Zone	Zone
GeoZone	GeoZone

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LongTermRetentionBackupOperationResult

Objet

Ressource de résultat de l’opération LongTermRetentionBackup.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.fromBackupResourceId	string	ID de ressource de sauvegarde source
properties.message	string	Message de progression
properties.operationType	string	Type d’opération.
properties.requestId	string (uuid)	ID de demande.
properties.status	string	État de l’opération
properties.targetBackupStorageRedundancy	BackupStorageRedundancy	Type de redondance de stockage de la sauvegarde copiée
properties.toBackupResourceId	string	ID de ressource de sauvegarde cible
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UpdateLongTermRetentionBackupParameters

Objet

Contient les informations nécessaires pour effectuer une opération de mise à jour de sauvegarde de rétention à long terme.

Nom	Type	Description
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Type de redondance de stockage de la sauvegarde copiée