Managed Backup Short Term Retention Policies - List By Database

Serviço:

SQL Database

Versão da API:

2023-08-01

Obtém a lista de políticas de retenção de curto prazo de um banco de dados gerenciado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies?api-version=2023-08-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.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
subscriptionId	path	True	string	A ID da 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	ManagedBackupShortTermRetentionPolicyListResult	A política foi recuperada com êxito.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidBackupRetentionDays - Os dias de retenção de {0} não são uma configuração válida. A retenção de backup válida deve estar em incrementos de 7 dias (7, 14, 21 etc.) 400 InvalidRestorableDroppedDatabaseDeletionDeletionDate – a data de exclusão de banco de dados descartada restaurável fornecida é inválida 400 InvalidRestorableDroppedDatabaseId - Identificador de banco de dados descartado restaurável inválido 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro. 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ResourceNotFound – O recurso solicitado não foi encontrado.

Exemplos

Get the short term retention policy list for the database.

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb/backupShortTermRetentionPolicies?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetListManagedShortTermRetentionPolicy.json
// this example is just showing the usage of "ManagedBackupShortTermRetentionPolicies_ListByDatabase" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedDatabaseResource created on azure
// for more information of creating ManagedDatabaseResource, please refer to the document of ManagedDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier managedDatabaseResourceId = ManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName);
ManagedDatabaseResource managedDatabase = client.GetManagedDatabaseResource(managedDatabaseResourceId);

// get the collection of this ManagedBackupShortTermRetentionPolicyResource
ManagedBackupShortTermRetentionPolicyCollection collection = managedDatabase.GetManagedBackupShortTermRetentionPolicies();

// invoke the operation and iterate over the result
await foreach (ManagedBackupShortTermRetentionPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ManagedBackupShortTermRetentionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb,131403269876900000/backupShortTermRetentionPolicies/default",
      "name": "default",
      "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies",
      "properties": {
        "retentionDays": 14
      }
    }
  ]
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedBackupShortTermRetentionPolicy	Uma política de retenção de curto prazo.
ManagedBackupShortTermRetentionPolicyListResult	Uma lista de políticas de retenção de curto prazo.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedBackupShortTermRetentionPolicy

Objeto

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

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.retentionDays	integer (int32)	O período de retenção de backup em dias. Este é o número de dias que a Restauração Pontual terá suporte.
type	string	Tipo de recurso.

ManagedBackupShortTermRetentionPolicyListResult

Objeto

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

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