Edit-AzDataProtectionPolicyRetentionRuleClientObject
Adiciona ou remove a Regra de Retenção a uma política de backup existente.
Sintaxe
RemoveRetention (Default)
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
[-RemoveRule]
[<CommonParameters>]
AddRetention
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
-IsDefault <Boolean>
-LifeCycles <ISourceLifeCycle[]>
[-OverwriteLifeCycle <Boolean>]
[<CommonParameters>]
Description
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 removerá a regra de retenção semanal se ela existir na política de backup fornecida.
Exemplo 3: Adicionar uma regra de retenção OperationalStore a uma política do 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 o AzureBlob, as regras de retenção do OperationalStore devem ser nomeadas 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 OperationalStore é rejeitada pela validação.
Observação: -OverwriteLifeCycle foi preterido e será removido em uma versão futura. A configuração -OverwriteLifeCycle $false bloqueia a atualização de uma regra de retenção existente; quando $true ou omitida, os ciclos de vida da regra existente são substituídos em vigor – o comportamento padrão depois que esse parâmetro é removido.
Parâmetros
-IsDefault
Especifica se a regra de retenção é a regra de retenção padrão.
Propriedades do parâmetro
| Tipo: | Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AddRetention
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-LifeCycles
Ciclos de vida associados à regra de retenção.
Propriedades do parâmetro
| Tipo: | |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AddRetention
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Name
Nome da regra de retenção.
Observação: "Default" as regras de retenção não podem ser removidas, independentemente do ciclo de vida.
Propriedades do parâmetro
| Tipo: | RetentionRuleName |
| Valor padrão: | None |
| Valores aceitos: | Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-OverwriteLifeCycle
[Preterido] Opcional; esse parâmetro será removido em uma versão futura. Configuração -OverwriteLifeCycle $false bloqueia a atualização de uma regra de retenção existente; quando $true ou omitido, os ciclos de vida da regra existente são substituídos em vigor – o comportamento padrão depois que esse parâmetro é removido.
Propriedades do parâmetro
| Tipo: | |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AddRetention
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Policy
Objeto de política de backup
Propriedades do parâmetro
| Tipo: | IBackupPolicy |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RemoveRule
Especifica se a regra de retenção deve ser removida.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
RemoveRetention
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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
Observações
-
"Default"as regras de retenção não podem ser removidas, independentemente do ciclo de vida.-RemoveRule -Name DefaultLançaRemoving Default Retention Rule is not allowed. Please try again with different rule name. -
-OverwriteLifeCycleé preterido e será removido em uma versão futura. Configuração-OverwriteLifeCycle $falsebloqueia a atualização de uma regra de retenção existente; quando$trueou omitido, os ciclos de vida da regra existente são substituídos em vigor – o comportamento padrão depois que esse parâmetro é removido.