Managed Instance Long Term Retention Policies - List By Database

Servicio:

SQL Database

Versión de la API:

2023-08-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/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies?api-version=2023-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos.
managedInstanceName	path	True	string	Nombre de la instancia administrada.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedInstanceLongTermRetentionPolicyListResult	Se ha obtenido correctamente la directiva LTR para la base de datos administrada.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled: no se admite la habilitación de la retención de copias de seguridad a largo plazo para una base de datos sin servidor si está habilitada la pausa automática. 400 LtrConfigPolicyDuringVldbMigration: no se admite la habilitación de la retención de copias de seguridad a largo plazo para una base de datos durante la migración al nivel de servicio Hiperescala. 400 LtrConfigPolicyDuringVldbReverseMigration: no se admite la habilitación de la retención de copias de seguridad a largo plazo para una base de datos durante una migración inversa desde Hiperescala. 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported: el usuario intentó configurar la directiva de retención de copia de seguridad en una réplica con nombre. 400 LTRNotSupportedForPerDBCMK: la retención de copia de seguridad a largo plazo no se admite cuando cmK de nivel de base de datos está configurado en versión preliminar. 400 LTRHyperscaleSetPolicyError: error al habilitar la retención de copia de seguridad a largo plazo para esta base de datos. Póngase en contacto con el soporte técnico de Microsoft para habilitar la retención de copias de seguridad a largo plazo. 400 LTRArchiveStorageDisabledOnHyperscaleEdition: no se habilita el archivado de copias de seguridad de retención a largo plazo en bases de datos de Hiperescala. 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage: no se admite la configuración de una directiva de retención a largo plazo con el nivel de acceso de almacenamiento de copia de seguridad establecido en "archivo" en el almacenamiento de copia de seguridad con redundancia de zona. Use tipos de almacenamiento con redundancia local o con redundancia geográfica. 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 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ResourceNotFound: no se encontró el recurso solicitado. 409 ConflictingServerOperation - El servidor '{0}' está ocupado con otra operación. Pruebe la operación más adelante.

Ejemplos

Get the long term retention policies for the managed database.

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceLongTermRetentionPolicyListByDatabase.json
// this example is just showing the usage of "ManagedInstanceLongTermRetentionPolicies_ListByDatabase" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedDatabaseResource created on azure
// for more information of creating ManagedDatabaseResource, please refer to the document of ManagedDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testResourceGroup";
string managedInstanceName = "testInstance";
string databaseName = "testDatabase";
ResourceIdentifier managedDatabaseResourceId = ManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName);
ManagedDatabaseResource managedDatabase = client.GetManagedDatabaseResource(managedDatabaseResourceId);

// get the collection of this ManagedInstanceLongTermRetentionPolicyResource
ManagedInstanceLongTermRetentionPolicyCollection collection = managedDatabase.GetManagedInstanceLongTermRetentionPolicies();

// invoke the operation and iterate over the result
await foreach (ManagedInstanceLongTermRetentionPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ManagedInstanceLongTermRetentionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default",
      "name": "default",
      "type": "Microsoft.Sql/resourceGroups/managedInstances/databases/backupLongTermRetentionPolicies",
      "properties": {
        "weeklyRetention": "P1M",
        "monthlyRetention": "P1Y",
        "yearlyRetention": "P5Y",
        "weekOfYear": 5,
        "backupStorageAccessTier": "Archive"
      }
    }
  ]
}

Definiciones

Nombre	Description
BackupStorageAccessTier	BackupStorageAccessTier para las copias de seguridad de LTR
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ManagedInstanceLongTermRetentionPolicy	Una directiva de retención a largo plazo.
ManagedInstanceLongTermRetentionPolicyListResult	Lista de directivas de retención a largo plazo.

BackupStorageAccessTier

Enumeración

BackupStorageAccessTier para las copias de seguridad de LTR

Valor	Description
Archive
Hot

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedInstanceLongTermRetentionPolicy

Object

Una directiva de retención a largo plazo.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.backupStorageAccessTier	BackupStorageAccessTier	BackupStorageAccessTier para las copias de seguridad de LTR
properties.monthlyRetention	string	La directiva de retención mensual para una copia de seguridad LTR en formato ISO 8601.
properties.weekOfYear	integer (int32)	La semana del año para realizar la copia de seguridad anual en 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	La directiva de retención anual para una copia de seguridad LTR en formato ISO 8601.
type	string	Tipo de recurso.

ManagedInstanceLongTermRetentionPolicyListResult

Object

Lista de directivas de retención a largo plazo.

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