Long Term Retention Policies - List By Database

Servicio:

SQL Database

Versión de la API:

2021-11-01

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

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

Respuestas

Nombre	Tipo	Description
200 OK	LongTermRetentionPolicyListResult	Obtenga correctamente la directiva.
Other Status Codes		Respuestas de error: *** 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.

Ejemplos

Get the long term retention policy for the database.

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for LongTermRetentionPolicies ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyListByDatabase
     * .json
     */
    /**
     * Sample code: Get the long term retention policy for the database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().listByDatabase("resourceGroup",
            "testserver", "testDatabase", com.azure.core.util.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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "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

Nombre	Description
LongTermRetentionPolicy	Una directiva de retención a largo plazo.
LongTermRetentionPolicyListResult	Lista de directivas de retención a largo plazo.

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.

LongTermRetentionPolicyListResult

Lista de directivas de retención a largo plazo.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	LongTermRetentionPolicy[]	Matriz de resultados.