Managed Databases - List By Instance

Service:: SQL Database

Version d'API:: 2025-01-01

Obtient une liste de bases de données managées.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
managedInstanceName	path	True	string	Nom de l’instance managée.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ManagedDatabaseListResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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=2025-01-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/SQL/stable/2025-01-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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "name": "testdb1",
      "type": "Microsoft.Sql/managedInstances/databases",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1",
      "location": "southeastasia",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "creationDate": "2017-08-04T15:00:17.73Z",
        "defaultSecondaryLocation": "North Europe",
        "isLedgerOn": false,
        "status": "Online"
      }
    },
    {
      "name": "testdb2",
      "type": "Microsoft.Sql/managedInstances/databases",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb2",
      "location": "southeastasia",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "creationDate": "2017-08-04T15:00:17.73Z",
        "defaultSecondaryLocation": "North Europe",
        "isLedgerOn": false,
        "status": "Online"
      }
    },
    {
      "name": "testdb3",
      "type": "Microsoft.Sql/managedInstances/databases",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb3",
      "location": "southeastasia",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "creationDate": "2017-08-04T15:00:17.73Z",
        "defaultSecondaryLocation": "North Europe",
        "extendedAccessibilityInfo": {
          "inaccessibilityReasonDescription": "Root cause explanation and mitigation action.",
          "inaccessibilityReasonErrorCode": "1",
          "inaccessibilityReasonKind": "TransparentDataEncryption",
          "inaccessibilityReasonTdeKeyUri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
        },
        "status": "Inaccessible"
      }
    }
  ]
}

Définitions

Nom	Description
CatalogCollationType	Classement du catalogue de métadonnées.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
InaccessibilityReason	Cause profonde. Les valeurs autorisées sont « TransparentDataEncryption », « DatabaseReplication » et « Unknown ».
ManagedDatabase	Ressource de base de données managée.
ManagedDatabaseCreateMode	Mode de création de base de données managée. PointInTimeRestore : Créez une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. SourceDatabaseName, SourceManagedInstanceName et PointInTime doivent être spécifiés. RestoreExternalBackup : Créez une base de données en restaurant à partir de fichiers de sauvegarde externes. Le classement, StorageContainerUri et StorageContainerSasToken doivent être spécifiés. Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. RecoverableDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer. RestoreLongTermRetentionBackup : créez une base de données en effectuant une restauration à partir d’une sauvegarde de rétention à long terme (longTermRetentionBackupResourceId requis).
ManagedDatabaseExtendedAccessibilityInfo	Informations sur l’accessibilité étendue de la base de données gérée
ManagedDatabaseListResult	La réponse d’une opération de liste ManagedDatabase.
ManagedDatabaseStatus	État de la base de données.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CatalogCollationType

Énumération

Classement du catalogue de métadonnées.

Valeur	Description
DATABASE_DEFAULT	DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS	SQL_Latin1_General_CP1_CI_AS

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

InaccessibilityReason

Énumération

Cause profonde. Les valeurs autorisées sont « TransparentDataEncryption », « DatabaseReplication » et « Unknown ».

Valeur	Description
Unknown	Inconnu
TransparentDataEncryption	TransparentDataEncryption
DatabaseReplication	Réplication de bases de données

ManagedDatabase

Objet

