Edit-AzDataProtectionPolicyRetentionRuleClientObject

モジュール:

Az.DataProtection

既存のポリシーに保持ルールを追加または削除する

構文

Edit-AzDataProtectionPolicyRetentionRuleClientObject
    -Policy <IBackupPolicy>
    -Name <RetentionRuleName>
    [-RemoveRule]
    [<CommonParameters>]

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
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LifeCycles

保持ルールに関連付けられているライフ サイクル。 構築するには、LIFECYCLES プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-Name

保持ルール名

型:	RetentionRuleName
指定可能な値:	Default, Daily, Weekly, Monthly, Yearly
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-OverwriteLifeCycle

既存の LifeCycle を変更するかどうかを指定します。

型:	Nullable<T>[Boolean]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Policy

作成するバックアップ ポリシー オブジェクトは、POLICY プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-RemoveRule

保持ルールを削除するかどうかを指定します。

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

出力

IBackupPolicy