Recoverable Managed Databases - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a recoverable managed database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/recoverableDatabases/{recoverableDatabaseName}?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
recoverableDatabaseName	path	True	string
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	RecoverableManagedDatabase	Successfully retrieved the specified recoverable 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 InvalidRecoverableDatabaseId - Invalid recoverable database identifier. 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again. 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy. 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\n', '\r') in lastBackupName. 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed. 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server. 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state. 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored. 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress. 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled. 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator. 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request. 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled. 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled. 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled. 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled. 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled. 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool. 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled. 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 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances. 409 InstancePoolBusy - An instance pool is busy with another ongoing operation 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance. 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant. 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress. 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant. 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress. 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s). 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout.

Name

Type

Description

200 OK

RecoverableManagedDatabase

Successfully retrieved the specified recoverable 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 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.
400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.
400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.
400 LastBackupNameHasNewline - Please do not use forbidden characters ('\n', '\r') in lastBackupName.
400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.
400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes
400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.
400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.
400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.
400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.
400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.
400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.
400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.
400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.
400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.
400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.
400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.
400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.
400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.
400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.
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 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.
409 InstancePoolBusy - An instance pool is busy with another ongoing operation
409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.
409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.
409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.
409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.
409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.
409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).
412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Gets a recoverable databases by managed instances

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/managedInstance/recoverableDatabases/testdb?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/GetRecoverableManagedDatabase.json
// this example is just showing the usage of "RecoverableManagedDatabases_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 RecoverableManagedDatabaseResource created on azure
// for more information of creating RecoverableManagedDatabaseResource, please refer to the document of RecoverableManagedDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Test1";
string managedInstanceName = "managedInstance";
string recoverableDatabaseName = "testdb";
ResourceIdentifier recoverableManagedDatabaseResourceId = RecoverableManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, recoverableDatabaseName);
RecoverableManagedDatabaseResource recoverableManagedDatabase = client.GetRecoverableManagedDatabaseResource(recoverableManagedDatabaseResourceId);

// invoke the operation
RecoverableManagedDatabaseResource result = await recoverableManagedDatabase.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
RecoverableManagedDatabaseData 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

{
  "properties": {
    "lastAvailableBackupDate": "2017-05-26T01:06:29.78Z"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/managedInstances/recoverableDatabases"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
RecoverableManagedDatabase	A recoverable managed database resource.

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.

RecoverableManagedDatabase

Object

A recoverable managed database resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.lastAvailableBackupDate	string	The last available backup date.
type	string	Resource type.

Share via

Recoverable Managed Databases - Get

URI Parameters

Responses

Examples

Gets a recoverable databases by managed instances

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RecoverableManagedDatabase