Long Term Retention Backups - Change Access Tier By Resource Group

Referencia

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Cambiar un nivel de acceso de copia de seguridad de retención a largo plazo.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/changeAccessTier?api-version=2023-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
backupName	path	True	string
locationName	path	True	string
longTermRetentionDatabaseName	path	True	string
longTermRetentionServerName	path	True	string
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
backupStorageAccessTier	True	string	Nivel de acceso de almacenamiento de copia de seguridad de retención a largo plazo
operationMode	True	string	Modo de operación al actualizar el nivel de acceso de almacenamiento de copia de seguridad ltr

Respuestas

Nombre	Tipo	Description
200 OK	LongTermRetentionBackup	Se ha cambiado correctamente el nivel de acceso de copia de seguridad de retención a largo plazo.
202 Accepted		Aceptado Encabezados Location: string
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 InvalidLongTermRetentionBackupId: identificador de copia de seguridad de retención a largo plazo no válido para bases de datos SQL. 400 InvalidParameterValue: se ha proporcionado un valor no válido a un parámetro. 400 LongTermRetentionMismatchingSubscriptionId: el identificador de suscripción proporcionado no coincide con el identificador de la otra entrada. 400 LongTermRetentionMismatchingResourceGroupName: el nombre del grupo de recursos proporcionado no coincide con el nombre de la otra entrada. 400 LongTermRetentionMismatchingServerName: el nombre del servidor proporcionado no coincide con el nombre en la otra entrada. 400 DeleteLtrSubscriptionMissing: el identificador de suscripción es necesario para eliminar una copia de seguridad de retención a largo plazo. 400 DeleteLtrServerMissing: el nombre del servidor es necesario para eliminar una copia de seguridad de retención a largo plazo. 400 DeleteLtrDatabaseMissing: el nombre de la base de datos es necesario para eliminar una copia de seguridad de retención a largo plazo. 400 LtrBackupResourceIdIncorrect: el identificador de recurso de copia de seguridad de retención a largo plazo proporcionado o el nombre de copia de seguridad son incorrectos. 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage: no se admite el archivado de copias de seguridad de retención a largo plazo en el almacenamiento de copia de seguridad con redundancia de zona. En su lugar, use tipos de almacenamiento con redundancia local o con redundancia geográfica. 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing: el identificador de suscripción es necesario para actualizar la copia de seguridad de retención a largo plazo. 400 UpdateBackupStorageAccessTierLtrServerMissing: el nombre del servidor es necesario para actualizar la copia de seguridad de retención a largo plazo. 400 UpdateBackupStorageAccessTierLtrDatabaseMissing: el nombre de la base de datos es necesario para actualizar la copia de seguridad de retención a largo plazo. 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect: el identificador de recurso de copia de seguridad de retención a largo plazo proporcionado o el nombre de copia de seguridad son incorrectos. 400 LongTermRetentionMigrationRequestNotSupported: no se permite la característica de migración de copia de seguridad de LTR. 400 LongTermRetentionMigrationCrossClusterRequestNotSupported: las suscripciones de origen y destino no pueden comunicarse con la característica de copia de seguridad de LTR. 400 LongTermRetentionMigrationParameterMissing: falta el parámetro requerido para la operación. 400 LongTermRetentionMigrationSameServerNotSupported: la característica de copia LTR no se admite para copiar copias de seguridad de LTR en el mismo servidor. 400 LongTermRetentionMigrationTargetServerNotFound: el servidor de destino no existe o no está listo para la operación de copia de seguridad de LTR. 400 LongTermRetentionMigrationTargetDatabaseNotFound: la base de datos de destino no existe en el servidor. 400 LongTermRetentionMigrationStorageTypeNotSupported: la redundancia de almacenamiento de copia de seguridad especificada no se admite en la región de destino. 400 LongTermRetentionMigrationStorageMismatch: la redundancia de copia de seguridad activa de la base de datos no coincide con la redundancia de copia de seguridad solicitada por el cliente. 400 LtrOperationFailedBackupImmutable: se produjo un error al eliminar la copia de seguridad de retención a largo plazo porque la copia de seguridad es inmutable. 400 LongTermRetentionMigrationDatabaseTypeNotSupported: la migración de LTR solo se admite para las copias de seguridad de LTR de Azure SQL DB y instancia administrada. 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed: no se permite cambiar la redundancia de almacenamiento de copia de seguridad para las operaciones de copia de LTR. 400 LtrRestoreFailedArchiveStorageTier: no se admite la restauración de la copia de seguridad de retención a largo plazo archivada. La restauración solo se puede realizar en copias de seguridad de retención rehidratadas o periódicas a largo plazo. 400 LtrArchiveStorageTierNotEnabled: las copias de seguridad de retención a largo plazo de archivado no están habilitadas. 400 LtrArchiveWrongParameters: ChangeLongTermRetentionBackupAccessTier no se admite para la combinación deseada (backupStorageAccessTier, operationMode). Solo se permiten (Archivar, Mover) y (Frecuente, Copiar). 400 LTRArchiveRedundancyChangeFailed: no se admite la actualización del tipo de redundancia de almacenamiento de copia de seguridad al almacenamiento con redundancia de zona cuando se establece una directiva de retención a largo plazo con el nivel de acceso de almacenamiento de copia de seguridad "archivo". 400 LongTermRetentionMigrationSubscriptionNotFound: no se encontró la suscripción. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 LongTermRetentionMigrationBackupNotFound: la copia de seguridad de LTR especificada no existe. 404 OperationIdNotFound: la operación con id. no existe. 409 LongTermRetentionMigrationRequestConflict: una operación de conflicto en esta copia de seguridad ltR todavía está en curso. 409 LongTermRetentionMigrationBackupConflict: existe otra copia de seguridad ltR con el mismo tiempo de copia de seguridad para la base de datos de destino. 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 LongTermRetentionMigrationRequestFailedToStartOnTarget: no se pudo iniciar la solicitud de copia de seguridad ltR en la región de destino. 500 LongTermRetentionMigrationRequestCopyFailed: error en la operación de copia de seguridad para blobs de copia de seguridad ltr. 500 LongTermRetentionMigrationRestoreVerExceeded: se produjo un error en la comprobación de la restauración después de alcanzar los intentos máximos. 500 LongTermRetentionMigrationRestoreVerFailed: error en la comprobación de la restauración. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Nombre

