Si un comando Atlas CLI acepta el --file opción, puedes pasar un archivo de configuración .json para definir configuraciones específicas. Por ejemplo, puedes pasar un archivo de configuración al usar la Atlas CLI para:
Crear un índice continuo para un clúster.
Actualiza las organizaciones conectadas para la autenticación federada.
Uso
Para aprender qué configuraciones son aceptadas por la Atlas CLI, consulta el esquema del cuerpo de la solicitud y copia las muestras de solicitud en el Especificación de la API de administración de Atlas para el endpoint que corresponde al comando de Atlas CLI. Los comandos que puedes usar incluyen, pero no se limitan a:
Comando Atlas CLI | Endpoint de API |
|---|---|
Cuando ejecute el comando en su terminal, especifique la opción --file y proporcione la ruta al archivo de configuración JSON que define la configuración deseada.
Ejemplo
Por ejemplo, considera el siguiente archivo de configuración para habilitar copias de seguridad y añadir una etiqueta:
{ "backupEnabled" : true, "labels": [ { "key": "<myKey>", "value": "<myValue>" } ] }
El siguiente comando actualiza la myCluster implementación con base en la configuración especificada en el archivo de configuración:
atlas clusters update myCluster --file example.json
Archivo de configuración del clúster
Para obtener más información sobre los archivos de configuración de clúster, consulta Archivo de configuración del clúster. Para obtener archivos de muestra, consulta:
Archivo de configuración del cronograma de copias de seguridad en la nube
Para obtener más información sobre los archivos de configuración de cronograma de copias de seguridad en la nube, consulta Archivo de Configuración de Cronograma de Copias de Seguridad en la Nube. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de configuración del índice de Búsqueda Atlas
Para aprender más sobre los archivos de configuración del índice de búsqueda de MongoDB, consulta Archivo de configuración del índice de búsqueda de Atlas. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de configuración de los nodos de búsqueda
Para obtener más información sobre los archivos de configuración de los nodos de búsqueda, consulta Archivo de configuración de los nodos de búsqueda. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de configuración de Atlas Data Federation
Para obtener más información sobre los archivos de configuración de Atlas Data Federation, consulta Archivo de configuración de Atlas Data Federation. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de Configuración de Alertas
Para obtener más información sobre los archivos de configuración de alertas, consulta Archivo de configuración de alertas. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de configuración de índices periódicos
Para obtener más información sobre los archivos de configuración de índices de rotación, consulta Archivo de configuración de índices de rotación (Rolling Index). Para archivos de ejemplo, consulta:
Archivo de Configuración del Proyecto
Para aprender más sobre los archivos de configuración de proyectos, consulta Archivo de configuración de proyectos. Para conocer la sintaxis de un archivo, consulta Crear un archivo de configuración.
Archivo de configuración de la autenticación federada.
Para obtener más información sobre los archivos de configuración de autenticación federada, consulta Archivo de Configuración de Autenticación Federada. Para aprender la sintaxis de un archivo, consulta Crear un archivo de configuración.