Managed Databases - List By Instance

Serviço:: SQL Database

Versão da API:: 2025-01-01

Obtém uma lista de bancos de dados gerenciados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ManagedDatabaseListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List databases by managed instances

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/managedInstance/databases?api-version=2025-01-01


/**
 * Samples for ManagedDatabases ListByInstance.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedDatabaseListByManagedInstance.json
     */
    /**
     * Sample code: List databases by managed instances.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void listDatabasesByManagedInstances(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedDatabases().listByInstance("Test1", "managedInstance",
            com.azure.core.util.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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_database_list_by_managed_instance.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_databases.list_by_instance(
        resource_group_name="Test1",
        managed_instance_name="managedInstance",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ManagedDatabaseListByManagedInstance.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a list of managed databases.
 *
 * @summary gets a list of managed databases.
 * x-ms-original-file: 2025-01-01/ManagedDatabaseListByManagedInstance.json
 */
async function listDatabasesByManagedInstances() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedDatabases.listByInstance("Test1", "managedInstance")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Resposta de exemplo

Código de status:: 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"
      }
    }
  ]
}

Definições

Nome	Description
CatalogCollationType	Ordenação do catálogo de metadados.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
InaccessibilityReason	Tipo de causa raiz. Os valores permitidos são "TransparentDataEncryption", "DatabaseReplication" e "Unknown".
ManagedDatabase	Um recurso de banco de dados gerenciado.
ManagedDatabaseCreateMode	Modo de criação de banco de dados gerenciado. PointInTimeRestore: crie um banco de dados restaurando um backup pontual de um banco de dados existente. SourceDatabaseName, SourceManagedInstanceName e PointInTime devem ser especificados. RestoreExternalBackup: crie um banco de dados restaurando a partir de arquivos de backup externos. Collation, StorageContainerUri e StorageContainerSasToken devem ser especificados. Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. RecoverableDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada. RestoreLongTermRetentionBackup: crie um banco de dados restaurando de um backup de retenção de longo prazo (longTermRetentionBackupResourceId necessário).
ManagedDatabaseExtendedAccessibilityInfo	Informações de acessibilidade estendida do banco de dados gerenciado
ManagedDatabaseListResult	A resposta de uma operação de lista GerenciadaDatabase.
ManagedDatabaseStatus	Status do banco de dados.
systemData	Metadados relativos à criação e última modificação do recurso.

CatalogCollationType

Enumeração

Ordenação do catálogo de metadados.

Valor	Description
DATABASE_DEFAULT	DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS	SQL_Latin1_General_CP1_CI_AS

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

InaccessibilityReason

Enumeração

Tipo de causa raiz. Os valores permitidos são "TransparentDataEncryption", "DatabaseReplication" e "Unknown".

Valor	Description
Unknown	Unknown
TransparentDataEncryption	TransparentDataEncryption
DatabaseReplication	Replicação de Banco de Dados

ManagedDatabase

Objeto

