Variáveis de ambiente do Atlas CLI

Nesta página

Precedência

Variáveis de ambiente suportadas

Para facilitar a criação de scripts, você pode especificar definições de configuração usando variáveis de ambiente.

Precedência

Ao executar qualquer comando, cada configuração especificada com uma variável de ambiente tem precedência sobre o perfil armazenado no arquivo de configuração.
Quando você executa um comando utilizando a opção --projectId, a opção de linha de comando assume precedência sobre a variável de ambiente e o perfil armazenado no arquivo de configuração.

Variáveis de ambiente suportadas

Importante

O Atlas CLI suporta variáveis de ambiente do MongoDB CLI e variáveis de ambiente do Atlas CLI. Você pode usar variáveis de ambiente do MongoDB CLI ou variáveis de ambiente do Atlas CLI, mas não as duas juntas.

O Atlas CLI suporta as seguintes variáveis de ambiente:

Variável

Descrição

DO_NOT_TRACK

Sinalizador que indica se a telemetria está desabilitada para o Atlas CLI. Defina como 1 para desabilitar a telemetria.

Você também pode habilitar ou desabilitar a telemetria com MONGODB_ATLAS_TELEMETRY_ENABLED, mas não precisa especificar ambos.

MONGODB_ATLAS_PUBLIC_API_KEY

Define a chave deAPI pública para comandos que interagem com o Atlas.

MONGODB_ATLAS_PRIVATE_API_KEY

Define a chave de API privada para comandos que interagem com o Atlas.

MONGODB_ATLAS_ORG_ID

Define o ID da organização para comandos que exigem a opção --orgId.

MONGODB_ATLAS_PROJECT_ID

Define o ID do projeto para comandos que exigem a opção --projectId.

MONGODB_ATLAS_OUTPUT

Define os campos e o formato de saída. Os valores válidos são:

Valor	Formato de saída
Empty default	Saída legível por humanos que inclui todos os campos que o Atlas CLI retorna.
`json`	Saída JSON que inclui todos os campos que o Atlas CLI retorna.
`json-path`	Saída JSON que inclui os campos que você especifica.
`go-template`	Saída com formato personalizado que inclui os campos especificados em um modelo Go.

MONGODB_ATLAS_MONGOSH_PATH

O caminho completo em seu sistema local para o MongoDB Shell, mongosh.

MONGODB_ATLAS_SKIP_UPDATE_CHECK

Quando configurado para yes, o Atlas CLI não solicita que você atualize para novas versões.

MONGODB_ATLAS_ACCESS_TOKEN

String que concede acesso à sua conta Atlas. O token de acesso é válido por 12 horas.

MONGODB_ATLAS_REFRESH_TOKEN

String que permite ao Atlas solicitar automaticamente um novo token de acesso quando o token de acesso atual expira.

MONGODB_ATLAS_TELEMETRY_ENABLED

Sinalizador que indica se a telemetria está habilitada para o Atlas CLI. Defina como false para desabilitar a telemetria.

Você também pode habilitar ou desabilitar a telemetria com DO_NOT_TRACK, mas não precisa especificar ambos.

HTTP_PROXY

A URL absoluta ou o nome do host e a porta no formato hostname[:port] .

Exemplo

O exemplo a seguir mostra como configurar a variável de ambiente se sua configuração de proxy não exigir autenticação.

HTTP_PROXY=<my.proxy.address>

O exemplo a seguir mostra como configurar a variável de ambiente se a configuração de proxy exigir uma autenticação.

HTTP_PROXY=<username>:<password>@<my.proxy.address>

O exemplo seguinte mostra como configurar a variável de ambiente se o esquema for socks5.

HTTP_PROXY=socks5://<my.proxy.address>

HTTPS_PROXY

A URL absoluta. Se HTTP_PROXY também estiver definido, terá precedência sobre HTTP_PROXY para todas as solicitações.

Exemplo

O exemplo a seguir mostra como configurar a variável de ambiente.

HTTPS_PROXY=https://<my.proxy.address>

NO_PROXY

Não indica nenhum proxy para a URL porque o proxy não está configurado para a URL.

Voltar

Automatizar processos

personalizar saída