Edit-AzDataProtectionPolicyRetentionRuleClientObject
既存のバックアップ ポリシーに保持ルールを追加または削除します。
構文
RemoveRetention (既定)
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
[-RemoveRule]
[<CommonParameters>]
AddRetention
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
-IsDefault <Boolean>
-LifeCycles <ISourceLifeCycle[]>
[-OverwriteLifeCycle <Boolean>]
[<CommonParameters>]
説明
既存のバックアップ ポリシーに保持ルールを追加または削除します。
例
例 1: 週単位の保持ルールを追加する
$pol = Get-AzDataProtectionPolicyTemplate
$lifecycle = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 5
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -LifeCycles $lifecycle -IsDefault $false
DatasourceType ObjectType
-------------- ----------
{Microsoft.Compute/disks} BackupPolicy
最初のコマンドは、既定のポリシー テンプレートを取得します。 2 番目のコマンドは、週単位のライフサイクル オブジェクトを作成します。 3 番目のコマンドは、既定のポリシーに週単位の保持ルールを追加します。
例 2: 週単位の保持ルールを削除する
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -RemoveRule
DatasourceType ObjectType
-------------- ----------
{Microsoft.Compute/disks} BackupPolicy
このコマンドは、特定のバックアップ ポリシーに存在する場合、週単位の保持ルールを削除します。
例 3: OperationalStore 保持ルールを AzureBlob ポリシーに追加する
$pol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureBlob
$opLifecycle = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Default_OperationalStore -LifeCycles $opLifecycle -IsDefault $true
DatasourceType ObjectType
-------------- ----------
{Microsoft.Storage/storageAccounts/blobServices} BackupPolicy
AzureBlob の場合、OperationalStore の保持ルールには Default_OperationalStore という名前を付ける必要があります。 規則が追加されます。ポリシー テンプレートの既存の Default (VaultStore) 保持ルールが保持されます。 OperationalStore ライフサイクルで -Name Default を渡すことは、検証によって拒否されます。
注: -OverwriteLifeCycle は非推奨となり、今後のリリースで削除される予定です。
-OverwriteLifeCycle $false設定すると、既存の保持ルールの更新がブロックされます。$trueまたは省略すると、既存のルールのライフサイクルが所定の位置に置き換えられます。このパラメーターを削除すると、既定の動作になります。
パラメーター
-IsDefault
保持ルールが既定の保持ルールかどうかを指定します。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LifeCycles
保持ルールに関連付けられているライフ サイクル。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
保持ルール名。
注: "Default" 保持ルールは、ライフサイクルに関係なく削除できません。
パラメーターのプロパティ
| 型: | RetentionRuleName |
| 規定値: | None |
| 指定可能な値: | Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OverwriteLifeCycle
[非推奨]オプション;このパラメーターは、今後のリリースで削除される予定です。
-OverwriteLifeCycle $false設定すると、既存の保持ルールの更新がブロックされます。$trueまたは省略すると、既存のルールのライフサイクルが所定の位置に置き換えられます。このパラメーターを削除すると、既定の動作になります。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Policy
バックアップ ポリシー オブジェクト
パラメーターのプロパティ
| 型: | IBackupPolicy |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RemoveRule
保持ルールを削除するかどうかを指定します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RemoveRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
出力
IBackupPolicy
メモ
-
"Default"保持ルールは、ライフサイクルに関係なく削除できません。-RemoveRule -Name Default例外を投げるRemoving Default Retention Rule is not allowed. Please try again with different rule name. -
-OverwriteLifeCycleは非推奨であり、今後のリリースで削除される予定です。-OverwriteLifeCycle $false設定すると、既存の保持ルールの更新がブロックされます。$trueまたは省略すると、既存のルールのライフサイクルが所定の位置に置き換えられます。このパラメーターを削除すると、既定の動作になります。