Tipo

Description

200 OK

LongTermRetentionBackup

Se ha cambiado correctamente el nivel de acceso de copia de seguridad de retención a largo plazo.

202 Accepted

Aceptado

Encabezados

Location: string

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 InvalidLongTermRetentionBackupId: identificador de copia de seguridad de retención a largo plazo no válido para bases de datos SQL.
400 InvalidParameterValue: se ha proporcionado un valor no válido a un parámetro.
400 LongTermRetentionMismatchingSubscriptionId: el identificador de suscripción proporcionado no coincide con el identificador de la otra entrada.
400 LongTermRetentionMismatchingResourceGroupName: el nombre del grupo de recursos proporcionado no coincide con el nombre de la otra entrada.
400 LongTermRetentionMismatchingServerName: el nombre del servidor proporcionado no coincide con el nombre en la otra entrada.
400 DeleteLtrSubscriptionMissing: el identificador de suscripción es necesario para eliminar una copia de seguridad de retención a largo plazo.
400 DeleteLtrServerMissing: el nombre del servidor es necesario para eliminar una copia de seguridad de retención a largo plazo.
400 DeleteLtrDatabaseMissing: el nombre de la base de datos es necesario para eliminar una copia de seguridad de retención a largo plazo.
400 LtrBackupResourceIdIncorrect: el identificador de recurso de copia de seguridad de retención a largo plazo proporcionado o el nombre de copia de seguridad son incorrectos.
400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage: no se admite el archivado de copias de seguridad de retención a largo plazo en el almacenamiento de copia de seguridad con redundancia de zona. En su lugar, use tipos de almacenamiento con redundancia local o con redundancia geográfica.
400 UpdateBackupStorageAccessTierLtrSubscriptionMissing: el identificador de suscripción es necesario para actualizar la copia de seguridad de retención a largo plazo.
400 UpdateBackupStorageAccessTierLtrServerMissing: el nombre del servidor es necesario para actualizar la copia de seguridad de retención a largo plazo.
400 UpdateBackupStorageAccessTierLtrDatabaseMissing: el nombre de la base de datos es necesario para actualizar la copia de seguridad de retención a largo plazo.
400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect: el identificador de recurso de copia de seguridad de retención a largo plazo proporcionado o el nombre de copia de seguridad son incorrectos.
400 LongTermRetentionMigrationRequestNotSupported: no se permite la característica de migración de copia de seguridad de LTR.
400 LongTermRetentionMigrationCrossClusterRequestNotSupported: las suscripciones de origen y destino no pueden comunicarse con la característica de copia de seguridad de LTR.
400 LongTermRetentionMigrationParameterMissing: falta el parámetro requerido para la operación.
400 LongTermRetentionMigrationSameServerNotSupported: la característica de copia LTR no se admite para copiar copias de seguridad de LTR en el mismo servidor.
400 LongTermRetentionMigrationTargetServerNotFound: el servidor de destino no existe o no está listo para la operación de copia de seguridad de LTR.
400 LongTermRetentionMigrationTargetDatabaseNotFound: la base de datos de destino no existe en el servidor.
400 LongTermRetentionMigrationStorageTypeNotSupported: la redundancia de almacenamiento de copia de seguridad especificada no se admite en la región de destino.
400 LongTermRetentionMigrationStorageMismatch: la redundancia de copia de seguridad activa de la base de datos no coincide con la redundancia de copia de seguridad solicitada por el cliente.
400 LtrOperationFailedBackupImmutable: se produjo un error al eliminar la copia de seguridad de retención a largo plazo porque la copia de seguridad es inmutable.
400 LongTermRetentionMigrationDatabaseTypeNotSupported: la migración de LTR solo se admite para las copias de seguridad de LTR de Azure SQL DB y instancia administrada.
400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed: no se permite cambiar la redundancia de almacenamiento de copia de seguridad para las operaciones de copia de LTR.
400 LtrRestoreFailedArchiveStorageTier: no se admite la restauración de la copia de seguridad de retención a largo plazo archivada. La restauración solo se puede realizar en copias de seguridad de retención rehidratadas o periódicas a largo plazo.
400 LtrArchiveStorageTierNotEnabled: las copias de seguridad de retención a largo plazo de archivado no están habilitadas.
400 LtrArchiveWrongParameters: ChangeLongTermRetentionBackupAccessTier no se admite para la combinación deseada (backupStorageAccessTier, operationMode). Solo se permiten (Archivar, Mover) y (Frecuente, Copiar).
400 LTRArchiveRedundancyChangeFailed: no se admite la actualización del tipo de redundancia de almacenamiento de copia de seguridad al almacenamiento con redundancia de zona cuando se establece una directiva de retención a largo plazo con el nivel de acceso de almacenamiento de copia de seguridad "archivo".
400 LongTermRetentionMigrationSubscriptionNotFound: no se encontró la suscripción.
404 ResourceNotFound: no se encontró el recurso solicitado.
404 LongTermRetentionMigrationBackupNotFound: la copia de seguridad de LTR especificada no existe.
404 OperationIdNotFound: la operación con id. no existe.
409 LongTermRetentionMigrationRequestConflict: una operación de conflicto en esta copia de seguridad ltR todavía está en curso.
409 LongTermRetentionMigrationBackupConflict: existe otra copia de seguridad ltR con el mismo tiempo de copia de seguridad para la base de datos de destino.
409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar.
409 OperationCancelled: el usuario canceló la operación.
409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso.
429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.
429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
500 LongTermRetentionMigrationRequestFailedToStartOnTarget: no se pudo iniciar la solicitud de copia de seguridad ltR en la región de destino.
500 LongTermRetentionMigrationRequestCopyFailed: error en la operación de copia de seguridad para blobs de copia de seguridad ltr.
500 LongTermRetentionMigrationRestoreVerExceeded: se produjo un error en la comprobación de la restauración después de alcanzar los intentos máximos.
500 LongTermRetentionMigrationRestoreVerFailed: error en la comprobación de la restauración.
500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación.
503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

