Managed Backup Short Term Retention Policies - Get

Service:: SQL Database

API Version:: 2023-08-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=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.
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	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 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 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.

Name

Type

Description

200 OK

ManagedBackupShortTermRetentionPolicy

Successfully retrieved the policy.

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 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 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.

Examples

Get the short term retention policy for the database.

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=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/GetManagedShortTermRetentionPolicy.json
// this example is just showing the usage of "ManagedBackupShortTermRetentionPolicies_Get" 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 ManagedBackupShortTermRetentionPolicyResource created on azure
// for more information of creating ManagedBackupShortTermRetentionPolicyResource, please refer to the document of ManagedBackupShortTermRetentionPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "testsvr";
string databaseName = "testdb";
ManagedShortTermRetentionPolicyName policyName = ManagedShortTermRetentionPolicyName.Default;
ResourceIdentifier managedBackupShortTermRetentionPolicyResourceId = ManagedBackupShortTermRetentionPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName, policyName);
ManagedBackupShortTermRetentionPolicyResource managedBackupShortTermRetentionPolicy = client.GetManagedBackupShortTermRetentionPolicyResource(managedBackupShortTermRetentionPolicyResourceId);

// invoke the operation
ManagedBackupShortTermRetentionPolicyResource result = await managedBackupShortTermRetentionPolicy.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedBackupShortTermRetentionPolicy	A short term retention policy.
ManagedShortTermRetentionPolicyName	The policy name.

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.

ManagedBackupShortTermRetentionPolicy

Object

A short term retention policy.

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

ManagedShortTermRetentionPolicyName

Enumeration

The policy name.

Value	Description
default

Share via

Managed Backup Short Term Retention Policies - Get

URI Parameters

Responses

Examples

Get the short term retention policy for the database.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedBackupShortTermRetentionPolicy

ManagedShortTermRetentionPolicyName