Edit-AzDataProtectionPolicyRetentionRuleClientObject

Fügt einer vorhandenen Sicherungsrichtlinie Aufbewahrungsregel hinzu oder entfernt sie.

Syntax

RemoveRetention (Standard)

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

AddRetention

Edit-AzDataProtectionPolicyRetentionRuleClientObject
    -Policy <IBackupPolicy>
    -Name <RetentionRuleName>
    -IsDefault <Boolean>
    -LifeCycles <ISourceLifeCycle[]>
    [-OverwriteLifeCycle <Boolean>]
    [<CommonParameters>]

Beschreibung

Fügt einer vorhandenen Sicherungsrichtlinie Aufbewahrungsregel hinzu oder entfernt sie.

Beispiele

Beispiel 1: Wöchentliche Aufbewahrungsregel hinzufügen

$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

Der erste Befehl ruft die Standardrichtlinienvorlage ab. Der zweite Befehl erstellt ein wöchentliches Lebenszyklusobjekt. Der dritte Befehl fügt der Standardrichtlinie eine wöchentliche Aufbewahrungsregel hinzu.

Beispiel 2: Wöchentliche Aufbewahrungsregel entfernen

Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -RemoveRule
DatasourceType            ObjectType
--------------            ----------
{Microsoft.Compute/disks} BackupPolicy

Mit diesem Befehl wird die wöchentliche Aufbewahrungsregel entfernt, wenn sie in einer bestimmten Sicherungsrichtlinie vorhanden ist.

Beispiel 3: Hinzufügen einer OperationalStore-Aufbewahrungsregel zu einer AzureBlob-Richtlinie

$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

Für AzureBlob müssen OperationalStore-Aufbewahrungsregeln benannt Default_OperationalStorewerden. Die Regel wird additiv hinzugefügt – die vorhandene Default Aufbewahrungsregel (VaultStore) in der Richtlinienvorlage wird beibehalten. Das Übergeben -Name Default mit einem OperationalStore-Lebenszyklus wird durch Überprüfung abgelehnt.

Hinweis: -OverwriteLifeCycle Ist veraltet und wird in einer bevorstehenden Version entfernt. Durch Festlegen -OverwriteLifeCycle $false von Blöcken wird die Aktualisierung einer vorhandenen Aufbewahrungsregel blockiert. Wenn $true sie ausgelassen wird, werden die Lebenszyklus der vorhandenen Regel ersetzt – das Standardverhalten, nachdem dieser Parameter entfernt wurde.

Parameter

-IsDefault

Gibt an, ob aufbewahrungsregel die Standardaufbewahrungsregel ist.

Parametereigenschaften

Typ:Boolean
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AddRetention
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-LifeCycles

Lebenszykluszyklen, die der Aufbewahrungsregel zugeordnet sind.

Parametereigenschaften

Typ:

ISourceLifeCycle[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AddRetention
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Name

Name der Aufbewahrungsregel. Hinweis: "Default" Aufbewahrungsregeln können unabhängig vom Lebenszyklus nicht entfernt werden.

Parametereigenschaften

Typ:RetentionRuleName
Standardwert:None
Zulässige Werte:Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-OverwriteLifeCycle

[Veraltet] Optional; Dieser Parameter wird in einer bevorstehenden Version entfernt. Durch Festlegen -OverwriteLifeCycle $false von Blöcken wird die Aktualisierung einer vorhandenen Aufbewahrungsregel blockiert. Wenn $true sie ausgelassen wird, werden die Lebenszyklus der vorhandenen Regel ersetzt – das Standardverhalten, nachdem dieser Parameter entfernt wurde.

Parametereigenschaften

Typ:

Nullable<T>[Boolean]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

AddRetention
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Policy

Sicherungsrichtlinienobjekt

Parametereigenschaften

Typ:IBackupPolicy
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-RemoveRule

Gibt an, ob die Aufbewahrungsregel entfernt werden soll.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

RemoveRetention
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Ausgaben

IBackupPolicy

Hinweise

  • "Default" Aufbewahrungsregeln können unabhängig vom Lebenszyklus nicht entfernt werden. -RemoveRule -Name Default wirft Removing Default Retention Rule is not allowed. Please try again with different rule name.
  • -OverwriteLifeCycle ist veraltet und wird in einer bevorstehenden Version entfernt. Durch Festlegen -OverwriteLifeCycle $false von Blöcken wird die Aktualisierung einer vorhandenen Aufbewahrungsregel blockiert. Wenn $true sie ausgelassen wird, werden die Lebenszyklus der vorhandenen Regel ersetzt – das Standardverhalten, nachdem dieser Parameter entfernt wurde.