Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI
/
Referência

JSON

Nesta página

  • Uso
  • Arquivo de configuração do cluster
  • Arquivo de configuração do agendamento de backup em cloud
  • Arquivo de configuração do índice de pesquisa do Atlas Search
  • Arquivo de configuração de nós de pesquisa
  • Arquivo de configuração do Atlas Data Federation
  • Arquivo de configuração de alerta
  • Arquivo de configuração do índice contínuo
  • Arquivo de configuração do projeto
  • Arquivo de configuração de autenticação federado

Se um comando do Atlas CLI aceitar a opção --file , você poderá passar um arquivo de configuração .json para definir configurações específicas. Por exemplo, você pode passar um arquivo de configuração ao usar o Atlas CLI para:

Uso

Para saber quais configurações são aceitas pelo Atlas CLI, visualize o esquema do corpo da solicitação e copie as amostras de solicitação naEspecificação da API admin do Atlas para o endpoint que corresponde ao comando Atlas CLI. Os comandos que você pode usar incluem, mas não estão limitados a:

Comando Atlas CLI
Ponto de conexão da API

Ao executar o comando em seu terminal, especifique a opção --file e forneça o caminho para o arquivo de configuração JSON que define as configurações desejadas.

Exemplo

Por exemplo, considere o seguinte arquivo de configuração para habilitar backups e adicionar um rótulo:

/example.json
{
  "backupEnabled" : true,
  "labels": [
    {
      "key": "<myKey>",
      "value": "<myValue>"
    }
  ]
}

O seguinte comando atualiza o sistema do myCluster baseado nas configurações especificadas no arquivo de configuração:

atlas clusters update myCluster --file example.json

Arquivo de configuração do cluster

Para saber mais sobre arquivos de configuração de cluster, consulte Arquivo de Configuração de Cluster. Para arquivos de amostra, consulte:

Arquivo de configuração do agendamento de backup em cloud

Para saber mais sobre os arquivos de configuração do agendamento de backup na nuvem, consulte Arquivo de Configuração do agendamento de backup na nuvem. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração do índice de pesquisa do Atlas Search

Para saber mais sobre os arquivos de configuração do índice do Atlas Search , consulte Arquivo de configuração do índice do Atlas Search. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração de nós de pesquisa

Para saber mais sobre arquivos de configuração de nós de pesquisa, consulte Arquivo de Configuração de Nós de Pesquisa. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração do Atlas Data Federation

Para saber mais sobre os arquivos de configuração do Atlas Data Federation, consulte o Arquivo de Configuração do Atlas Data Federation. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração de alerta

Para saber mais sobre os arquivos de configuração de alertas, consulte Arquivo de configuração de alertas. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração do índice contínuo

Para saber mais sobre os arquivos de configuração de índice contínuo, consulte Arquivo de configuração de índice contínuo. Para arquivos de exemplo , consulte:

Arquivo de configuração do projeto

Para saber mais sobre arquivos de configuração do projeto , consulte Arquivo de configuração do projeto. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Arquivo de configuração de autenticação federado

Para saber mais sobre arquivos de configuração de autenticação federada, consulte Arquivo de configuração de autenticação federada. Para aprender a sintaxe de um arquivo, consulte Criar um arquivo de configuração.

Voltar

Referência

Próximo

cluster