Backup Short Term Retention Policies - Update

Service:

SQL Database

API Version:

2021-11-01

Mises à jour la stratégie de rétention à court terme d’une base de données.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/default?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
policyName	path	True	ShortTermRetentionPolicyName	Nom de la stratégie. Doit toujours être « par défaut ».
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.diffBackupIntervalInHours	DiffBackupIntervalInHours	Intervalle de sauvegarde différentielle en heures. Il s’agit du nombre d’heures d’intervalle entre chaque sauvegarde différentielle qui sera pris en charge. Cela s’applique uniquement aux bases de données actives, mais pas aux bases de données supprimées.
properties.retentionDays	integer	Période de rétention de la sauvegarde, en jours. Il s’agit du nombre de jours pendant lesquels la restauration dans le temps sera prise en charge.

Réponses

Nom	Type	Description
200 OK	BackupShortTermRetentionPolicy	Mise à jour réussie de la stratégie.
202 Accepted		Accepté
Other Status Codes		Réponses d’erreur : *** 400 InvalidParameterValue : une valeur non valide a été donnée à un paramètre. 400 InvalidBackupRetentionPeriod : les jours de rétention de n’est {0} pas une configuration valide. La rétention de sauvegarde valide en jours doit être comprise entre {1} et {2} 400 InvalidDiffBackupIntervalHours : l’intervalle d’heures de sauvegarde différentielle de n’est {0} pas une configuration valide. L’intervalle de sauvegarde différentielle valide doit être d’heures {1} . 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition de base de données actuelle. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 ResourceNotFound : la ressource demandée est introuvable. 404 SourceDatabaseNotFound : la base de données source n’existe pas. 404 CannotFindObject - Impossible de trouver l’objet parce qu’il n’existe pas ou que vous ne disposez pas d’autorisations 409 ConflictingDatabaseOperation : il existe déjà une opération sur la base de données et l’opération actuelle doit attendre qu’elle soit terminée. 409 ConflictingSystemOperationInProgress : une opération de maintenance du système est en cours sur la base de données et d’autres opérations doivent attendre qu’elle soit terminée. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 504 RequestTimeout - La demande de service a dépassé le délai d’expiration autorisé.

Exemples

Update the short term retention policy for the database.

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.BackupShortTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.DiffBackupIntervalInHours;
import com.azure.resourcemanager.sql.models.ShortTermRetentionPolicyName;

/** Samples for BackupShortTermRetentionPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/UpdateShortTermRetentionPolicy.json
     */
    /**
     * Sample code: Update the short term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateTheShortTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getBackupShortTermRetentionPolicies().createOrUpdate(
            "resourceGroup", "testsvr", "testdb", ShortTermRetentionPolicyName.DEFAULT,
            new BackupShortTermRetentionPolicyInner().withRetentionDays(7)
                .withDiffBackupIntervalInHours(DiffBackupIntervalInHours.TWO_FOUR),
            Context.NONE);
    }
}

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies",
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Status code:

202

Définitions

Nom	Description
BackupShortTermRetentionPolicy	Stratégie de rétention à court terme.
DiffBackupIntervalInHours	Intervalle de sauvegarde différentielle en heures. Il s’agit du nombre d’heures d’intervalle entre chaque sauvegarde différentielle qui sera pris en charge. Cela s’applique uniquement aux bases de données actives, mais pas aux bases de données supprimées.
ShortTermRetentionPolicyName	Nom de la stratégie. Doit toujours être « par défaut ».

BackupShortTermRetentionPolicy

Stratégie de rétention à court terme.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.diffBackupIntervalInHours	DiffBackupIntervalInHours	Intervalle de sauvegarde différentielle en heures. Il s’agit du nombre d’heures d’intervalle entre chaque sauvegarde différentielle qui sera pris en charge. Cela s’applique uniquement aux bases de données actives, mais pas aux bases de données supprimées.
properties.retentionDays	integer	Période de rétention de la sauvegarde, en jours. Il s’agit du nombre de jours pendant lesquels la restauration dans le temps sera prise en charge.
type	string	Type de ressource.

DiffBackupIntervalInHours

Intervalle de sauvegarde différentielle en heures. Il s’agit du nombre d’heures d’intervalle entre chaque sauvegarde différentielle qui sera pris en charge. Cela s’applique uniquement aux bases de données actives, mais pas aux bases de données supprimées.

Nom	Type	Description
12	string
24	string

ShortTermRetentionPolicyName

Nom de la stratégie. Doit toujours être « par défaut ».

Nom	Type	Description
default	string