Conecte-se a uma implementação que está sendo executada localmente ou no Atlas. Se a implantação estiver pausada, certifique-se de executar Atlas deployments start primeiro.
Visualização pública: o subcomando atlas api, gerado automaticamente a partir da API de administração do MongoDB Atlas , oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/ fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Sintaxe
atlas deployments connect [deploymentName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
deploymentName | string | false | Nome da implantação à qual você deseja se conectar. |
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--connectWith | string | false | Método para se conectar à implantação. Os valores válidos são compass, connectionString, mongosh e vscode. |
--connectionStringType | string | false | Tipo de connection string. Se você especificar "privado", essa opção recuperará a string de conexão do endpoint de emparelhamento de rede. Se você especificar "privateEndpoint", essa opção recuperará as connection strings otimizadas para fragmentos para os endpoints privados. Este valor é padronizado como "padrão". |
-h, --help | false | ajuda para conectar | |
--password | string | false | Senha para o usuário. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--type | string | false | Tipo de implementação. Os valores válidos são Atlas ou Local. |
--username | string | false | Nome de usuário para autenticar no MongoDB. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |