Edit-AzDataProtectionPolicyRetentionRuleClientObject

Módulo:
Az.DataProtection Module

Agrega o quita la regla de retención a una directiva de copia de seguridad existente.

Sintaxis

RemoveRetention (valor predeterminado) 

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

AddRetention 

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

Description

Agrega o quita la regla de retención a una directiva de copia de seguridad existente.

Ejemplos

Ejemplo 1: Agregar regla de retención semanal

$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

El primer comando obtiene la plantilla de directiva predeterminada. El segundo comando crea un objeto de ciclo de vida semanal. El tercer comando agrega una regla de retención semanal a la directiva predeterminada.

Ejemplo 2: Quitar regla de retención semanal

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

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

Este comando quita la regla de retención semanal si existe en una directiva de copia de seguridad determinada.

Ejemplo 3: Adición de una regla de retención operationalStore a una directiva de 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

Para AzureBlob, las reglas de retención de OperationalStore deben denominarse Default_OperationalStore. La regla se agrega aditivamente: se conserva la regla de retención existente Default (VaultStore) en la plantilla de directiva. La validación rechaza el paso -Name Default con un ciclo de vida de OperationalStore.

Nota: -OverwriteLifeCycle está en desuso y se quitará en una próxima versión. Establecer -OverwriteLifeCycle $false bloquea la actualización de una regla de retención existente; cuando $true se omite, los ciclos de vida de la regla existente se reemplazan en su lugar, el comportamiento predeterminado una vez que se quita este parámetro.

Parámetros

-IsDefault

Especifica si la regla de retención es la regla de retención predeterminada.

Propiedades de parámetro

Tipo:Boolean
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AddRetention
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-LifeCycles

Ciclos de vida asociados a la regla de retención.

Propiedades de parámetro

Tipo:

ISourceLifeCycle[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AddRetention
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Nombre de la regla de retención. Nota: "Default" las reglas de retención no se pueden quitar, independientemente del ciclo de vida.

Propiedades de parámetro

Tipo:RetentionRuleName
Valor predeterminado:None
Valores aceptados:Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-OverwriteLifeCycle

[En desuso] Opcional; este parámetro se quitará en una próxima versión. Establecer -OverwriteLifeCycle $false bloquea la actualización de una regla de retención existente; cuando $true se omite, los ciclos de vida de la regla existente se reemplazan en su lugar, el comportamiento predeterminado una vez que se quita este parámetro.

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

AddRetention
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Policy

Objeto de directiva de copia de seguridad

Propiedades de parámetro

Tipo:IBackupPolicy
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RemoveRule

Especifica si se va a quitar la regla de retención.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

RemoveRetention
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Salidas

IBackupPolicy

Notas

  • "Default" Las reglas de retención no se pueden quitar, independientemente del ciclo de vida. -RemoveRule -Name Default lanza Removing Default Retention Rule is not allowed. Please try again with different rule name.
  • -OverwriteLifeCycle está en desuso y se quitará en una próxima versión. Establecer -OverwriteLifeCycle $false bloquea la actualización de una regla de retención existente; cuando $true se omite, los ciclos de vida de la regla existente se reemplazan en su lugar, el comportamiento predeterminado una vez que se quita este parámetro.