Managed Instance Long Term Retention Policies - List By Database

Service:: SQL Database

API Version:: 2023-08-01

Gets a database's long term retention policy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies?api-version=2023-08-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.
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	ManagedInstanceLongTermRetentionPolicyListResult	Successfully got LTR policy for managed database.
Other Status Codes	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled. 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported. 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported. 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica. 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview. 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention. 400 LTRArchiveStorageDisabledOnHyperscaleEdition - Archiving long-term retention backups on Hyperscale databases is not enabled. 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - Setting a long-term retention policy with the backup storage access tier set to 'archive' is not supported on zone-redundant backup storage. Use either locally redundant or geo-redundant storage types. 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database. 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ResourceNotFound - The requested resource was not found. 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.

Name

Type

Description

200 OK

ManagedInstanceLongTermRetentionPolicyListResult

Successfully got LTR policy for managed database.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.
400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.
400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.
400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.
400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.
400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.
400 LTRArchiveStorageDisabledOnHyperscaleEdition - Archiving long-term retention backups on Hyperscale databases is not enabled.
400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - Setting a long-term retention policy with the backup storage access tier set to 'archive' is not supported on zone-redundant backup storage. Use either locally redundant or geo-redundant storage types.
400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.
400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ResourceNotFound - The requested resource was not found.
409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.

Examples

Get the long term retention policies for the managed database.

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

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/ManagedInstanceLongTermRetentionPolicyListByDatabase.json
// this example is just showing the usage of "ManagedInstanceLongTermRetentionPolicies_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 = "testResourceGroup";
string managedInstanceName = "testInstance";
string databaseName = "testDatabase";
ResourceIdentifier managedDatabaseResourceId = ManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName);
ManagedDatabaseResource managedDatabase = client.GetManagedDatabaseResource(managedDatabaseResourceId);

// get the collection of this ManagedInstanceLongTermRetentionPolicyResource
ManagedInstanceLongTermRetentionPolicyCollection collection = managedDatabase.GetManagedInstanceLongTermRetentionPolicies();

// invoke the operation and iterate over the result
await foreach (ManagedInstanceLongTermRetentionPolicyResource 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
    ManagedInstanceLongTermRetentionPolicyData 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

Sample response

Status code:: 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,
        "backupStorageAccessTier": "Archive"
      }
    }
  ]
}

Definitions

Name	Description
BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backups
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedInstanceLongTermRetentionPolicy	A long term retention policy.
ManagedInstanceLongTermRetentionPolicyListResult	A list of long term retention policies.

BackupStorageAccessTier

Enumeration

The BackupStorageAccessTier for the LTR backups

Value	Description
Hot
Archive

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedInstanceLongTermRetentionPolicy

Object

A long term retention policy.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.backupStorageAccessTier	BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backups
properties.monthlyRetention	string	The monthly retention policy for an LTR backup in an ISO 8601 format.
properties.weekOfYear	integer (int32)	The week of year to take the yearly backup in an ISO 8601 format.
properties.weeklyRetention	string	The weekly retention policy for an LTR backup in an ISO 8601 format.
properties.yearlyRetention	string	The yearly retention policy for an LTR backup in an ISO 8601 format.
type	string	Resource type.

ManagedInstanceLongTermRetentionPolicyListResult

Object

A list of long term retention policies.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ManagedInstanceLongTermRetentionPolicy[]	Array of results.

Share via

Managed Instance Long Term Retention Policies - List By Database

URI Parameters

Responses

Examples

Get the long term retention policies for the managed database.

Sample request

Sample response

Definitions

BackupStorageAccessTier

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceLongTermRetentionPolicy

ManagedInstanceLongTermRetentionPolicyListResult