Long Term Retention Managed Instance Backups - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a long term retention backup for a managed database.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
backupName	path	True	string	The backup name.
databaseName	path	True	string	The name of the managed database.
locationName	path	True	string	The location of the database.
managedInstanceName	path	True	string	The name of the managed instance.
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	ManagedInstanceLongTermRetentionBackup	Successfully retrieved the backup.
Other Status Codes		*** Error Responses: *** 400 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances. 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 long term retention backup of a managed database.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase/longTermRetentionManagedInstanceBackups/55555555-6666-7777-8888-999999999999;131637960820000000?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for LongTermRetentionManagedInstanceBackups Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceLongTermRetentionBackupGet.json
     */
    /**
     * Sample code: Get the long term retention backup of a managed database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionBackupOfAManagedDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionManagedInstanceBackups().getWithResponse(
            "japaneast", "testInstance", "testDatabase", "55555555-6666-7777-8888-999999999999;131637960820000000",
            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/Locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase/longTermRetentionManagedInstanceBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
  "name": "55555555-6666-7777-8888-999999999999;131637960820000000",
  "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
  "properties": {
    "managedInstanceName": "testInstance",
    "managedInstanceCreateTime": "2017-09-01T08:00:00Z",
    "databaseName": "testDatabase",
    "databaseDeletionTime": null,
    "backupTime": "2018-08-23T08:00:00Z",
    "backupStorageRedundancy": "Geo"
  }
}

Definitions

Name	Description
BackupStorageRedundancy	The storage redundancy type of the backup
ManagedInstanceLongTermRetentionBackup	A long term retention backup for a managed database.

BackupStorageRedundancy

The storage redundancy type of the backup

Name	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

ManagedInstanceLongTermRetentionBackup

A long term retention backup for a managed database.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.backupExpirationTime	string	The time the long term retention backup will expire.
properties.backupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the backup
properties.backupTime	string	The time the backup was taken
properties.databaseDeletionTime	string	The delete time of the database
properties.databaseName	string	The name of the database the backup belong to
properties.managedInstanceCreateTime	string	The create time of the instance.
properties.managedInstanceName	string	The managed instance that the backup database belongs to.
type	string	Resource type.