Managed Instance Long Term Retention Policies - Create Or Update

Služba:

SQL Database

Verze rozhraní API:

2021-11-01

Nastaví zásady dlouhodobého uchovávání spravované databáze.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
managedInstanceName	path	True	string	Název spravované instance.
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	Název zásady. Mělo by být vždy výchozí.
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Typ	Description
properties.monthlyRetention	string	Zásady měsíčního uchovávání záloh LTR ve formátu ISO 8601.
properties.weekOfYear	integer	Týden v roce pro pořízení roční zálohy ve formátu ISO 8601.
properties.weeklyRetention	string	Zásady týdenního uchovávání záloh LTR ve formátu ISO 8601.
properties.yearlyRetention	string	Zásady ročního uchovávání záloh LTR ve formátu ISO 8601.

Odpovědi

Name	Typ	Description
200 OK	ManagedInstanceLongTermRetentionPolicy	Zásady LTR pro spravovanou databázi se úspěšně nastavily.
202 Accepted		Přijato
Other Status Codes		Chybové odpovědi: *** 400 InvalidResourceRequestBody – prostředek nebo vlastnosti prostředku v textu požadavku jsou prázdné nebo neplatné. 400 InvalidParameterValue – parametru byla přidělena neplatná hodnota. 400 LongTermRetentionMissingWeekOfYear – WeekOfYear musí být nastaven mezi 1 a 52, aby bylo možné nastavit roční uchovávání. 400 LTRNotSupportedForPerDBCMK – Dlouhodobé uchovávání záloh se nepodporuje, pokud je klíč CMK na úrovni databáze nakonfigurovaný ve verzi Preview. 400 LongTermRetentionPolicyNotSupported – Tato databáze nepodporuje dlouhodobé uchovávání. 400 LongTermRetentionPolicyInvalid – zásady dlouhodobého uchovávání jsou neplatné. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje. 404 ResourceNotFound – Požadovaný prostředek se nenašel. 404 OperationIdNotFound – operace s ID neexistuje. 409 OperationCancelled – operace byla zrušena uživatelem. 409 OperationInterrupted – Operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací se stejným prostředkem. 429 SubscriptionTooManyCreateUpdateRequests – požadavky nad maximální počet požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – časový limit operace vypršel a automaticky se vrátila zpět. Opakujte operaci. 503 TooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Create or update the LTR policy for the managed database.

Ukázkový požadavek

HTTP

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

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

Java

import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceLongTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.ManagedInstanceLongTermRetentionPolicyName;

/**
 * Samples for ManagedInstanceLongTermRetentionPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceLongTermRetentionPolicyCreateOrUpdate.json
     */
    /**
     * Sample code: Create or update the LTR policy for the managed database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateTheLTRPolicyForTheManagedDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceLongTermRetentionPolicies().createOrUpdate(
            "testResourceGroup", "testInstance", "testDatabase", ManagedInstanceLongTermRetentionPolicyName.DEFAULT,
            new ManagedInstanceLongTermRetentionPolicyInner().withWeeklyRetention("P1M").withMonthlyRetention("P1Y")
                .withYearlyRetention("P5Y").withWeekOfYear(5),
            com.azure.core.util.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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

Definice

Name	Description
ManagedInstanceLongTermRetentionPolicy	Zásady dlouhodobého uchovávání informací.
ManagedInstanceLongTermRetentionPolicyName	Název zásady. Mělo by být vždy výchozí.

ManagedInstanceLongTermRetentionPolicy

Zásady dlouhodobého uchovávání informací.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.monthlyRetention	string	Zásady měsíčního uchovávání záloh LTR ve formátu ISO 8601.
properties.weekOfYear	integer	Týden v roce pro pořízení roční zálohy ve formátu ISO 8601.
properties.weeklyRetention	string	Zásady týdenního uchovávání záloh LTR ve formátu ISO 8601.
properties.yearlyRetention	string	Zásady ročního uchovávání záloh LTR ve formátu ISO 8601.
type	string	Typ prostředku.

ManagedInstanceLongTermRetentionPolicyName

Název zásady. Mělo by být vždy výchozí.

Name	Typ	Description
default	string