Long Term Retention Policies - Create Or Update

Establece la directiva de retención a largo plazo de una base de datos.

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

Parámetros de identificador URI

Name In Required Type Description
databaseName
path True
  • string

El nombre de la base de datos.

policyName
path True

Nombre de la directiva. Siempre debe ser Default.

resourceGroupName
path True
  • string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.

serverName
path True
  • string

El nombre del servidor.

subscriptionId
path True
  • string

El id. de suscripción que identifica una suscripción de Azure.

api-version
query True
  • string

La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Name Type Description
properties.monthlyRetention
  • string

La directiva de retención mensual para una copia de seguridad LTR en un formato ISO 8601.

properties.weekOfYear
  • integer

Semana del año para realizar la copia de seguridad anual en un formato ISO 8601.

properties.weeklyRetention
  • string

La directiva de retención semanal para una copia de seguridad LTR en formato ISO 8601.

properties.yearlyRetention
  • string

Directiva de retención anual para una copia de seguridad ltR en formato ISO 8601.

Respuestas

Name Type Description
200 OK

Establezca correctamente la directiva.

202 Accepted

Aceptado

Other Status Codes

Respuestas de error: ***

  • 400 InvalidResourceRequestBody: las propiedades de recurso o recurso del cuerpo de la solicitud están vacías o no son válidas.

  • 400 InvalidParameterValue: se ha dado un valor no válido a un parámetro.

  • 400 LongTermRetentionMissingWeekOfYear- WeekOfYear debe establecerse entre 1 y 52 para establecer la retención anual.

  • 400 LongTermRetentionPolicyNotSupported: la retención a largo plazo no se admite en esta base de datos.

  • 400 LongTermRetentionPolicyInvalid: la directiva de retención a largo plazo no es válida.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

  • 404 ResourceNotFound: no se encontró el recurso solicitado.

Ejemplos

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

Sample Request

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-08-01-preview

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

Sample Response

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

Definiciones

LongTermRetentionPolicy

Una directiva de retención a largo plazo.

LongTermRetentionPolicyName

Nombre de la directiva. Siempre debe ser Default.

LongTermRetentionPolicy

Una directiva de retención a largo plazo.

Name Type Description
id
  • string

Identificador del recurso.

name
  • string

Nombre del recurso.

properties.monthlyRetention
  • string

La directiva de retención mensual para una copia de seguridad LTR en un formato ISO 8601.

properties.weekOfYear
  • integer

Semana del año para realizar la copia de seguridad anual en un formato ISO 8601.

properties.weeklyRetention
  • string

La directiva de retención semanal para una copia de seguridad LTR en formato ISO 8601.

properties.yearlyRetention
  • string

Directiva de retención anual para una copia de seguridad ltR en formato ISO 8601.

type
  • string

Tipo de recurso.

LongTermRetentionPolicyName

Nombre de la directiva. Siempre debe ser Default.

Name Type Description
default
  • string