次の方法で共有

Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy

  • リファレンス
モジュール:
AzureRM.Sql

サーバーの長期保持ポリシーを設定します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy
   -WeeklyRetention <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy
   -State <String>
   -ResourceId <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy
   [-RemovePolicy]
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy
   [-WeeklyRetention <String>]
   -MonthlyRetention <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy
   [-WeeklyRetention <String>]
   [-MonthlyRetention <String>]
   -YearlyRetention <String>
   -WeekOfYear <Int32>
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy コマンドレットは、このデータベースに登録されている長期保持ポリシーを設定します。 このポリシーは、バックアップ ストレージ ポリシーの定義に使用される Azure Backup リソースです。

例

例 1: 長期保持ポリシーの現在のバージョンの週単位の保持期間を設定する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : P2W
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

これにより、database01 の長期保有ポリシーが設定され、毎週の完全バックアップが 2 週間ごとに保存されます

例 2: 長期保持ポリシーの現在のバージョンの月次リテンション期間を設定する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : P5Y
YearlyRetention                        : PT0S
WeekOfYear                             : 0
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

これにより、database01 の長期保有ポリシーが設定され、毎月の最初の完全バックアップが 5 年間保存されます

例 3: 長期保持ポリシーの現在のバージョンの年単位のリテンション期間を設定する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

これにより、database01 の長期保有ポリシーが設定され、1 年の第 26 週に作成された完全バックアップが 10 年間保存されます。

例 4: 長期保持ポリシーの現在のバージョンの各リテンション期間を設定する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : P14D
MonthlyRetention                       : P24W
YearlyRetention                        : P10Y
WeekOfYear                             : 26
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

これにより、database01 の長期保有ポリシーが設定され、各完全バックアップが 14 日間保存され、毎月最初の完全バックアップが 24 週間、完全バックアップが 10 年間の年の第 26 週に作成されます。

例 4: 長期保持ポリシーを削除する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

database01 のポリシーを削除して、長期保有バックアップを保存しなくなります。 これは、既に作成されているバックアップには影響しません

例 4: 長期保持ポリシーを削除する

PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D


ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
State                                  :
RecoveryServicesBackupPolicyResourceId :
Location                               :

これは database01 のポリシーを削除するもう 1 つの方法であり、長期的な保有バックアップが保存されなくなります。 これは、既に作成されているバックアップには影響しません

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DatabaseName

使用する Azure SQL Database の名前。

型:String
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-MonthlyRetention

月単位のリテンション期間。 ISO 8601 文字列の代わりに数値のみを渡す場合、日数は単位と見なされます。 7日の最小値と最大10年があります。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RemovePolicy

指定した場合、データベースのポリシーは削除されます。

型:SwitchParameter
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceGroupName

リソース グループの名前。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceId

バックアップの長期保有ポリシーのリソース ID。

型:String
Aliases:Id
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServerName

データベースが格納されている Azure SQL Server の名前。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-State

長期保有バックアップ ポリシーの状態 ("有効" または "無効")

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WeeklyRetention

週単位のリテンション期間。 ISO 8601 文字列の代わりに数値のみを渡す場合、日数は単位と見なされます。 7日の最小値と最大10年があります。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WeekOfYear

年単位のリテンション期間に保存する年の週 (1 ~ 52)。

型:Int32
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-YearlyRetention

年単位のリテンション期間。 ISO 8601 文字列の代わりに数値のみを渡す場合、日数は単位と見なされます。 7日の最小値と最大10年があります。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

String

Int32

出力

AzureSqlDatabaseBackupLongTermRetentionPolicyModel