Compartilhar via

Long Term Retention Policies - Create Or Update

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Define a política de retenção de longo prazo de um banco de dados.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/default?api-version=2021-11-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
databaseName
 path True

string

O nome do banco de dados.
policyName
 path True

LongTermRetentionPolicyName

O nome da política. Deve ser sempre Padrão.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

A ID de assinatura que identifica uma assinatura do Azure.
api-version
 query True

string

A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome Tipo Description
properties.monthlyRetention

string

A política de retenção mensal para um backup LTR em um formato ISO 8601.
properties.weekOfYear

integer

A semana do ano para fazer o backup anual em um formato ISO 8601.
properties.weeklyRetention

string

A política de retenção semanal para um backup LTR em um formato ISO 8601.
properties.yearlyRetention

string

A política de retenção anual para um backup LTR em um formato ISO 8601.

Respostas

Nome Tipo Description
200 OK

LongTermRetentionPolicy

Defina a política com êxito.
202 Accepted

Aceito
Other Status Codes

Respostas de erro: ***

  • 400 InvalidResourceRequestBody - O recurso ou as propriedades de recurso no corpo da solicitação são vazios ou inválidos.

  • 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro.

  • 400 LongTermRetentionMissingWeekOfYear - WeekOfYear deve ser definido entre 1 e 52 para definir a retenção anual.

  • 400 LTRNotSupportedForPerDBCMK - A retenção de backup de longo prazo não tem suporte quando a CMK no nível do banco de dados está configurada na versão prévia.

  • 400 LongTermRetentionPolicyNotSupported – Não há suporte para a Retenção de Longo Prazo neste banco de dados.

  • 400 LongTermRetentionPolicyInvalid - A política de retenção de longo prazo é inválida.

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.

  • 404 ResourceNotFound - O recurso solicitado não foi encontrado.

  • 404 OperationIdNotFound - A operação com Id não existe.

  • 409 OperationCancelled - A operação foi cancelada pelo usuário.

  • 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente.

  • 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

Exemplos

Create or update the long term retention policy for the database.

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}
Código de status:
202

Definições

Nome Description
LongTermRetentionPolicy

Uma política de retenção de longo prazo.
LongTermRetentionPolicyName

O nome da política. Deve ser sempre Padrão.

LongTermRetentionPolicy

Uma política de retenção de longo prazo.

Nome Tipo Description
id

string

ID do recurso.
name

string

Nome do recurso.
properties.monthlyRetention

string

A política de retenção mensal para um backup LTR em um formato ISO 8601.
properties.weekOfYear

integer

A semana do ano para fazer o backup anual em um formato ISO 8601.
properties.weeklyRetention

string

A política de retenção semanal para um backup LTR em um formato ISO 8601.
properties.yearlyRetention

string

A política de retenção anual para um backup LTR em um formato ISO 8601.
type

string

Tipo de recurso.

LongTermRetentionPolicyName

O nome da política. Deve ser sempre Padrão.

Nome Tipo Description
default

string