Long Term Retention Backups - Change Access Tier By Resource Group

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Hosszú távú adatmegőrzési biztonsági mentés hozzáférési szintjének módosítása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
backupName	path	True	string
locationName	path	True	string
longTermRetentionDatabaseName	path	True	string
longTermRetentionServerName	path	True	string
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
backupStorageAccessTier	True	string	A hosszú távú adatmegőrzési biztonsági mentés tárolási hozzáférési szintje
operationMode	True	string	A műveleti mód az ltr biztonsági mentési tár hozzáférési szintjének frissítésekor

Válaszok

Name	Típus	Description
200 OK	LongTermRetentionBackup	Sikeresen módosította a hosszú távú adatmegőrzési biztonsági mentés hozzáférési szintjét.
202 Accepted		Elfogadott Fejlécek Location: string
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 InvalidLongTermRetentionBackupId – Érvénytelen hosszú távú adatmegőrzési biztonsági mentés azonosítója az SQL-adatbázisokhoz. 400 InvalidParameterValue – Érvénytelen értéket adott meg egy paraméter. 400 LongTermRetentionMismatchingSubscriptionId – A megadott előfizetés-azonosító nem felelt meg a másik bemenet azonosítójának 400 LongTermRetentionMismatchingResourceGroupName – A megadott erőforráscsoport neve nem egyezett a másik bemenetben megadott névvel 400 LongTermRetentionMismatchingServerName – A megadott kiszolgálónév nem egyezett a másik bemenetben megadott névvel 400 DeleteLtrSubscriptionMissing – Az előfizetés azonosítója szükséges egy hosszú távú adatmegőrzési biztonsági mentés törléséhez. 400 DeleteLtrServerMissing – A kiszolgálónév szükséges a hosszú távú adatmegőrzési biztonsági mentés törléséhez. 400 DeleteLtrDatabaseMissing – A hosszú távú adatmegőrzési biztonsági mentés törléséhez az adatbázis neve szükséges. 400 LtrBackupResourceIdIncorrect – A megadott hosszú távú megőrzési biztonsági mentési erőforrás-azonosító vagy biztonsági mentés neve helytelen. 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage – A zónaredundáns biztonsági másolatok hosszú távú adatmegőrzési biztonsági másolatainak archiválása nem támogatott. Használjon helyileg redundáns vagy georedundáns tárolási típusokat. 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing – A hosszú távú megőrzési biztonsági mentés frissítéséhez az előfizetés azonosítója szükséges. 400 UpdateBackupStorageAccessTierLtrServerMissing – A hosszú távú megőrzési biztonsági mentés frissítéséhez a kiszolgáló neve szükséges. 400 UpdateBackupStorageAccessTierLtrDatabaseMissing – A hosszú távú megőrzési biztonsági mentés frissítéséhez az adatbázis neve szükséges. 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect – A megadott hosszú távú megőrzési biztonsági mentési erőforrás-azonosító vagy biztonsági mentés neve helytelen. 400 LongTermRetentionMigrationRequestNotSupported – Az előfizetés nem engedélyezett LTR biztonsági mentési migrálási funkció. 400 LongTermRetentionMigrationCrossClusterRequestNotSupported – A forrás- és cél-előfizetések nem kommunikálhatnak az LTR biztonsági mentési másolási funkciójával. 400 LongTermRetentionMigrationParameterMissing – A művelethez szükséges paraméter hiányzik. 400 LongTermRetentionMigrationSameServerNotSupported – Az LTR másolási funkció nem támogatott az LTR biztonsági másolatainak másolásához ugyanazon a kiszolgálón. 400 LongTermRetentionMigrationTargetServerNotFound – A célkiszolgáló nem létezik, vagy nem áll készen az LTR biztonsági mentési másolási műveletére. 400 LongTermRetentionMigrationTargetDatabaseNotFound – A céladatbázis nem létezik a kiszolgálón. 400 LongTermRetentionMigrationStorageTypeNotSupported – A célrégióban a megadott biztonsági mentési tár redundancia nem támogatott. 400 LongTermRetentionMigrationStorageMismatch – Az adatbázis aktív biztonsági mentési redundanciái nem egyeznek az ügyfél által kért biztonsági mentési redundanciával. 400 LtrOperationFailedBackupImmutable – A hosszú távú megőrzési biztonsági mentés törlése nem sikerült, mert a biztonsági mentés nem módosítható. 400 LongTermRetentionMigrationDatabaseTypeNotSupported – Az LTR-migrálás csak felügyelt példányokhoz és Azure SQL DB LTR-biztonsági mentésekhez támogatott. 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed – A biztonsági mentési tár redundanciának módosítása nem engedélyezett az LTR másolási műveletekhez. 400 LtrRestoreFailedArchiveStorageTier – Az archivált hosszú távú megőrzési biztonsági mentés visszaállítása nem támogatott. A visszaállítás csak rehidratált vagy rendszeres, hosszú távú megőrzési biztonsági mentések esetén végezhető el. 400 LtrArchiveStorageTierNotEnabled – A hosszú távú adatmegőrzési biztonsági másolatok archiválása nincs engedélyezve. 400 LtrArchiveWrongParameters – A ChangeLongTermRetentionBackupAccessTier nem támogatott a kívánt (backupStorageAccessTier, operationMode) kombinációhoz. Csak (archiválás, áthelyezés) és (gyakori elérésű, másolás) engedélyezett. 400 LTRArchiveRedundancyChangeFailed – A biztonsági mentési tár redundanciatípusának zónaredundáns tárolásra való frissítése nem támogatott, ha hosszú távú adatmegőrzési szabályzat van beállítva az "archív" biztonsági mentési tár hozzáférési rétegével 400 LongTermRetentionMigrationSubscriptionNotFound – Az előfizetés nem található. 404 ResourceNotFound – A kért erőforrás nem található. 404 LongTermRetentionMigrationBackupNotFound – A megadott LTR biztonsági mentés nem létezik. 404 OperationIdNotFound – Az azonosítóval rendelkező művelet nem létezik. 409 LongTermRetentionMigrationRequestConflict – Az LTR biztonsági mentés ütközési művelete még folyamatban van. 409 LongTermRetentionMigrationBackupConflict – Létezik egy másik LTR-biztonsági mentés, amely azonos biztonsági mentési időt biztosít a céladatbázishoz. 409 CannotCancelOperation – A felügyeleti művelet olyan állapotban van, amely nem törölhető. 409 OperationCancelled – A felhasználó megszakította a műveletet. 409 OperationInterrupted – Az erőforráson lévő művelet nem hajtható végre, mert egy másik művelet megszakította ugyanazon az erőforráson. 429 SubscriptionTooManyCreateUpdateRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések. 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 500 LongTermRetentionMigrationRequestFailedToStartOnTarget – Nem sikerült elindítani az LTR biztonsági mentési másolási kérését a célrégióban. 500 LongTermRetentionMigrationRequestCopyFailed – A másolási művelet nem sikerült az LTR biztonsági mentési blobok esetében. 500 LongTermRetentionMigrationRestoreVerExceed – A visszaállítás ellenőrzése sikertelen volt a maximális kísérletek elérése után. 500 LongTermRetentionMigrationRestoreVerFailed – A visszaállítás ellenőrzése nem sikerült. 500 OperationTimedOut – A művelet túllépte az időkorlátot, és automatikusan visszagördült. Próbálkozzon újra a művelettel. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések.

