Edit-AzDataProtectionPolicyRetentionRuleClientObject

Modul:
Az.DataProtection Module

Lägger till eller tar bort kvarhållningsregeln i en befintlig säkerhetskopieringsprincip.

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>]

Description

Lägger till eller tar bort kvarhållningsregeln i en befintlig säkerhetskopieringsprincip.

Exempel

Exempel 1: Lägg till regel för veckovis kvarhållning

$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

Det första kommandot hämtar standardprincipmallen. Det andra kommandot skapar ett veckovis livscykelobjekt. Det tredje kommandot lägger till en veckovis kvarhållningsregel i standardprincipen.

Exempel 2: Ta bort regel för veckovis kvarhållning

Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -RemoveRule

DatasourceType            ObjectType
--------------            ----------
{Microsoft.Compute/disks} BackupPolicy

Det här kommandot tar bort den veckovisa kvarhållningsregeln om den finns i den angivna säkerhetskopieringsprincipen.

Exempel 3: Lägga till en Kvarhållningsregel för OperationalStore i en AzureBlob-princip

$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åste Kvarhållningsregler för OperationalStore namnges Default_OperationalStore. Regeln läggs till additivt – den befintliga Default kvarhållningsregeln (VaultStore) i principmallen bevaras. Att skicka -Name Default med en OperationalStore-livscykel avvisas genom validering.

-OverwriteLifeCycle Obs! är inaktuell och kommer att tas bort i en kommande version. Inställningen -OverwriteLifeCycle $false blockerar uppdatering av en befintlig kvarhållningsregel. När $true eller utelämnas ersätts den befintliga regelns livscykel på plats – standardbeteendet när den här parametern tas bort.

Parametrar

-IsDefault

Anger om kvarhållningsregeln är standardregeln för kvarhållning.

Parameteregenskaper

Typ:Boolean
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

AddRetention
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-LifeCycles

Livscykeln som är associerad med kvarhållningsregeln.

Parameteregenskaper

Typ:

ISourceLifeCycle[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

AddRetention
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Name

Namn på kvarhållningsregel. "Default" Obs! Kvarhållningsregler kan inte tas bort, oavsett livscykel.

Parameteregenskaper

Typ:RetentionRuleName
Standardvärde:None
Godkända värden:Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OverwriteLifeCycle

[Inaktuell] Valfri; Den här parametern tas bort i en kommande version. Inställningen -OverwriteLifeCycle $false blockerar uppdatering av en befintlig kvarhållningsregel. När $true eller utelämnas ersätts den befintliga regelns livscykel på plats – standardbeteendet när den här parametern tas bort.

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

AddRetention
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Policy

Objekt för säkerhetskopieringsprincip

Parameteregenskaper

Typ:IBackupPolicy
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-RemoveRule

Anger om kvarhållningsregeln ska tas bort.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

RemoveRetention
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Utdata

IBackupPolicy

Kommentarer

  • "Default" kvarhållningsregler kan inte tas bort, oavsett livscykel. -RemoveRule -Name Default kastar Removing Default Retention Rule is not allowed. Please try again with different rule name.
  • -OverwriteLifeCycle är inaktuell och tas bort i en kommande version. Inställningen -OverwriteLifeCycle $false blockerar uppdatering av en befintlig kvarhållningsregel. När $true eller utelämnas ersätts den befintliga regelns livscykel på plats – standardbeteendet när den här parametern tas bort.