Edit-AzDataProtectionPolicyRetentionRuleClientObject

Module:
Az.DataProtection Module

Ajoute ou supprime une règle de rétention à une stratégie existante

Syntaxe

RemoveRetention (Par défaut) 

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

AddRetention 

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

Description

Ajoute ou supprime une règle de rétention à une stratégie existante

Exemples

Exemple 1 : Ajouter une règle de rétention hebdomadaire

$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

La première commande obtient le modèle de stratégie par défaut. La deuxième commande crée un objet de cycle de vie hebdomadaire. La troisième commande ajoute une règle de rétention hebdomadaire à la stratégie par défaut.

Exemple 2 : Supprimer une règle de rétention hebdomadaire

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

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

Cette commande supprime la règle de rétention hebdomadaire si elle existe dans une stratégie de sauvegarde donnée.

Paramètres

-IsDefault

Spécifie si la règle de rétention est une règle de rétention par défaut.

Propriétés du paramètre

Type:Boolean
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AddRetention
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LifeCycles

Cycles de vie associés à la règle de rétention. Pour construire, consultez la section NOTES pour les propriétés LIFECYCLES et créer une table de hachage.

Propriétés du paramètre

Type:

ISourceLifeCycle[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AddRetention
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

Nom de la règle de rétention

Propriétés du paramètre

Type:RetentionRuleName
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-OverwriteLifeCycle

Spécifie s’il faut modifier un LifeCycle existant.

Propriétés du paramètre

Type:

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AddRetention
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Policy

Objet de stratégie de sauvegarde à construire, consultez la section NOTES pour les propriétés POLICY et créer une table de hachage.

Propriétés du paramètre

Type:IBackupPolicy
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RemoveRule

Spécifie s’il faut supprimer la règle de rétention.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

RemoveRetention
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Sorties

IBackupPolicy