Backup Short Term Retention Policies - Update

Service:

SQL Database

API Version:

2021-11-01

データベースの短期保持ポリシーを更新します。

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

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
policyName	path	True	ShortTermRetentionPolicyName	ポリシー名。 常に "default" にする必要があります。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	型	説明
properties.diffBackupIntervalInHours	DiffBackupIntervalInHours	差分バックアップ間隔 (時間単位)。 これは、各差分バックアップがサポートされる間隔時間です。 これはライブ データベースにのみ適用されますが、削除されたデータベースには適用されません。
properties.retentionDays	integer	バックアップの保有期間 (日数)。 これは、ポイントインタイム リストアがサポートされる日数です。

応答

名前	型	説明
200 OK	BackupShortTermRetentionPolicy	ポリシーが正常に更新されました。
202 Accepted		同意
Other Status Codes		エラー応答: *** 400 InvalidParameterValue - パラメーターに無効な値が指定されました。 400 InvalidBackupRetentionPeriod - の保有日数 {0} が有効な構成ではありません。 有効なバックアップ保有期間 (日数) は、 と の間 {1} である必要があります {2} 400 InvalidDiffBackupIntervalHours - の差分バックアップ間隔時間 {0} が有効な構成ではありません。 有効な差分バックアップ間隔は時間である {1} 必要があります。 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベース エディションで無効になっている機能を使用しようとしました。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 SourceDatabaseNotFound - ソース データベースが存在しません。 404 CannotFindObject - オブジェクトが存在しないか、アクセス許可がないため、オブジェクトが見つかりません 409 ConflictingDatabaseOperation - データベースには既にいくつかの操作があり、現在の操作は完了するまで待機する必要があります。 409 ConflictingSystemOperationInProgress - データベースでシステム メンテナンス操作が進行中であり、それ以上の操作が完了するまで待機する必要があります。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースで処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 503 TooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

例

Update the short term retention policy for the database.

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.BackupShortTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.DiffBackupIntervalInHours;
import com.azure.resourcemanager.sql.models.ShortTermRetentionPolicyName;

/** Samples for BackupShortTermRetentionPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/UpdateShortTermRetentionPolicy.json
     */
    /**
     * Sample code: Update the short term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateTheShortTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getBackupShortTermRetentionPolicies().createOrUpdate(
            "resourceGroup", "testsvr", "testdb", ShortTermRetentionPolicyName.DEFAULT,
            new BackupShortTermRetentionPolicyInner().withRetentionDays(7)
                .withDiffBackupIntervalInHours(DiffBackupIntervalInHours.TWO_FOUR),
            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/testsvr/databases/testdb/backupShortTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies",
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Status code:

202

定義

名前	説明
BackupShortTermRetentionPolicy	短期保持ポリシー。
DiffBackupIntervalInHours	差分バックアップ間隔 (時間単位)。 これは、各差分バックアップがサポートされる間隔時間です。 これはライブ データベースにのみ適用されますが、削除されたデータベースには適用されません。
ShortTermRetentionPolicyName	ポリシー名。 常に "default" にする必要があります。

BackupShortTermRetentionPolicy

短期保持ポリシー。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.diffBackupIntervalInHours	DiffBackupIntervalInHours	差分バックアップ間隔 (時間単位)。 これは、各差分バックアップがサポートされる間隔時間です。 これはライブ データベースにのみ適用されますが、削除されたデータベースには適用されません。
properties.retentionDays	integer	バックアップの保有期間 (日数)。 これは、ポイントインタイム リストアがサポートされる日数です。
type	string	リソースの種類。

DiffBackupIntervalInHours

差分バックアップ間隔 (時間単位)。 これは、各差分バックアップがサポートされる間隔時間です。 これはライブ データベースにのみ適用されますが、削除されたデータベースには適用されません。

名前	型	説明
12	string
24	string

ShortTermRetentionPolicyName

ポリシー名。 常に "default" にする必要があります。

名前	型	説明
default	string