Long Term Retention Policies - Create Or Update

データベースの長期保持ポリシーを設定します。

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

URI パラメーター

Name In Required Type Description
databaseName
path True
  • string

データベースの名前。

policyName
path True

ポリシー名。 常に既定値にする必要があります。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True
  • string

要求で使用する API のバージョン。

要求本文

Name Type Description
properties.monthlyRetention
  • string

ISO 8601 形式の LTR バックアップの月単位の保持ポリシー。

properties.weekOfYear
  • integer

ISO 8601 形式で年単位のバックアップを取得する年の週。

properties.weeklyRetention
  • string

ISO 8601 形式の LTR バックアップの毎週の保持ポリシー。

properties.yearlyRetention
  • string

ISO 8601 形式の LTR バックアップの年単位の保持ポリシー。

応答

Name Type Description
200 OK

ポリシーを正常に設定しました。

202 Accepted

同意

Other Status Codes

エラー応答: ***

  • 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。

  • 400 InvalidParameterValue - パラメーターに無効な値が指定されました。

  • 年単位のリテンション期間を設定するには、400 LongTermRetentionMissingWeekOfYear - WeekOfYear を 1 から 52 の間で設定する必要があります。

  • 400 LongTermRetentionPolicyNotSupported - このデータベースでは、長期保有はサポートされていません。

  • 400 LongTermRetentionPolicyInvalid - 長期保持ポリシーが無効です。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたリソース グループとサブスクリプションに指定されたサーバーが存在しません。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

Create or update the long term retention policy for the database.

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2021-08-01-preview

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

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

定義

LongTermRetentionPolicy

長期保持ポリシー。

LongTermRetentionPolicyName

ポリシー名。 常に既定値にする必要があります。

LongTermRetentionPolicy

長期保持ポリシー。

Name Type Description
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

リソースの種類。

LongTermRetentionPolicyName

ポリシー名。 常に既定値にする必要があります。

Name Type Description
default
  • string