Edit-AzDataProtectionPolicyRetentionRuleClientObject

Module:: Az.DataProtection Module

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

Syntaxe

RemoveRetention (Par défaut)

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

AddRetention

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

Description

Ajoute ou supprime une règle de rétention à une stratégie de sauvegarde 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.

Exemple 3 : Ajouter une règle de rétention OperationalStore à une stratégie AzureBlob

$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

Pour AzureBlob, les règles de rétention OperationalStore doivent être nommées Default_OperationalStore. La règle est ajoutée de manière additive : la règle de rétention existante Default (VaultStore) sur le modèle de stratégie est conservée. La transmission -Name Default avec un cycle de vie OperationalStore est rejetée par validation.

Remarque : -OverwriteLifeCycle est déconseillé et sera supprimé dans une prochaine version. La définition -OverwriteLifeCycle $false bloque la mise à jour d’une règle de rétention existante ; lorsqu’elle $true est omise, les cycles de vie de la règle existante sont remplacés , le comportement par défaut une fois ce paramètre supprimé.

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.

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. Remarque : "Default" les règles de rétention ne peuvent pas être supprimées, quel que soit le cycle de vie.

Propriétés du paramètre

Type:	RetentionRuleName
Valeur par défaut:	None
Valeurs acceptées:	Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore
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

[Déconseillé] Optionnel; ce paramètre sera supprimé dans une prochaine version. La définition -OverwriteLifeCycle $false bloque la mise à jour d’une règle de rétention existante ; lorsqu’elle $true est omise, les cycles de vie de la règle existante sont remplacés , le comportement par défaut une fois ce paramètre supprimé.

Propriétés du paramètre

Type:	Nullable<T>[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:	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

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

Notes

"Default" Les règles de rétention ne peuvent pas être supprimées, quel que soit le cycle de vie. -RemoveRule -Name Default Jette Removing Default Retention Rule is not allowed. Please try again with different rule name.
-OverwriteLifeCycle est déconseillé et sera supprimé dans une prochaine version. La définition -OverwriteLifeCycle $false bloque la mise à jour d’une règle de rétention existante ; lorsqu’elle $true est omise, les cycles de vie de la règle existante sont remplacés , le comportement par défaut une fois ce paramètre supprimé.

Commentaires

Cette page a-t-elle été utile ?