Long Term Retention Policies - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Legt die Langfristige Aufbewahrungsrichtlinie einer Datenbank fest.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/default?api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
policyName	path	True	LongTermRetentionPolicyName	Der Richtlinienname. Sollte immer Standard sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.monthlyRetention	string	Die monatliche Aufbewahrungsrichtlinie für eine LTR-Sicherung im ISO 8601-Format.
properties.weekOfYear	integer	Die Woche des Jahres für die jährliche Sicherung im ISO 8601-Format.
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.

Antworten

Name	Typ	Beschreibung
200 OK	LongTermRetentionPolicy	Die Richtlinie wurde erfolgreich festgelegt.
202 Accepted		Akzeptiert
Other Status Codes		Fehlerantworten: *** 400 InvalidResourceRequestBody: Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 400 InvalidParameterValue: Einem Parameter wurde ein ungültiger Wert zugewiesen. 400 LongTermRetentionMissingWeekOfYear - WeekOfYear muss zwischen 1 und 52 festgelegt werden, um die jährliche Aufbewahrung festzulegen. 400 LTRNotSupportedForPerDBCMK: Langfristige Aufbewahrung von Sicherungen wird nicht unterstützt, wenn CMK auf Datenbankebene in der Vorschau konfiguriert ist. 400 LongTermRetentionPolicyNotSupported: Langfristige Aufbewahrung wird in dieser Datenbank nicht unterstützt. 400 LongTermRetentionPolicyInvalid : Richtlinie für langfristige Aufbewahrung ist ungültig. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden. 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden. 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut: Der Vorgang ist timeout und wird automatisch zurückgesetzt. Wiederholen Sie den Vorgang. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Create or update the long term retention policy for the database.

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.LongTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.LongTermRetentionPolicyName;

/** Samples for LongTermRetentionPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyCreateOrUpdate
     * .json
     */
    /**
     * Sample code: Create or update the long term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().createOrUpdate("resourceGroup",
            "testserver", "testDatabase", LongTermRetentionPolicyName.DEFAULT, new LongTermRetentionPolicyInner()
                .withWeeklyRetention("P1M").withMonthlyRetention("P1Y").withYearlyRetention("P5Y").withWeekOfYear(5),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Status code:

202

Definitionen

Name	Beschreibung
LongTermRetentionPolicy	Eine Langfristige Aufbewahrungsrichtlinie.
LongTermRetentionPolicyName	Der Richtlinienname. Sollte immer Standard sein.

LongTermRetentionPolicy

Eine Langfristige Aufbewahrungsrichtlinie.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.monthlyRetention	string	Die monatliche Aufbewahrungsrichtlinie für eine LTR-Sicherung im ISO 8601-Format.
properties.weekOfYear	integer	Die Woche des Jahres für die jährliche Sicherung im ISO 8601-Format.
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	Der Ressourcentyp.

LongTermRetentionPolicyName

Der Richtlinienname. Sollte immer Standard sein.

Name	Typ	Beschreibung
default	string