Um recurso de banco de dados gerenciado.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.autoCompleteRestore	boolean	Se deseja concluir automaticamente a restauração desse banco de dados gerenciado.
properties.catalogCollation	CatalogCollationType	Ordenação do catálogo de metadados.
properties.collation	string	Ordenação do banco de dados gerenciado.
properties.createMode	ManagedDatabaseCreateMode	Modo de criação de banco de dados gerenciado. PointInTimeRestore: crie um banco de dados restaurando um backup pontual de um banco de dados existente. SourceDatabaseName, SourceManagedInstanceName e PointInTime devem ser especificados. RestoreExternalBackup: crie um banco de dados restaurando a partir de arquivos de backup externos. Collation, StorageContainerUri e StorageContainerSasToken devem ser especificados. Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. RecoverableDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada. RestoreLongTermRetentionBackup: crie um banco de dados restaurando de um backup de retenção de longo prazo (longTermRetentionBackupResourceId necessário).
properties.creationDate	string (date-time)	Data de criação do banco de dados.
properties.crossSubscriptionRestorableDroppedDatabaseId	string	A ID de recurso de banco de dados removida da assinatura cruzada restaurável para restaurar ao criar esse banco de dados.
properties.crossSubscriptionSourceDatabaseId	string	O identificador de recurso do banco de dados de origem entre assinaturas associado à operação de criação desse banco de dados.
properties.crossSubscriptionTargetManagedInstanceId	string	ID da instância gerenciada de destino usada na restauração entre assinaturas.
properties.defaultSecondaryLocation	string	Região emparelhada geograficamente.
properties.earliestRestorePoint	string (date-time)	Ponto de restauração mais antigo no tempo para restauração pontual.
properties.extendedAccessibilityInfo	ManagedDatabaseExtendedAccessibilityInfo	Informações adicionais de observabilidade e solução de problemas para bancos de dados no estado "Inacessível".
properties.failoverGroupId	string	Identificador de recurso do Grupo de Failover de Instância ao qual esse banco de dados gerenciado pertence.
properties.isLedgerOn	boolean	Se esse banco de dados é ou não um banco de dados do razão, o que significa que todas as tabelas no banco de dados são tabelas do razão. Observação: o valor dessa propriedade não pode ser alterado após a criação do banco de dados.
properties.lastBackupName	string	Sobrenome do arquivo de backup para restauração desse banco de dados gerenciado.
properties.longTermRetentionBackupResourceId	string	O nome do backup de Retenção de Longo Prazo a ser usado para restauração desse banco de dados gerenciado.
properties.recoverableDatabaseId	string	O identificador de recurso do banco de dados recuperável associado à operação de criação desse banco de dados.
properties.restorableDroppedDatabaseId	string	A ID de recurso de banco de dados descartada restaurável a ser restaurada ao criar esse banco de dados.
properties.restorePointInTime	string (date-time)	Conditional. Se createMode for PointInTimeRestore, esse valor será necessário. Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados.
properties.sourceDatabaseId	string	O identificador de recurso do banco de dados de origem associado à operação de criação deste banco de dados.
properties.status	ManagedDatabaseStatus	Status do banco de dados.
properties.storageContainerIdentity	string	Conditional. Se createMode for RestoreExternalBackup, esse valor será usado. Especifica a identidade usada para autenticação de contêiner de armazenamento. Pode ser 'SharedAccessSignature' ou 'ManagedIdentity'; se não for especificado 'SharedAccessSignature' será assumido.
properties.storageContainerSasToken	string	Conditional. Se createMode for RestoreExternalBackup e storageContainerIdentity não for ManagedIdentity, esse valor será necessário. Especifica o token sas do contêiner de armazenamento.
properties.storageContainerUri	string	Conditional. Se createMode for RestoreExternalBackup, esse valor será necessário. Especifica o uri do contêiner de armazenamento em que os backups para essa restauração são armazenados.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

ManagedDatabaseCreateMode

Enumeração

Modo de criação de banco de dados gerenciado. PointInTimeRestore: crie um banco de dados restaurando um backup pontual de um banco de dados existente. SourceDatabaseName, SourceManagedInstanceName e PointInTime devem ser especificados. RestoreExternalBackup: crie um banco de dados restaurando a partir de arquivos de backup externos. Collation, StorageContainerUri e StorageContainerSasToken devem ser especificados. Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. RecoverableDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada. RestoreLongTermRetentionBackup: crie um banco de dados restaurando de um backup de retenção de longo prazo (longTermRetentionBackupResourceId necessário).

Valor	Description
Default	Default
RestoreExternalBackup	RestoreExternalBackup
PointInTimeRestore	PointInTimeRestore
Recovery	Recuperação
RestoreLongTermRetentionBackup	RestoreLongtermRetentionBackup

ManagedDatabaseExtendedAccessibilityInfo

Objeto

Informações de acessibilidade estendida do banco de dados gerenciado

Nome	Tipo	Description
inaccessibilityReasonDescription	string	Explicação da causa raiz e ação de mitigação.
inaccessibilityReasonErrorCode	string	Código de erro do SQL Server ligado à causa raiz da inacessibilidade.
inaccessibilityReasonKind	InaccessibilityReason	Tipo de causa raiz. Os valores permitidos são "TransparentDataEncryption", "DatabaseReplication" e "Unknown".
inaccessibilityReasonTdeKeyUri	string	Para o tipo de causa raiz "TransparentDataEncryption", o URI da CMK.

ManagedDatabaseListResult

Objeto

A resposta de uma operação de lista GerenciadaDatabase.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	ManagedDatabase[]	Os itens do Managed Database nesta página

ManagedDatabaseStatus

Enumeração

Status do banco de dados.

Valor	Description
Online	Online
Offline	Offline
Shutdown	Desligamento
Creating	Criando
Inaccessible	Inacessível
Restoring	Restaurar
Updating	Atualização
Stopping	Parar
Stopped	Parado
Starting	Iniciando
DbMoving	DbMoving
DbCopying	DbCopying

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.