Change the long term retention backup storage access tier for a resource group.

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/serverName/longTermRetentionDatabases/databaseName/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive/changeAccessTier?api-version=2023-08-01

{
  "backupStorageAccessTier": "Hot",
  "operationMode": "Copy"
}

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/ResourceGroupBasedChangeLongTermRetentionBackupAccessTier.json
// this example is just showing the usage of "LongTermRetentionBackups_ChangeAccessTierByResourceGroup" 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 ResourceGroupLongTermRetentionBackupResource created on azure
// for more information of creating ResourceGroupLongTermRetentionBackupResource, please refer to the document of ResourceGroupLongTermRetentionBackupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "resourceGroupName";
AzureLocation locationName = new AzureLocation("japaneast");
string longTermRetentionServerName = "serverName";
string longTermRetentionDatabaseName = "databaseName";
string backupName = "55555555-6666-7777-8888-999999999999;131637960820000000;Archive";
ResourceIdentifier resourceGroupLongTermRetentionBackupResourceId = ResourceGroupLongTermRetentionBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName);
ResourceGroupLongTermRetentionBackupResource resourceGroupLongTermRetentionBackup = client.GetResourceGroupLongTermRetentionBackupResource(resourceGroupLongTermRetentionBackupResourceId);

// invoke the operation
ChangeLongTermRetentionBackupAccessTierParameters changeLongTermRetentionBackupAccessTierParameters = new ChangeLongTermRetentionBackupAccessTierParameters("Hot", "Copy");
ArmOperation<ResourceGroupLongTermRetentionBackupResource> lro = await resourceGroupLongTermRetentionBackup.ChangeAccessTierByResourceGroupAsync(WaitUntil.Completed, changeLongTermRetentionBackupAccessTierParameters);
ResourceGroupLongTermRetentionBackupResource result = lro.Value;

