Managed Databases - List By Instance

Service:: SQL Database

API Version:: 2023-08-01

Gets a list of managed databases.

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

URI Parameters

Name	In	Required	Type	Description
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	ManagedDatabaseListResult	Successfully retrieved the list of databases.
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 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found

Name

Type

Description

200 OK

ManagedDatabaseListResult

Successfully retrieved the list of databases.

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
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found

Examples

List databases by managed instances

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

// get the collection of this ManagedDatabaseResource
ManagedDatabaseCollection collection = managedInstance.GetManagedDatabases();

// invoke the operation and iterate over the result
await foreach (ManagedDatabaseResource 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
    ManagedDatabaseData 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/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1",
      "location": "southeastasia",
      "name": "testdb1",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "creationDate": "2017-08-04T15:00:17.73Z",
        "defaultSecondaryLocation": "North Europe",
        "status": "Online",
        "isLedgerOn": false
      },
      "type": "Microsoft.Sql/managedInstances/databases"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb2",
      "location": "southeastasia",
      "name": "testdb2",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "creationDate": "2017-08-04T15:00:17.73Z",
        "defaultSecondaryLocation": "North Europe",
        "status": "Online",
        "isLedgerOn": false
      },
      "type": "Microsoft.Sql/managedInstances/databases"
    }
  ]
}

Definitions

Name	Description
CatalogCollationType	Collation of the metadata catalog.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedDatabase	A managed database resource.
ManagedDatabaseCreateMode	Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).
ManagedDatabaseListResult	A list of managed databases.
ManagedDatabaseStatus	Status of the database.

CatalogCollationType

Enumeration

Collation of the metadata catalog.

Value	Description
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

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.

ManagedDatabase

Object

A managed database resource.

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.autoCompleteRestore	boolean	Whether to auto complete restore of this managed database.
properties.catalogCollation	CatalogCollationType	Collation of the metadata catalog.
properties.collation	string	Collation of the managed database.
properties.createMode	ManagedDatabaseCreateMode	Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).
properties.creationDate	string (date-time)	Creation date of the database.
properties.crossSubscriptionRestorableDroppedDatabaseId	string	The restorable cross-subscription dropped database resource id to restore when creating this database.
properties.crossSubscriptionSourceDatabaseId	string	The resource identifier of the cross-subscription source database associated with create operation of this database.
properties.crossSubscriptionTargetManagedInstanceId	string	Target managed instance id used in cross-subscription restore.
properties.defaultSecondaryLocation	string	Geo paired region.
properties.earliestRestorePoint	string (date-time)	Earliest restore point in time for point in time restore.
properties.failoverGroupId	string	Instance Failover Group resource identifier that this managed database belongs to.
properties.isLedgerOn	boolean	Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
properties.lastBackupName	string	Last backup file name for restore of this managed database.
properties.longTermRetentionBackupResourceId	string	The name of the Long Term Retention backup to be used for restore of this managed database.
properties.recoverableDatabaseId	string	The resource identifier of the recoverable database associated with create operation of this database.
properties.restorableDroppedDatabaseId	string	The restorable dropped database resource id to restore when creating this database.
properties.restorePointInTime	string (date-time)	Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
properties.sourceDatabaseId	string	The resource identifier of the source database associated with create operation of this database.
properties.status	ManagedDatabaseStatus	Status of the database.
properties.storageContainerIdentity	string	Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed.
properties.storageContainerSasToken	string	Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token.
properties.storageContainerUri	string	Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.
tags	object	Resource tags.
type	string	Resource type.

ManagedDatabaseCreateMode

Enumeration

Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).

Value	Description
Default
RestoreExternalBackup
PointInTimeRestore
Recovery
RestoreLongTermRetentionBackup

ManagedDatabaseListResult

Object

A list of managed databases.

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

ManagedDatabaseStatus

Enumeration

Status of the database.

Value	Description
Online
Offline
Shutdown
Creating
Inaccessible
Restoring
Updating
Stopping
Stopped
Starting
DbMoving
DbCopying

Share via

Managed Databases - List By Instance

URI Parameters

Responses

Examples

List databases by managed instances

Sample request

Sample response

Definitions

CatalogCollationType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedDatabase

ManagedDatabaseCreateMode

ManagedDatabaseListResult

ManagedDatabaseStatus