Partager via

Long Term Retention Policies - Create Or Update

  • Référence
Service:
SQL Database
Version d'API:
2021-11-01

Définit la stratégie de rétention à long terme d’une base de données.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/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

LongTermRetentionPolicyName

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.monthlyRetention

string

Stratégie de rétention mensuelle pour une sauvegarde LTR au format ISO 8601.
properties.weekOfYear

integer

Semaine de l’année pour effectuer la sauvegarde annuelle au format ISO 8601.
properties.weeklyRetention

string

Stratégie de rétention hebdomadaire pour une sauvegarde LTR au format ISO 8601.
properties.yearlyRetention

string

Stratégie de rétention annuelle pour une sauvegarde LTR au format ISO 8601.

Réponses

Nom Type Description
200 OK

LongTermRetentionPolicy

Définissez correctement la stratégie.
202 Accepted

Accepté
Other Status Codes

Réponses d’erreur : ***

  • 400 InvalidResourceRequestBody : les propriétés de ressource ou de ressource dans le corps de la requête sont vides ou non valides.

  • 400 InvalidParameterValue : une valeur non valide a été donnée à un paramètre.

  • 400 LongTermRetentionMissingWeekOfYear - WeekOfYear doit être défini entre 1 et 52 pour définir la rétention annuelle.

  • 400 LTRNotSupportedForPerDBCMK - La rétention des sauvegardes à long terme n’est pas prise en charge lorsque la clé CMK au niveau de la base de données est configurée en préversion.

  • 400 LongTermRetentionPolicyNotSupported - La rétention à long terme n’est pas prise en charge sur cette base de données.

  • 400 LongTermRetentionPolicyInvalid - La stratégie de rétention à long terme n’est pas valide.

  • 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 OperationIdNotFound : l’opération avec ID n’existe pas.

  • 409 OperationCancelled : l’opération a été annulée par l’utilisateur.

  • 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.

  • 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.

  • 500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération.

  • 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Create or update the long term retention policy for the database.

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}
Code d’état:
202

Définitions

Nom Description
LongTermRetentionPolicy

Stratégie de rétention à long terme.
LongTermRetentionPolicyName

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

LongTermRetentionPolicy

Object

Stratégie de rétention à long terme.

Nom Type Description
id

string

ID de la ressource
name

string

Nom de la ressource.
properties.monthlyRetention

string

Stratégie de rétention mensuelle pour une sauvegarde LTR au format ISO 8601.
properties.weekOfYear

integer

Semaine de l’année pour effectuer la sauvegarde annuelle au format ISO 8601.
properties.weeklyRetention

string

Stratégie de rétention hebdomadaire pour une sauvegarde LTR au format ISO 8601.
properties.yearlyRetention

string

Stratégie de rétention annuelle pour une sauvegarde LTR au format ISO 8601.
type

string

Type de ressource.

LongTermRetentionPolicyName

Enumeration

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

Valeur Description
default