Managed Instance Long Term Retention Policies - List By Database

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Lekéri egy adatbázis hosszú távú adatmegőrzési szabályzatát.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies?api-version=2023-08-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
databaseName	path	True	string	Az adatbázis neve.
managedInstanceName	path	True	string	A felügyelt példány neve.
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ó.

Válaszok

Name	Típus	Description
200 OK	ManagedInstanceLongTermRetentionPolicyListResult	Sikeresen lekérte az LTR-szabályzatot a felügyelt adatbázishoz.
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 ManagedInstanceStoppingOrStopped – Ütköző művelet van elküldve, miközben a példány leáll/leállított állapotban van 400 ManagedInstanceStarting – Ütköző művelet küldve, miközben a példány kezdő állapotban van 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled – A kiszolgáló nélküli adatbázisok hosszú távú biztonsági mentésének engedélyezése nem támogatott, ha az automatikus szüneteltetés engedélyezve van. 400 LtrConfigPolicyDuringVldbMigration – A rugalmas skálázási szolgáltatási szintre való migrálás során nem támogatott az adatbázisok hosszú távú biztonsági mentésének megőrzése. 400 LtrConfigPolicyDuringVldbReverseMigration – Nem támogatott az adatbázisok hosszú távú biztonsági mentésének megőrzése a rugalmas skálázásról való fordított migrálás során. 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported – A felhasználó megkísérelte konfigurálni a biztonsági mentés adatmegőrzési szabályzatát egy elnevezett replikán. 400 LTRNotSupportedForPerDBCMK – A hosszú távú biztonsági mentés megőrzése nem támogatott, ha az adatbázisszintű CMK előzetes verzióban van konfigurálva. 400 LTRHyperscaleSetPolicyError – Hiba történt az adatbázis hosszú távú biztonsági mentésének engedélyezése során. Forduljon a Microsoft ügyfélszolgálatához a biztonsági mentés hosszú távú megőrzésének engedélyezéséhez. 400 LTRArchiveStorageDisabledOnHyperscaleEdition – A rugalmas skálázású adatbázisok hosszú távú adatmegőrzési biztonsági másolatainak archiválása nincs engedélyezve. 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage – A zónaredundáns biztonsági mentési tárterületen nem támogatott a hosszú távú adatmegőrzési szabályzat beállítása az "archív" biztonsági mentési szinttel. Használjon helyileg redundáns vagy georedundáns tárolási típusokat. 400 LongTermRetentionPolicyNotSupported – A hosszú távú megőrzés nem támogatott ezen az adatbázisban. 400 LongTermRetentionPolicyInvalid – A hosszú távú adatmegőrzési szabályzat érvénytelen. 404 ServerNotInSubscriptionResourceGroup – A megadott kiszolgáló nem létezik a megadott erőforráscsoportban és -előfizetésben. 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található 404 ResourceNotFound – A kért erőforrás nem található. 409 ConflictingServerOperation – A kiszolgáló{0}egy másik művelettel van elfoglalva. Próbálkozzon később a művelettel.

Példák

Get the long term retention policies for the managed database.

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
BackupStorageAccessTier	A BackupStorageAccessTier az LTR-biztonsági mentésekhez
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedInstanceLongTermRetentionPolicy	Hosszú távú adatmegőrzési szabályzat.
ManagedInstanceLongTermRetentionPolicyListResult	A hosszú távú adatmegőrzési szabályzatok listája.

BackupStorageAccessTier

Enumerálás

A BackupStorageAccessTier az LTR-biztonsági mentésekhez

Érték	Description
Archive
Hot

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.

ManagedInstanceLongTermRetentionPolicy

Objektum

Hosszú távú adatmegőrzési szabályzat.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.backupStorageAccessTier	BackupStorageAccessTier	A BackupStorageAccessTier az LTR-biztonsági mentésekhez
properties.monthlyRetention	string	Az ISO 8601 formátumú LTR biztonsági mentések havi megőrzési szabályzata.
properties.weekOfYear	integer (int32)	Az év hetében iso 8601 formátumban kell készíteni az éves biztonsági mentést.
properties.weeklyRetention	string	Az ISO 8601 formátumú LTR biztonsági mentés heti adatmegőrzési szabályzata.
properties.yearlyRetention	string	Az iso 8601 formátumú LTR biztonsági mentések éves adatmegőrzési szabályzata.
type	string	Erőforrás típusa.

ManagedInstanceLongTermRetentionPolicyListResult

Objektum

A hosszú távú adatmegőrzési szabályzatok listája.

Name	Típus	Description
nextLink	string	Hivatkozás az eredmények következő oldalának lekéréséhez.
value	ManagedInstanceLongTermRetentionPolicy[]	Eredménytömb.