Managed Instance Long Term Retention Policies - Create Or Update

サービス:

SQL Database

API バージョン:

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	ポリシー名。 常に既定値にする必要があります。
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 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Create or update the LTR policy for the managed database.

要求のサンプル

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

応答のサンプル

状態コード:

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

状態コード:

202

定義

名前	説明
ManagedInstanceLongTermRetentionPolicy	長期保持ポリシー。
ManagedInstanceLongTermRetentionPolicyName	ポリシー名。 常に既定値にする必要があります。

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	string