Managed Instance Long Term Retention Policies - Create Or Update

Tjänst:

SQL Database

API-version:

2021-11-01

Anger en hanterad databass princip för långsiktig kvarhållning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen.
managedInstanceName	path	True	string	Namnet på den hanterade instansen.
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	Principnamnet. Bör alltid vara Standard.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Typ	Description
properties.monthlyRetention	string	Den månatliga kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.
properties.weekOfYear	integer	Veckan på året som den årliga säkerhetskopieringen ska ske i ISO 8601-format.
properties.weeklyRetention	string	Den veckovisa kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.
properties.yearlyRetention	string	Den årliga kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.

Svar

Name	Typ	Description
200 OK	ManagedInstanceLongTermRetentionPolicy	Ltr-principen har ställts in för hanterad databas.
202 Accepted		Har godkänts
Other Status Codes		Felsvar: *** 400 InvalidResourceRequestBody – Resurs- eller resursegenskaperna i begärandetexten är tomma eller ogiltiga. 400 InvalidParameterValue – ett ogiltigt värde angavs för en parameter. 400 LongTermRetentionMissingWeekOfYear – WeekOfYear måste anges mellan 1 och 52 för att ange årlig kvarhållning. 400 LTRNotSupportedForPerDBCMK – Långsiktig kvarhållning av säkerhetskopior stöds inte när CMK på databasnivå konfigureras i förhandsversion. 400 LongTermRetentionPolicyNotSupported – Långsiktig kvarhållning stöds inte i den här databasen. 400 LongTermRetentionPolicyInvalid – Principen för långsiktig kvarhållning är ogiltig. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 OperationIdNotFound – åtgärden med ID finns inte. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 OperationInterrupted – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök att utföra åtgärden igen. 503 TooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Create or update the LTR policy for the managed database.

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

202

Definitioner

Name	Description
ManagedInstanceLongTermRetentionPolicy	En princip för långsiktig kvarhållning.
ManagedInstanceLongTermRetentionPolicyName	Principnamnet. Bör alltid vara Standard.

ManagedInstanceLongTermRetentionPolicy

En princip för långsiktig kvarhållning.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.monthlyRetention	string	Den månatliga kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.
properties.weekOfYear	integer	Veckan på året som den årliga säkerhetskopieringen ska ske i ISO 8601-format.
properties.weeklyRetention	string	Den veckovisa kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.
properties.yearlyRetention	string	Den årliga kvarhållningsprincipen för en LTR-säkerhetskopiering i ISO 8601-format.
type	string	Resurstyp.

ManagedInstanceLongTermRetentionPolicyName

Principnamnet. Bör alltid vara Standard.

Name	Typ	Description
default	string