Compartilhar via


Conectar-se ao Azure DocumentDB usando o portal do Azure

O Shell do MongoDB (mongosh) é um ambiente javaScript e Node.js para interagir com implantações do MongoDB. É uma ferramenta popular da comunidade para testar consultas e interagir com os dados no cluster do Azure DocumentDB. O portal do Azure contém várias ferramentas para consultar dados do MongoDB, incluindo o Azure Cloud Shell. O Azure Cloud Shell é um terminal interativo, autenticado e acessível pelo navegador para o gerenciamento de recursos do Azure. Este artigo explica como se conectar a um cluster do Azure DocumentDB usando o Shell do MongoDB no Azure Cloud Shell.

Pré-requisitos

  • Uma assinatura do Azure

    • Se você não tiver uma assinatura do Azure, crie uma conta gratuita
  • Um cluster existente do Azure DocumentDB

  • Regras de firewall que permitem que os clientes em suas redes se conectem ao cluster. Para obter mais informações, consulte configurar o firewall.

  • (Opcional) Esses pré-requisitos só serão necessários se você estiver usando o Azure Cloud Shell em uma rede virtual igual ou emparelhada com o Azure DocumentDB.

    • Uma ou mais redes virtuais existentes do Azure com sub-redes para implantação do Azure Cloud Shell e do Azure DocumentDB.

    • Um ponto de extremidade privado para o cluster do Azure DocumentDB. Para obter mais informações, consulte configurar o link privado.

    • O Azure Cloud Shell foi implantado na mesma rede virtual ou em uma rede virtual emparelhada, com conectividade para o ponto de extremidade privado do Azure DocumentDB. Para obter mais informações, consulte implantar o Cloud Shell na rede virtual.

Habilitar o acesso ao cluster do Azure Cloud Shell

Primeiro, verifique se o Azure Cloud Shell pode acessar seu cluster do Azure DocumentDB permitindo seus endereços IP no firewall.

  1. Entre no portal do Azure (https://portal.azure.com).

  2. Navegue até o cluster do Azure DocumentDB.

  3. Selecione Rede no menu de navegação.

  4. Na página Rede na seção Acesso público , selecione a opção + Adicionar IPs do Azure Cloud Shell para adicionar automaticamente seu endereço IP atual à lista de permissões.

  5. Selecione Salvar para aplicar as alterações.

Observação

Para garantir a conectividade, verifique se os endereços IP específicos para sua região são permitidos. Para obter mais informações, consulte endereços IP para o Azure DocumentDB.

Conectar-se usando o Azure Cloud Shell no Início Rápido

Para se conectar diretamente ao Azure DocumentDB usando o Shell do MongoDB, use a experiência de Início Rápido disponível na página do recurso no portal do Azure.

  1. Na página de recursos do cluster, selecione Início rápido (versão prévia) no menu de navegação.

  2. Em seguida, selecione Abrir shell do MongoDB.

  3. Aguarde o início do ambiente do Shell do MongoDB.

  4. Quando o ambiente estiver pronto, insira Y para aceitar o aviso.

    Observação

    Se você estiver enfrentando um problema de conexão usando o MongoDB Shell depois de aceitar o aviso, verifique se o Azure Cloud Shell tem acesso ao cluster.

  5. Agora, insira sua senha para conectar seu cluster ao Cloud Shell.

Obter credenciais do cluster

Obtenha a cadeia de conexão necessária para se conectar a esse cluster.

  1. Entre no portal do Azure (https://portal.azure.com).

  2. Navegue até o cluster existente do Azure DocumentDB.

Obtenha as credenciais que você usa para se conectar ao cluster.

  1. Na página do cluster, selecione a opção Cadeias de conexão no menu de recursos.

  2. Na seção Cadeias de conexão , copie ou registre o valor do campo Cadeia de conexão .

Captura de tela mostrando a opção de cadeias de conexão.

Importante

A cadeia de conexão no portal não inclui o valor da senha. Você deve substituir o <password> placeholder pelas credenciais inseridas quando criou o cluster ou inserir a senha de forma interativa.

Configurar o Shell do MongoDB no Azure Cloud Shell manualmente

Instale o Shell do MongoDB (mongosh) na instância do Azure Cloud Shell usando o Gerenciador de Pacotes do Nó (npm).

  1. Abra o Azure Cloud Shell configurado com um ambiente de script bash.

  2. Instale a versão 1 do Shell do MongoDB localmente no diretório do usuário.

    npm install mongosh@1
    
  3. Aguarde a conclusão da instalação.

  4. Verifique se a instalação foi bem-sucedida obtendo a versão da mongosh ferramenta.

    npx mongosh --version
    

Conectar-se ao cluster

Conecte-se ao cluster usando o Shell do MongoDB com uma cadeia de conexão que não inclui uma senha. Use o prompt de senha interativa para inserir sua senha como parte das etapas de conexão.

  1. Conecte-se inserindo a senha na linha de comando do MongoDB Shell. Para esta etapa, use uma cadeia de conexão sem a senha.

    npx mongosh "mongodb+srv://<username>@<cluster-name>.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    
  2. Depois de fornecer a senha e ser autenticado com êxito, observe o aviso exibido.

    ------
       Warning: Non-Genuine MongoDB Detected
       This server or service appears to be an emulation of MongoDB rather than an official MongoDB product.
    ------
    

    Dica

    Você pode ignorar este aviso com segurança. Esse aviso é gerado porque a cadeia de conexão contém cosmos.azure. O Azure DocumentDB é uma oferta de PaaS (plataforma como serviço) nativa do Azure.

Executar consultas de teste

Verifique se você está conectado com êxito ao cluster executando uma série de comandos e consultas de teste.

  1. Verifique o status da conexão executando o connectionStatus comando.

    db.runCommand({connectionStatus: 1})
    
    {
      ...
      ok: 1
    }
    
  2. Liste os bancos de dados em seu cluster.

    show dbs
    
  3. Mude para um banco de dados específico. Substitua o marcador <database-name> pelo nome de um banco de dados qualquer em seu cluster.

    use <database-name>
    

    Dica

    Por exemplo, se o nome do banco de dados for inventory, o comando será use inventory.

  4. Liste as coleções no banco de dados.

    show collections
    
  5. Localize os cinco primeiros itens em uma coleção específica. Substitua o marcador <collection-name> pelo nome de qualquer coleção em seu cluster.

    db.<collection-name>.find().limit(5)
    

    Dica

    Por exemplo, se o nome da coleção for equipment, o comando será db.equipment.find().limit(5).