Partilhar 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 uma base 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 do URI

Name Em Necessário Tipo Description
databaseName
 path True

string

O nome da base de dados.
policyName
 path True

LongTermRetentionPolicyName

O nome da política. Deve ser sempre Predefinido.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

O ID da subscrição que identifica uma subscrição do Azure.
api-version
 query True

string

A versão da API a utilizar para o pedido.

Corpo do Pedido

Name Tipo Description
properties.monthlyRetention

string

A política de retenção mensal de uma cópia de segurança LTR num formato ISO 8601.
properties.weekOfYear

integer

A semana do ano para fazer a cópia de segurança anual num formato ISO 8601.
properties.weeklyRetention

string

A política de retenção semanal para uma cópia de segurança LTR num formato ISO 8601.
properties.yearlyRetention

string

A política de retenção anual de uma cópia de segurança LTR num formato ISO 8601.

Respostas

Name Tipo Description
200 OK

LongTermRetentionPolicy

Defina a política com êxito.
202 Accepted

Aceite
Other Status Codes

Respostas de Erro: ***

  • 400 InvalidResourceRequestBody – as propriedades do recurso ou recurso no corpo do pedido estão vazias ou são inválidas.

  • 400 InvalidParameterValue – foi atribuído um valor inválido a um parâmetro.

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

  • 400 LTRNotSupportedForPerDBCMK – A Retenção de Cópia de Segurança de Longo Prazo não é suportada quando a CMK ao nível da base de dados é configurada em pré-visualização.

  • 400 LongTermRetentionPolicyNotSupported – A Retenção de Longo Prazo não é suportada nesta base de dados.

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

  • 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado

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

  • 404 ResourceNotFound – o recurso pedido não foi encontrado.

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

  • 409 OperationCancelled - A operação foi cancelada pelo utilizador.

  • 409 OperationInterrupted - Não foi possível concluir a operação no recurso porque foi interrompida por outra operação no mesmo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.

  • 500 OperationTimedOut – a operação excedeu o limite de tempo e foi revertida automaticamente. Repita a operação.

  • 503 TooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.

Exemplos

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

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
202

Definições

Name Description
LongTermRetentionPolicy

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

O nome da política. Deve ser sempre Predefinido.

LongTermRetentionPolicy

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

Name Tipo Description
id

string

ID do Recurso.
name

string

Nome do recurso.
properties.monthlyRetention

string

A política de retenção mensal de uma cópia de segurança LTR num formato ISO 8601.
properties.weekOfYear

integer

A semana do ano para fazer a cópia de segurança anual num formato ISO 8601.
properties.weeklyRetention

string

A política de retenção semanal para uma cópia de segurança LTR num formato ISO 8601.
properties.yearlyRetention

string

A política de retenção anual de uma cópia de segurança LTR num formato ISO 8601.
type

string

Tipo de recurso.

LongTermRetentionPolicyName

O nome da política. Deve ser sempre Predefinido.

Name Tipo Description
default

string