Compartilhar via


Set-AzSqlDatabaseBackupLongTermRetentionPolicy

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

Sintaxe

WeeklyRetentionRequired (Default)

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>]

Description

O cmdlet Set-AzSqlDatabaseBackupLongTermRetentionPolicy define a política de retenção de longo prazo registrada neste banco de dados. A política é um recurso Backup do Azure 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: Definir a retenção anual para a versão atual da política de retenção de longo prazo com uma imutabilidade de 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 em tempo desbloqueada. Esses backups podem ter sua imutabilidade bloqueada ou removida posteriormente.

Exemplo 5: Definir a retenção anual para a versão atual da política de retenção de longo prazo com uma imutabilidade baseada em 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 em tempo bloqueada. Esses backups não podem ser excluídos manualmente e serão descartados apenas 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 durante 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 do database01 para que ela não salve mais nenhum backup 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 database01 para que ela não salve mais nenhum backup de retenção de longo prazo. Isso não afetará os backups que já foram feitos

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DatabaseName

O nome do Banco de Dados SQL do Azure a ser usado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

MonthlyRetentionRequired
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-RemovePolicy

Se fornecida, a política do banco de dados será desmarcada.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RemovePolicy
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

O nome do grupo de recursos.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ServerName

O nome do Azure SQL Server em que o banco de dados está.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-TimeBasedImmutability

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Enabled, Disabled
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-TimeBasedImmutabilityMode

A configuração do modo de imutabilidade baseado em tempo para backups futuros. Só será 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 do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Unlocked, Locked
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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 do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

WeeklyRetentionRequired
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WeekOfYear

A Semana do Ano, de 1 a 52 anos, para economizar para a Retenção Anual.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

YearlyRetentionRequired
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

YearlyRetentionRequired
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
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.

Entradas

String

Int32

Saídas

AzureSqlDatabaseBackupLongTermRetentionPolicyModel