Managed Backup Short Term Retention Policies - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a managed database's short term retention policy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies/default?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
managedInstanceName	path	True	string	The name of the managed instance.
policyName	path	True	ManagedShortTermRetentionPolicyName	The policy name.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	ManagedBackupShortTermRetentionPolicy	Successfully retrieved the policy.
Other Status Codes		*** Error Responses: *** 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.) 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier 400 InvalidParameterValue - An invalid value was given to a parameter. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Get the short term retention policy for the database.

Sample request

HTTP

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

Java

import com.azure.resourcemanager.sql.models.ManagedShortTermRetentionPolicyName;

/**
 * Samples for ManagedBackupShortTermRetentionPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetManagedShortTermRetentionPolicy.
     * json
     */
    /**
     * Sample code: Get the short term retention policy for the database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheShortTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedBackupShortTermRetentionPolicies().getWithResponse(
            "Default-SQL-SouthEastAsia", "testsvr", "testdb", ManagedShortTermRetentionPolicyName.DEFAULT,
            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

Sample response

Status code:

200

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

Definitions

Name	Description
ManagedBackupShortTermRetentionPolicy	A short term retention policy.
ManagedShortTermRetentionPolicyName	The policy name.

ManagedBackupShortTermRetentionPolicy

A short term retention policy.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.retentionDays	integer	The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
type	string	Resource type.

ManagedShortTermRetentionPolicyName

The policy name.

Name	Type	Description
default	string