Managed Instance Long Term Retention Policies - List By Database

Serviço:

SQL Database

Versão da API:

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/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies?api-version=2021-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
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

Name	Tipo	Description
200 OK	ManagedInstanceLongTermRetentionPolicyListResult	Obtive com sucesso a política LTR para banco de dados gerenciado.
Other Status Codes		Respostas de erro: *** 400 LTRNotSupportedForPerDBCMK - A retenção de backup de longo prazo não é suportada quando a CMK no nível de banco de dados é configurada na visualização. 400 LongTermRetentionPolicyNotSupported - A retenção de longo prazo não é suportada 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 policies for the managed database.

Pedido de amostra

HTTP

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

Java

/**
 * Samples for ManagedInstanceLongTermRetentionPolicies ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceLongTermRetentionPolicyListByDatabase.json
     */
    /**
     * Sample code: Get the long term retention policies for the managed database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionPoliciesForTheManagedDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceLongTermRetentionPolicies()
            .listByDatabase("testResourceGroup", "testInstance", "testDatabase", com.azure.core.util.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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default",
      "name": "default",
      "type": "Microsoft.Sql/resourceGroups/managedInstances/databases/backupLongTermRetentionPolicies",
      "properties": {
        "weeklyRetention": "P1M",
        "monthlyRetention": "P1Y",
        "yearlyRetention": "P5Y",
        "weekOfYear": 5
      }
    }
  ]
}

Definições

Name	Description
ManagedInstanceLongTermRetentionPolicy	Uma política de retenção a longo prazo.
ManagedInstanceLongTermRetentionPolicyListResult	Uma lista de políticas de retenção de longo prazo.

ManagedInstanceLongTermRetentionPolicy

Object

Uma política de retenção a 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 para um backup LTR em um formato ISO 8601.
properties.weekOfYear	integer (int32)	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.

ManagedInstanceLongTermRetentionPolicyListResult

Object

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

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