Managed Instance Long Term Retention Policies - Get

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft die langfristige Aufbewahrungsrichtlinie einer verwalteten Datenbank ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
managedInstanceName	path	True	string	Der Name der verwalteten Instanz.
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	Der Richtlinienname. Sollte immer "Standard" sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedInstanceLongTermRetentionPolicy	Die LTR-Richtlinie für verwaltete Datenbank wurde erfolgreich erhalten.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled – Aktivieren der langfristigen Sicherungsaufbewahrung für eine serverlose Datenbank wird nicht unterstützt, wenn die automatische Pause aktiviert ist. 400 LtrConfigPolicyDuringVldbMigration – Aktivieren der langfristigen Sicherungsaufbewahrung für eine Datenbank während der Migration zur Hyperscale-Dienstebene wird nicht unterstützt. 400 LtrConfigPolicyDuringVldbReverseMigration – Das Aktivieren einer langfristigen Sicherungsaufbewahrung für eine Datenbank während einer umgekehrten Migration von Hyperscale wird nicht unterstützt. 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported – Benutzer hat versucht, die Sicherungsaufbewahrungsrichtlinie für ein benanntes Replikat zu konfigurieren. 400 LTRNotSupportedForPerDBCMK – Langfristige Sicherungsaufbewahrung wird nicht unterstützt, wenn CMK auf Datenbankebene in der Vorschau konfiguriert ist. 400 LTRHyperscaleSetPolicyError – Fehler beim Aktivieren der langfristigen Sicherungsaufbewahrung für diese Datenbank. Wenden Sie sich an den Microsoft-Support, um die langfristige Aufbewahrung von Sicherungen zu ermöglichen. 400 LTRArchiveStorageDisabledOnHyperscaleEdition – Die Archivierung langfristiger Aufbewahrungssicherungen auf Hyperscale-Datenbanken ist nicht aktiviert. 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage – Das Festlegen einer langfristigen Aufbewahrungsrichtlinie mit der Sicherungsspeicherzugriffsstufe auf "Archiv" wird für den zonenredundanten Sicherungsspeicher nicht unterstützt. Verwenden Sie entweder lokal redundante oder georedundante Speichertypen. 400 LongTermRetentionPolicyNotSupported – Langfristige Aufbewahrung wird für diese Datenbank nicht unterstützt. 400 LongTermRetentionPolicyInvalid – Aufbewahrungsrichtlinie für lange Zeit ist ungültig. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 409 ConflictingServerOperation - Server '{0}' ist mit einem anderen Vorgang beschäftigt. Versuchen Sie es bitte später.

Beispiele

Get the long term retention policy for the managed database.

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default?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/ManagedInstanceLongTermRetentionPolicyGet.json
// this example is just showing the usage of "ManagedInstanceLongTermRetentionPolicies_Get" 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 ManagedInstanceLongTermRetentionPolicyResource created on azure
// for more information of creating ManagedInstanceLongTermRetentionPolicyResource, please refer to the document of ManagedInstanceLongTermRetentionPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testResourceGroup";
string managedInstanceName = "testInstance";
string databaseName = "testDatabase";
ManagedInstanceLongTermRetentionPolicyName policyName = ManagedInstanceLongTermRetentionPolicyName.Default;
ResourceIdentifier managedInstanceLongTermRetentionPolicyResourceId = ManagedInstanceLongTermRetentionPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName, policyName);
ManagedInstanceLongTermRetentionPolicyResource managedInstanceLongTermRetentionPolicy = client.GetManagedInstanceLongTermRetentionPolicyResource(managedInstanceLongTermRetentionPolicyResourceId);

// invoke the operation
ManagedInstanceLongTermRetentionPolicyResource result = await managedInstanceLongTermRetentionPolicy.GetAsync();

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
BackupStorageAccessTier	BackupStorageAccessTier für die LTR-Sicherungen
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedInstanceLongTermRetentionPolicy	Eine langfristige Aufbewahrungsrichtlinie.
ManagedInstanceLongTermRetentionPolicyName	Der Richtlinienname. Sollte immer "Standard" sein.

BackupStorageAccessTier

Enumeration

BackupStorageAccessTier für die LTR-Sicherungen

Wert	Beschreibung
Archive
Hot

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ManagedInstanceLongTermRetentionPolicy

Objekt

Eine langfristige Aufbewahrungsrichtlinie.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.backupStorageAccessTier	BackupStorageAccessTier	BackupStorageAccessTier für die LTR-Sicherungen
properties.monthlyRetention	string	Die monatliche Aufbewahrungsrichtlinie für eine LTR-Sicherung im ISO 8601-Format.
properties.weekOfYear	integer (int32)	Die Woche des Jahres, um die jährliche Sicherung im ISO 8601-Format zu übernehmen.
properties.weeklyRetention	string	Die wöchentliche Aufbewahrungsrichtlinie für eine LTR-Sicherung im ISO 8601-Format.
properties.yearlyRetention	string	Die jährliche Aufbewahrungsrichtlinie für eine LTR-Sicherung im ISO 8601-Format.
type	string	Ressourcentyp.

ManagedInstanceLongTermRetentionPolicyName

Enumeration

Der Richtlinienname. Sollte immer "Standard" sein.

Wert	Beschreibung
default