Set-AzRecoveryServicesBackupProtectionPolicy
バックアップ保護ポリシーを変更します。
構文
Set-AzRecoveryServicesBackupProtectionPolicy
[-Policy] <PolicyBase>
[[-RetentionPolicy] <RetentionPolicyBase>]
[[-SchedulePolicy] <SchedulePolicyBase>]
[-MoveToArchiveTier <Boolean>]
[-TieringMode <TieringMode>]
[-TierAfterDuration <Int32>]
[-TierAfterDurationType <String>]
[-BackupSnapshotResourceGroup <String>]
[-BackupSnapshotResourceGroupSuffix <String>]
[-SnapshotConsistencyType <SnapshotConsistencyType>]
[-VaultId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-Token <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzRecoveryServicesBackupProtectionPolicy
[-Policy] <PolicyBase>
[-FixForInconsistentItems]
[-BackupSnapshotResourceGroup <String>]
[-BackupSnapshotResourceGroupSuffix <String>]
[-SnapshotConsistencyType <SnapshotConsistencyType>]
[-VaultId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzRecoveryServicesBackupProtectionPolicy コマンドレットは、既存の Azure Backup 保護ポリシーを変更します。 バックアップ スケジュールとアイテム保持ポリシー のコンポーネントを変更できます。 行った変更は、ポリシーに関連付けられている項目のバックアップと保持に影響します。 現在のコマンドレットを使用する前に、Set-AzRecoveryServicesVaultContext コマンドレットを使用してコンテナー コンテキストを設定します。
例
例 1: バックアップ保護ポリシーを変更する
$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM"
$SchPol.ScheduleRunTimes.Clear()
$Time = Get-Date
$Time1 = Get-Date -Year $Time.Year -Month $Time.Month -Day $Time.Day -Hour $Time.Hour -Minute 0 -Second 0 -Millisecond 0
$Time1 = $Time1.ToUniversalTime()
$SchPol.ScheduleRunTimes.Add($Time1)
$SchPol.ScheduleRunFrequency.Clear
$SchPol.ScheduleRunDays.Add("Monday")
$SchPol.ScheduleRunFrequency="Weekly"
$RetPol = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM"
$RetPol.IsDailyScheduleEnabled=$false
$RetPol.DailySchedule.DurationCountInDays = 0
$RetPol.IsWeeklyScheduleEnabled=$true
$RetPol.WeeklySchedule.DaysOfTheWeek.Add("Monday")
$RetPol.WeeklySchedule.DurationCountInWeeks = 365
$vault = Get-AzRecoveryServicesVault -ResourceGroupName "azurefiles" -Name "azurefilesvault"
$Pol= Get-AzRecoveryServicesBackupProtectionPolicy -Name "TestPolicy" -VaultId $vault.ID
$Pol.SnapshotRetentionInDays=5
Set-AzRecoveryServicesBackupProtectionPolicy -Policy $Pol -SchedulePolicy $SchPol -RetentionPolicy $RetPol -BackupSnapshotResourceGroup "snapshotResourceGroupPrefix" -BackupSnapshotResourceGroupSuffix "snapshotResourceGroupSuffix"保護ポリシーを変更するための手順の概要を次に示します。
- 基本の SchedulePolicyObject と基本 RetentionPolicyObject を取得します。 それらをいくつかの変数に格納します。
- 要件に従って、スケジュール ポリシー オブジェクトとアイテム保持ポリシー オブジェクトのさまざまなパラメーターを設定します。 たとえば、上記のサンプル スクリプトでは、週単位の保護ポリシーを設定しようとしています。 そのため、スケジュールの頻度を "毎週" に変更し、スケジュールの実行時間も更新しました。 アイテム保持ポリシー オブジェクトで、毎週の保持期間を更新し、正しい "毎週のスケジュールが有効" フラグを設定しました。 日次ポリシーを設定する場合は、"日次スケジュールが有効" フラグを true に設定し、他のオブジェクト パラメーターに適切な値を割り当てます。
- 変更するバックアップ保護ポリシーを取得し、変数に格納します。 上記の例では、変更する "TestPolicy" という名前のバックアップ ポリシーを取得しました。
- 変更されたスケジュール ポリシー オブジェクトとアイテム保持ポリシー オブジェクトを使用して、手順 3 で取得したバックアップ保護ポリシーを変更します。 BackupSnapshotResourceGroup、BackupSnapshotResourceGroupSuffix パラメーターを使用して、インスタント RP のスナップショットリソース グループ名を更新します。
例 2: 1 日に複数のバックアップに対して Azure ファイル共有ポリシーを変更する
$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly
$retentionPolicy = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly
$timeZone = Get-TimeZone
$schedulePolicy.ScheduleRunTimeZone = $timeZone.Id
$startTime = Get-Date -Date "2021-12-22T06:00:00.00+00:00"
$schedulePolicy.ScheduleWindowStartTime = $startTime.ToUniversalTime()
$schedulePolicy.ScheduleInterval = 6
$schedulePolicy.ScheduleWindowDuration = 14
$retentionPolicy.DailySchedule.DurationCountInDays = 6
$policy = Get-AzRecoveryServicesBackupProtectionPolicy -Name "TestPolicy" -VaultId $vault.ID
Set-AzRecoveryServicesBackupProtectionPolicy -Policy $policy -VaultId $vault.ID -SchedulePolicy $schedulePolicy -RetentionPolicy $retentionPolicy1 日に複数のバックアップのファイル共有ポリシーを変更する手順の概要を次に示します。
- 1 時間ごとの SchedulePolicyObject と基本時間ごとの RetentionPolicyObject を取得します。 それらをいくつかの変数に格納します。
- 要件に従って、スケジュール ポリシー オブジェクトとアイテム保持ポリシー オブジェクトのさまざまなパラメーターを設定します。 たとえば、上記のサンプル スクリプトでは、スケジュールを実行する$timeZoneを設定し、時間単位のスケジュールの開始時刻を設定し、時間単位の間隔 (時間単位) を設定します。その後、バックアップはスケジュールが実行される同じ日、期間 (時間単位) に再トリガーされます。 次に、毎日の復旧ポイントの保持設定を変更します。
- 変更するバックアップ保護ポリシーを取得し、変数に格納します。 上記の例では、変更する "TestPolicy" という名前のバックアップ ポリシーを取得しました。
- 変更されたスケジュール ポリシー オブジェクトとアイテム保持ポリシー オブジェクトを使用して、手順 3 で取得したバックアップ保護ポリシーを変更します。
例 3: AzureWorkload ポリシーを変更してアーカイブ スマート階層化を有効にする
$pol = Set-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -Policy $policy -MoveToArchiveTier $true -TieringMode TierAllEligible -TierAfterDuration 60 -TierAfterDurationType Daysこのコマンドは、ポリシー $policyのアーカイブ スマート階層化を有効にするためにポリシーを変更するために使用されます。-MoveToArchiveTier パラメーターを $true に設定して階層化を有効にします。 TierAfterDuration パラメーターと TierAfterDurationType パラメーターによって指定された一定の期間が経過した後に、対象となるすべての復旧ポイントをアーカイブに移動するには、TierAllEligible に TieringMode を選択します。 推奨される復旧ポイントを AzureVM のアーカイブに移動するには、TieringMode TierRecommended を使用します。
例 4: 既存のポリシーでスマート階層化を無効にする
$pol = Set-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -Policy $policy -MoveToArchiveTier $falseこのコマンドは、ポリシー $policyのアーカイブ スマート階層化を無効にするために使用されます。-MoveToArchiveTier パラメーターを$falseに設定します。 アーカイブ スマート階層化を無効にすると、コストに影響する可能性があることに注意してください。
パラメーター
-BackupSnapshotResourceGroup
マネージド仮想マシンのインスタント 復旧ポイントを格納するためのカスタム リソース グループ名。 これは省略可能です
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-BackupSnapshotResourceGroupSuffix
マネージド仮想マシンのインスタント 復旧ポイントを格納するためのカスタム リソース グループ名サフィックス。 これは省略可能です
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-FixForInconsistentItems
失敗した項目に対してポリシーの更新を再試行するかどうかを示す Switch パラメーター。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-MoveToArchiveTier
復旧ポイントをポリシーによってアーカイブ ストレージに移動するかどうかを指定します。 使用できる値は$true、$false
| 型: | Nullable<T>[Boolean] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Policy
このコマンドレットが変更するバックアップ保護ポリシーを指定します。 BackupProtectionPolicy オブジェクトを取得するには、Get-AzRecoveryServicesBackupProtectionPolicy コマンドレットを使用します。
| 型: | PolicyBase |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-RetentionPolicy
基本アイテム保持ポリシーを指定します。 RetentionPolicy オブジェクトを取得するには、Get-AzRecoveryServicesBackupRetentionPolicyObject コマンドレットを使用します。
| 型: | RetentionPolicyBase |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SchedulePolicy
基本スケジュール ポリシー オブジェクトを指定します。 SchedulePolicy オブジェクトを取得するには、Get-AzRecoveryServicesBackupSchedulePolicyObject オブジェクトを使用します。
| 型: | SchedulePolicyBase |
| 配置: | 3 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SnapshotConsistencyType
バックアップに使用するスナップショット整合性の種類。 OnlyCrashConsistent に設定すると、関連付けられているすべての項目のクラッシュ整合性スナップショット。 使用可能な値は OnlyCrashConsistent、既定値です
| 型: | SnapshotConsistencyType |
| 指定可能な値: | Default, OnlyCrashConsistent |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TierAfterDuration
復旧ポイントがアーカイブ層への移行を開始する期間を指定します。値は日数または月単位で指定できます。 TieringMode が TierAllEligible の場合にのみ適用されます
| 型: | Nullable<T>[Int32] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TierAfterDurationType
TierAfterDuration を日数または月単位で指定します。
| 型: | String |
| 指定可能な値: | Days, Months |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TieringMode
推奨またはすべての対象復旧ポイントをアーカイブに移動するかどうかを指定します。
| 型: | TieringMode |
| 指定可能な値: | TierRecommended, TierAllEligible |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Token
Resource Guard サブスクリプションに対する重要な操作を認証するための補助アクセス トークン
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-VaultId
Recovery Services コンテナーの ARM ID。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |