Managed Instance Long Term Retention Policies - Get

Service:

SQL Database

API Version:

2021-11-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/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.
managedInstanceName	path	True	string	O nome da instância gerenciada.
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	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.
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	ManagedInstanceLongTermRetentionPolicy	Obteve com êxito a política LTR para o banco de dados gerenciado.
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 managed database.

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.ManagedInstanceLongTermRetentionPolicyName;

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/testResourceGroup/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

Nome	Description
ManagedInstanceLongTermRetentionPolicy	Uma política de retenção de longo prazo.
ManagedInstanceLongTermRetentionPolicyName	O nome da política. Deve ser sempre Padrão.

ManagedInstanceLongTermRetentionPolicy

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.

ManagedInstanceLongTermRetentionPolicyName

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

Nome	Tipo	Description
default	string