Set-AzSqlDatabaseBackupLongTermRetentionPolicy

Módulo:
Az.Sql Module

Define uma política de retenção de longo prazo do servidor.

Sintaxe

WeeklyRetentionRequired (Predefinição) 

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -WeeklyRetention <String>
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RemovePolicy 

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    [-RemovePolicy]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MonthlyRetentionRequired 

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -MonthlyRetention <String>
    [-WeeklyRetention <String>]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

YearlyRetentionRequired 

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -YearlyRetention <String>
    -WeekOfYear <Int32>
    [-WeeklyRetention <String>]
    [-MonthlyRetention <String>]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

O cmdlet Set-AzSqlDatabaseBackupLongTermRetentionPolicy define a política de retenção de longo prazo registrada nesse banco de dados. A política é um recurso do Azure Backup usado para definir a política de armazenamento de backup.

Exemplos

Exemplo 1: Definir a retenção semanal para a versão atual da política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : P2W
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Isso define a política de retenção de longo prazo do database01 para salvar cada backup completo semanal por 2 semanas

Exemplo 2: Definir a retenção mensal para a versão atual da política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : P5Y
YearlyRetention                        : PT0S
WeekOfYear                             : 0
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Isso define a política de retenção de longo prazo do database01 para salvar o primeiro backup completo de cada mês por 5 anos

Exemplo 3: Definir a retenção anual para a versão atual da política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Isso define a política de retenção de longo prazo do database01 para salvar o backup completo feito na 26ª semana do ano por 10 anos

Exemplo 4: Defina a retenção anual para a versão atual da política de retenção de longo prazo com uma imutabilidade baseada no tempo desbloqueada habilitada

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Enabled
TimeBasedImmutabilityMode              : Unlocked

Isso define a política de retenção de longo prazo do database01 para salvar o backup completo feito na 26ª semana do ano por 10 anos. Além disso, os backups serão criados com uma política de imutabilidade baseada no tempo desbloqueada. Esses backups podem posteriormente ter sua imutabilidade bloqueada ou removida.

Exemplo 5: Defina a retenção anual para a versão atual da política de retenção de longo prazo com uma imutabilidade baseada no tempo bloqueada habilitada

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled -TimeBasedImmutabilityMode Locked

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Enabled
TimeBasedImmutabilityMode              : Locked

Isso define a política de retenção de longo prazo do database01 para salvar o backup completo feito na 26ª semana do ano por 10 anos. Além disso, os backups serão criados com uma política de imutabilidade baseada no tempo bloqueada. Esses backups não podem ser excluídos manualmente e só serão descartados na expiração.

Exemplo 6: Definir cada retenção para a versão atual da política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : P14D
MonthlyRetention                       : P24W
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Isso define a política de retenção de longo prazo do database01 para salvar cada backup completo por 14 dias, o primeiro backup completo de cada mês por 24 semanas e o backup completo feito na 26ª semana do ano por 10 anos

Exemplo 7: Remover a política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Remove a política para database01 para que ela não salve mais backups de retenção de longo prazo. Isso não afetará os backups que já foram feitos.

Exemplo 8: Remover a política de retenção de longo prazo

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

Essa é outra maneira de remover a política do banco de dados01 para que ele não salve mais backups de retenção de longo prazo. Isso não afetará os backups que já foram feitos

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-DatabaseName

O nome do Base de Dados SQL do Azure a utilizar.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-DefaultProfile

As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

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

-MonthlyRetention

A retenção mensal. Se apenas um número for passado em vez de uma cadeia de caracteres ISO 8601, os dias serão assumidos como as unidades. Há um mínimo de 7 dias e um máximo de 10 anos.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-RemovePolicy

Se fornecida, a política para o banco de dados será limpa.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-ResourceGroupName

O nome do grupo de recursos.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-ServerName

O nome do Azure SQL Server onde a base de dados está.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-TimeBasedImmutability

Quando definidos, os backups futuros terão TimeBasedImmutability habilitado.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Valores aceites:Enabled, Disabled
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

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

-TimeBasedImmutabilityMode

A configuração do modo de imutabilidade com base no tempo para backups futuros. Só é eficaz se TimeBasedImmutability estiver habilitado. O valor pode ser bloqueado ou desbloqueado. Cuidado: A imutabilidade do backup LTR não pode ser removida se TimeBasedImmutabilityMode estiver bloqueado.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Valores aceites:Unlocked, Locked
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

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

-WeeklyRetention

A retenção semanal. Se apenas um número for passado em vez de uma cadeia de caracteres ISO 8601, os dias serão assumidos como as unidades. Há um mínimo de 7 dias e um máximo de 10 anos.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-WeekOfYear

A Semana do Ano, 1 a 52, para poupar para a retenção anual.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-YearlyRetention

A retenção anual. Se apenas um número for passado em vez de uma cadeia de caracteres ISO 8601, os dias serão assumidos como as unidades. Há um mínimo de 7 dias e um máximo de 10 anos.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

YearlyRetentionRequired
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
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.

Entradas

String

Int32

Saídas

AzureSqlDatabaseBackupLongTermRetentionPolicyModel