Ressource de base de données managée.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.autoCompleteRestore	boolean	Indique s’il faut effectuer automatiquement la restauration de cette base de données managée.
properties.catalogCollation	CatalogCollationType	Classement du catalogue de métadonnées.
properties.collation	string	Classement de la base de données managée.
properties.createMode	ManagedDatabaseCreateMode	Mode de création de base de données managée. PointInTimeRestore : Créez une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. SourceDatabaseName, SourceManagedInstanceName et PointInTime doivent être spécifiés. RestoreExternalBackup : Créez une base de données en restaurant à partir de fichiers de sauvegarde externes. Le classement, StorageContainerUri et StorageContainerSasToken doivent être spécifiés. Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. RecoverableDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer. RestoreLongTermRetentionBackup : créez une base de données en effectuant une restauration à partir d’une sauvegarde de rétention à long terme (longTermRetentionBackupResourceId requis).
properties.creationDate	string (date-time)	Date de création de la base de données.
properties.crossSubscriptionRestorableDroppedDatabaseId	string	L’ID de ressource de base de données pouvant être restauré entre abonnements a été supprimé lors de la création de cette base de données.
properties.crossSubscriptionSourceDatabaseId	string	Identificateur de ressource de la base de données source inter-abonnement associée à l’opération de création de cette base de données.
properties.crossSubscriptionTargetManagedInstanceId	string	ID d’instance managée cible utilisé dans la restauration entre abonnements.
properties.defaultSecondaryLocation	string	Région géo-jumelée.
properties.earliestRestorePoint	string (date-time)	Point de restauration le plus ancien dans le temps pour la restauration dans le temps.
properties.extendedAccessibilityInfo	ManagedDatabaseExtendedAccessibilityInfo	Informations supplémentaires sur l’observabilité et le dépannage des bases de données à l’état « Inaccessible ».
properties.failoverGroupId	string	Identificateur de ressource de groupe de basculement d’instance auquel appartient cette base de données managée.
properties.isLedgerOn	boolean	Indique si cette base de données est une base de données de registre, ce qui signifie que toutes les tables de la base de données sont des tables de registre. Remarque : la valeur de cette propriété ne peut pas être modifiée une fois la base de données créée.
properties.lastBackupName	string	Nom du dernier fichier de sauvegarde pour la restauration de cette base de données managée.
properties.longTermRetentionBackupResourceId	string	Nom de la sauvegarde de rétention à long terme à utiliser pour la restauration de cette base de données managée.
properties.recoverableDatabaseId	string	Identificateur de ressource de la base de données récupérable associée à l’opération de création de cette base de données.
properties.restorableDroppedDatabaseId	string	ID de ressource de base de données supprimé pouvant être restauré lors de la création de cette base de données.
properties.restorePointInTime	string (date-time)	Conditional. Si createMode est PointInTimeRestore, cette valeur est requise. Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restauré pour créer la nouvelle base de données.
properties.sourceDatabaseId	string	Identificateur de ressource de la base de données source associée à l’opération de création de cette base de données.
properties.status	ManagedDatabaseStatus	État de la base de données.
properties.storageContainerIdentity	string	Conditional. Si createMode est RestoreExternalBackup, cette valeur est utilisée. Spécifie l’identité utilisée pour l’authentification de conteneur de stockage. Peut être « SharedAccessSignature » ou « ManagedIdentity » ; s’il n’est pas spécifié « SharedAccessSignature » est supposé.
properties.storageContainerSasToken	string	Conditional. Si createMode est RestoreExternalBackup et storageContainerIdentity n’est pas ManagedIdentity, cette valeur est requise. Spécifie le jeton sas du conteneur de stockage.
properties.storageContainerUri	string	Conditional. Si createMode est RestoreExternalBackup, cette valeur est requise. Spécifie l’URI du conteneur de stockage dans lequel les sauvegardes de cette restauration sont stockées.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ManagedDatabaseCreateMode

Énumération

Mode de création de base de données managée. PointInTimeRestore : Créez une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. SourceDatabaseName, SourceManagedInstanceName et PointInTime doivent être spécifiés. RestoreExternalBackup : Créez une base de données en restaurant à partir de fichiers de sauvegarde externes. Le classement, StorageContainerUri et StorageContainerSasToken doivent être spécifiés. Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. RecoverableDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer. RestoreLongTermRetentionBackup : créez une base de données en effectuant une restauration à partir d’une sauvegarde de rétention à long terme (longTermRetentionBackupResourceId requis).

Valeur	Description
Default	Par défaut
RestoreExternalBackup	RestoreExternalBackup
PointInTimeRestore	PointInTimeRestore
Recovery	Récupération
RestoreLongTermRetentionBackup	RestoreLongtermRetentionBackup

ManagedDatabaseExtendedAccessibilityInfo

Objet

Informations sur l’accessibilité étendue de la base de données gérée

Nom	Type	Description
inaccessibilityReasonDescription	string	Explication de la cause profonde et mesures d’atténuation.
inaccessibilityReasonErrorCode	string	Le code d’erreur SQL Server est lié à la cause racine de l’inaccessibilité.
inaccessibilityReasonKind	InaccessibilityReason	Cause profonde. Les valeurs autorisées sont « TransparentDataEncryption », « DatabaseReplication » et « Unknown ».
inaccessibilityReasonTdeKeyUri	string	Pour la cause profonde, tapez « TransparentDataEncryption », l’URI CMK.

ManagedDatabaseListResult

Objet

La réponse d’une opération de liste ManagedDatabase.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	ManagedDatabase[]	Les éléments de la Base de Données Gérée sur cette page

ManagedDatabaseStatus

Énumération

État de la base de données.

Valeur	Description
Online	En ligne
Offline	Hors ligne
Shutdown	Arrêt
Creating	Création
Inaccessible	Inaccessible
Restoring	Restauration
Updating	Mise à jour
Stopping	Arrêt
Stopped	Arrêté
Starting	Démarrage
DbMoving	DbMoving
DbCopying	DbCopying

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.