Restorable Dropped Databases - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a restorable dropped database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}?api-version=2023-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}?$expand={$expand}&$filter={$filter}&api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
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.
restorableDroppedDatabaseId	path	True	string
serverName	path	True	string	The name of the server.
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.
$expand	query		string	The child resources to include in the response.
$filter	query		string	An OData filter expression that filters elements in the collection.

Responses

Name	Type	Description
200 OK	RestorableDroppedDatabase	Successfully retrieved the specified restorable dropped 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 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier 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. 404 SubscriptionNotFound - The requested subscription was not found. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

RestorableDroppedDatabase

Successfully retrieved the specified restorable dropped 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 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid
400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier
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.
404 SubscriptionNotFound - The requested subscription was not found.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Gets a restorable dropped database with expand equals keys.

Gets a restorable dropped database.

Gets a restorable dropped database with expand equals keys.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb,131403269876900000?$expand=keys&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;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetRestorableDroppedDatabaseWithExpandEqualsKeys.json
// this example is just showing the usage of "RestorableDroppedDatabases_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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this RestorableDroppedDatabaseResource
RestorableDroppedDatabaseCollection collection = sqlServer.GetRestorableDroppedDatabases();

// invoke the operation
string restorableDroppedDatabaseId = "testdb,131403269876900000";
string expand = "keys";
NullableResponse<RestorableDroppedDatabaseResource> response = await collection.GetIfExistsAsync(restorableDroppedDatabaseId, expand: expand);
RestorableDroppedDatabaseResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    RestorableDroppedDatabaseData 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

{
  "sku": {
    "name": "BC_Gen4_2",
    "tier": "BusinessCritical"
  },
  "properties": {
    "databaseName": "testdb",
    "maxSizeBytes": 268435456000,
    "creationDate": "2017-05-07T04:41:33.937Z",
    "deletionDate": "2017-05-27T02:49:47.69Z",
    "backupStorageRedundancy": "Geo",
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    }
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb",
  "name": "testdb,131403269876900000",
  "type": "Microsoft.Sql/servers/restorableDroppedDatabases"
}

Gets a restorable dropped database.

Sample request

HTTP
dotnet

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb,131403269876900000?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;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetRestorableDroppedDatabase.json
// this example is just showing the usage of "RestorableDroppedDatabases_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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this RestorableDroppedDatabaseResource
RestorableDroppedDatabaseCollection collection = sqlServer.GetRestorableDroppedDatabases();

// invoke the operation
string restorableDroppedDatabaseId = "testdb,131403269876900000";
NullableResponse<RestorableDroppedDatabaseResource> response = await collection.GetIfExistsAsync(restorableDroppedDatabaseId);
RestorableDroppedDatabaseResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    RestorableDroppedDatabaseData 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

{
  "sku": {
    "name": "BC_Gen4_2",
    "tier": "BusinessCritical"
  },
  "properties": {
    "databaseName": "testdb",
    "maxSizeBytes": 268435456000,
    "creationDate": "2017-05-07T04:41:33.937Z",
    "deletionDate": "2017-05-27T02:49:47.69Z",
    "backupStorageRedundancy": "Geo"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb",
  "name": "testdb,131403269876900000",
  "type": "Microsoft.Sql/servers/restorableDroppedDatabases"
}

Definitions

Name	Description
BackupStorageRedundancy	The storage account type used to store backups for this database.
DatabaseKey	Database level key used for encryption at rest.
DatabaseKeyType	The database key type. Only supported value is 'AzureKeyVault'.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
RestorableDroppedDatabase	A restorable dropped database resource.
Sku	An ARM Resource SKU.

BackupStorageRedundancy

Enumeration

The storage account type used to store backups for this database.

Value	Description
Geo
Local
Zone
GeoZone

DatabaseKey

Object

Database level key used for encryption at rest.

Name	Type	Description
creationDate	string (date-time)	The database key creation date.
subregion	string	Subregion of the server key.
thumbprint	string	Thumbprint of the database key.
type	DatabaseKeyType	The database key type. Only supported value is 'AzureKeyVault'.

DatabaseKeyType

Enumeration

The database key type. Only supported value is 'AzureKeyVault'.

Value	Description
AzureKeyVault

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.