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
このコマンドは、特定のバックアップ ポリシーに存在する場合、週単位の保持ルールを削除します。
パラメーター
-IsDefault
保持ルールが既定の保持ルールかどうかを指定します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LifeCycles
保持ルールに関連付けられているライフ サイクル。
構築するには、LIFECYCLES プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。
パラメーターのプロパティ
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
保持ルール名
パラメーターのプロパティ
| 型: | RetentionRuleName
|
| 規定値: | None |
| 指定可能な値: | Default, Daily, Weekly, Monthly, Yearly |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OverwriteLifeCycle
既存の LifeCycle を変更するかどうかを指定します。
パラメーターのプロパティ
パラメーター セット
AddRetention
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Policy
作成するバックアップ ポリシー オブジェクトは、POLICY プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RemoveRule
保持ルールを削除するかどうかを指定します。
パラメーターのプロパティ
パラメーター セット
RemoveRetention
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力