// the variable result 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
LongTermRetentionBackupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/serverName/longTermRetentionDatabases/databaseName/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "name": "55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups",
  "properties": {
    "serverName": "serverName",
    "serverCreateTime": "2017-09-06T08:00:00Z",
    "databaseName": "databaseName",
    "databaseDeletionTime": null,
    "backupTime": "2017-09-06T08:00:00Z",
    "backupExpirationTime": null,
    "backupStorageRedundancy": "Geo"
  }
}

status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/serverName/longTermRetentionDatabases/databaseName/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive/operations/55555555-6666-7777-8888-999999999999?api-version=2023-05-01-preview

Definiciones

Nombre	Description
BackupStorageAccessTier	BackupStorageAccessTier para la copia de seguridad de LTR
BackupStorageRedundancy	El tipo de redundancia de almacenamiento de la copia de seguridad copiada
ChangeLongTermRetentionBackupAccessTierParameters	Contiene la información necesaria para cambiar el nivel de acceso de copia de seguridad de retención a largo plazo y el modo de operación relacionado.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LongTermRetentionBackup	Una copia de seguridad de retención a largo plazo.

BackupStorageAccessTier

Enumeración

BackupStorageAccessTier para la copia de seguridad de LTR

Valor	Description
Archive
Hot

BackupStorageRedundancy

Enumeración

El tipo de redundancia de almacenamiento de la copia de seguridad copiada

Valor	Description
Geo
GeoZone
Local
Zone

ChangeLongTermRetentionBackupAccessTierParameters

Object

Contiene la información necesaria para cambiar el nivel de acceso de copia de seguridad de retención a largo plazo y el modo de operación relacionado.

Nombre	Tipo	Description
backupStorageAccessTier	string	Nivel de acceso de almacenamiento de copia de seguridad de retención a largo plazo
operationMode	string	Modo de operación al actualizar el nivel de acceso de almacenamiento de copia de seguridad ltr

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.