Long Term Retention Policies - List By Database

Service:

SQL Database

API Version:

2021-11-01

Obtém a política de retenção de longo prazo de um banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies?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.
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.

Respostas

Nome	Tipo	Description
200 OK	LongTermRetentionPolicyListResult	Obtenha a política com êxito.
Other Status Codes		Respostas de erro: *** 400 LTRNotSupportedForPerDBCMK – A retenção de backup de longo prazo não tem suporte quando o CMK no nível do banco de dados é configurado na versão prévia. 400 LongTermRetentionPolicyNotSupported – Não há suporte para 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.

Exemplos

Get the long term retention policy for the database.

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for LongTermRetentionPolicies ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyListByDatabase
     * .json
     */
    /**
     * Sample code: Get the long term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().listByDatabase("resourceGroup",
            "testserver", "testDatabase", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "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
      }
    }
  ]
}

Definições

Nome	Description
LongTermRetentionPolicy	Uma política de retenção de longo prazo.
LongTermRetentionPolicyListResult	Uma lista de políticas de retenção de longo prazo.

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.

LongTermRetentionPolicyListResult

Uma lista de políticas de retenção de longo prazo.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	LongTermRetentionPolicy[]	Matriz de resultados.