Példák

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

Mintakérelem

HTTP

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

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

Mintaválasz

Állapotkód:

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

Állapotkód:

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

Definíciók

Name	Description
BackupStorageAccessTier	A BackupStorageAccessTier az LTR biztonsági mentéséhez
BackupStorageRedundancy	A másolt biztonsági másolat tárolási redundanciatípusa
ChangeLongTermRetentionBackupAccessTierParameters	A hosszú távú adatmegőrzési biztonsági mentés hozzáférési szintjének és a kapcsolódó műveleti módnak a módosításához szükséges információkat tartalmazza.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
LongTermRetentionBackup	Hosszú távú megőrzési biztonsági mentés.

BackupStorageAccessTier

Enumerálás

A BackupStorageAccessTier az LTR biztonsági mentéséhez

Érték	Description
Archive
Hot

BackupStorageRedundancy

Enumerálás

A másolt biztonsági másolat tárolási redundanciatípusa

Érték	Description
Geo
GeoZone
Local
Zone

ChangeLongTermRetentionBackupAccessTierParameters

Objektum

A hosszú távú adatmegőrzési biztonsági mentés hozzáférési szintjének és a kapcsolódó műveleti módnak a módosításához szükséges információkat tartalmazza.

Name	Típus	Description
backupStorageAccessTier	string	A hosszú távú adatmegőrzési biztonsági mentés tárolási hozzáférési szintje
operationMode	string	A műveleti mód az ltr biztonsági mentési tár hozzáférési szintjének frissítésekor

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

LongTermRetentionBackup

Objektum

Hosszú távú megőrzési biztonsági mentés.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.backupExpirationTime	string (date-time)	A hosszú távú megőrzési biztonsági mentés lejárati ideje.
properties.backupStorageAccessTier	BackupStorageAccessTier	A BackupStorageAccessTier az LTR biztonsági mentéséhez
properties.backupStorageRedundancy	BackupStorageRedundancy	A biztonsági mentés tárolási redundanciatípusa
properties.backupTime	string (date-time)	A biztonsági másolat készítésének időpontja
properties.databaseDeletionTime	string (date-time)	Az adatbázis törlési ideje
properties.databaseName	string	Annak az adatbázisnak a neve, amelyhez a biztonsági másolat tartozik
properties.isBackupImmutable	boolean	A beállítás, hogy az LTR biztonsági mentése nem módosítható-e
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	A biztonsági mentés tárolási redundanciatípusa
properties.serverCreateTime	string (date-time)	A kiszolgáló létrehozási ideje.
properties.serverName	string	A kiszolgáló neve, amelyhez a biztonsági mentési adatbázis tartozik.
type	string	Erőforrás típusa.