Edit-AzDataProtectionPolicyRetentionRuleClientObject

Adiciona ou remove a Regra de Retenção a uma política de backup existente.

Sintaxe

RemoveRetention (Predefinição)

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

AddRetention

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

Descrição

Adiciona ou remove a Regra de Retenção a uma política de backup existente.

Exemplos

Exemplo 1: Adicionar regra de retenção 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

O primeiro comando obtém o modelo de política padrão. O segundo comando cria um objeto de ciclo de vida semanal. O terceiro comando adiciona uma regra de retenção semanal à política padrão.

Exemplo 2: Remover regra de retenção semanal

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

Esse comando remove a regra de retenção semanal se ela existir em determinada política de backup.

Exemplo 3: Adicionar uma regra de retenção OperationalStore a uma política 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, as regras de retenção do OperationalStore devem ser chamadas Default_OperationalStore. A regra é adicionada de forma aditiva — a regra de retenção existente Default (VaultStore) no modelo de política é preservada. A passagem -Name Default com um ciclo de vida do OperationalStore é rejeitada por validação.

Nota: -OverwriteLifeCycle está obsoleto e será removido numa próxima versão. Definir -OverwriteLifeCycle $false blocos que atualizam uma regra de retenção existente; quando $true ou omitidos, os ciclos de vida da regra existente são substituídos — o comportamento padrão quando este parâmetro é removido.

Parâmetros

-IsDefault

Especifica se a regra de retenção é a regra de retenção padrão.

Propriedades dos parâmetros

Tipo:Boolean
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

AddRetention
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-LifeCycles

Ciclos de vida associados à regra de retenção.

Propriedades dos parâmetros

Tipo:

ISourceLifeCycle[]

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

AddRetention
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Nome da Regra de Retenção. Nota: "Default" as regras de retenção não podem ser removidas, independentemente do ciclo de vida.

Propriedades dos parâmetros

Tipo:RetentionRuleName
Valor predefinido:None
Valores aceites:Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-OverwriteLifeCycle

[Desvalorizado] Opcional; Este parâmetro será removido numa próxima versão. Definir -OverwriteLifeCycle $false blocos que atualizam uma regra de retenção existente; quando $true ou omitidos, os ciclos de vida da regra existente são substituídos — o comportamento padrão quando este parâmetro é removido.

Propriedades dos parâmetros

Tipo:

Nullable<T>[Boolean]

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

AddRetention
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Policy

Objeto de Política de Backup

Propriedades dos parâmetros

Tipo:IBackupPolicy
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-RemoveRule

Especifica se a regra de retenção deve ser removida.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

RemoveRetention
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Saídas

IBackupPolicy

Notas

  • "Default" As regras de retenção não podem ser removidas, independentemente do ciclo de vida. -RemoveRule -Name Default lança Removing Default Retention Rule is not allowed. Please try again with different rule name.
  • -OverwriteLifeCycle está obsoleto e será removido numa próxima versão. Definir -OverwriteLifeCycle $false blocos que atualizam uma regra de retenção existente; quando $true ou omitidos, os ciclos de vida da regra existente são substituídos — o comportamento padrão quando este parâmetro é removido.