Long Term Retention Policies - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

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-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
policyName	path	True	LongTermRetentionPolicyName	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

Nombre	Tipo	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

Nombre	Tipo	Description
200 OK	LongTermRetentionPolicy	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 LTRNotSupportedForPerDBCMK: la retención de copias de seguridad a largo plazo no se admite cuando cmK de nivel de base de datos está configurado en versión preliminar. 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. 404 OperationIdNotFound: la operación con id. no existe. 409 OperationCancelled: el usuario ha cancelado la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió por otra operación en el mismo recurso. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación y, 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.

Ejemplos

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

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.LongTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.LongTermRetentionPolicyName;

/** Samples for LongTermRetentionPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyCreateOrUpdate
     * .json
     */
    /**
     * Sample code: Create or update the long term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().createOrUpdate("resourceGroup",
            "testserver", "testDatabase", LongTermRetentionPolicyName.DEFAULT, new LongTermRetentionPolicyInner()
                .withWeeklyRetention("P1M").withMonthlyRetention("P1Y").withYearlyRetention("P5Y").withWeekOfYear(5),
            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/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Status code:

202

Definiciones

Nombre	Description
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.

Nombre	Tipo	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.

Nombre	Tipo	Description
default	string