你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Managed Instance Long Term Retention Policies - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

设置托管数据库的长期保留策略。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
managedInstanceName	path	True	string	托管实例的名称。
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	策略名称。 应始终为 Default。
resourceGroupName	path	True	string	包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	用于标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

请求正文

名称	类型	说明
properties.monthlyRetention	string	采用 ISO 8601 格式的 LTR 备份的每月保留策略。
properties.weekOfYear	integer	采用 ISO 8601 格式的年度备份的一年中的一周。
properties.weeklyRetention	string	采用 ISO 8601 格式的 LTR 备份的每周保留策略。
properties.yearlyRetention	string	采用 ISO 8601 格式的 LTR 备份的年度保留策略。

响应

名称	类型	说明
200 OK	ManagedInstanceLongTermRetentionPolicy	已成功为托管数据库设置 LTR 策略。
202 Accepted		已接受
Other Status Codes		错误响应：*** 400 InvalidResourceRequestBody - 请求正文中的资源或资源属性为空或无效。 400 InvalidParameterValue - 为参数提供了无效值。 400 LongTermRetentionMissingWeekOfYear - WeekOfYear 需要设置为介于 1 到 52 之间才能设置年度保留期。 400 LTRNotSupportedForPerDBCMK - 在预览版中配置数据库级 CMK 时，不支持长期备份保留。 400 LongTermRetentionPolicyNotSupported - 此数据库不支持长期保留。 400 LongTermRetentionPolicyInvalid - 长期保留策略无效。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 ServerNotInSubscriptionResourceGroup - 指定的服务器不存在于指定的资源组和订阅中。 404 ResourceNotFound - 找不到请求的资源。 404 OperationIdNotFound - ID 为 的操作不存在。 409 OperationCancelled - 用户已取消操作。 409 操作中断 - 无法完成对资源的操作，因为同一资源上的另一个操作中断了该操作。 429 SubscriptionTooManyCreateUpdateRequests - 请求数超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求数超出可用资源可以处理的最大请求数。 500 OperationTimedOut - 操作超时并自动回滚。 请重试该操作。 503 TooManyRequests - 请求数超出可用资源可以处理的最大请求数。

示例

Create or update the LTR policy for the managed database.

Sample Request

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.core.util.Context;
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),
            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/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
  }
}

Status code:

202

定义

名称	说明
ManagedInstanceLongTermRetentionPolicy	长期保留策略。
ManagedInstanceLongTermRetentionPolicyName	策略名称。 应始终为 Default。

ManagedInstanceLongTermRetentionPolicy

长期保留策略。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.monthlyRetention	string	采用 ISO 8601 格式的 LTR 备份的每月保留策略。
properties.weekOfYear	integer	采用 ISO 8601 格式的年度备份的一年中的一周。
properties.weeklyRetention	string	采用 ISO 8601 格式的 LTR 备份的每周保留策略。
properties.yearlyRetention	string	采用 ISO 8601 格式的 LTR 备份的年度保留策略。
type	string	资源类型。

ManagedInstanceLongTermRetentionPolicyName

策略名称。 应始终为 Default。

名称	类型	说明
default	string