- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Actualiza la configuración de auditoría para el Proyecto especificado
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave de API con el rol de Propietario de Proyecto.
Sintaxis
atlas auditing update [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--auditAuthorizationSuccess | false | Marca que indica si se configuró la auditoría para rastrear las autenticaciones exitosas. Esto solo aplica al filtro de auditoría "atype": "authCheck". Si se establece este parámetro como verdadero, el rendimiento del clúster se ve afectado. | |
--auditFilter | string | false | Documento JSON que especifica los eventos que se registrarán. Se deben evitar los caracteres que puedan impedir el análisis, como las comillas simples o dobles, mediante una barra invertida (). Mutuamente excluyente con --file. |
--enabled | false | Bandera que indica si alguien habilitó la auditoría de base de datos para el proyecto especificado. | |
-f, --file | string | false | Ruta a un archivo de configuración JSON opcional que define los filtros de auditoría. Para obtener más información sobre los archivos de configuración de auditoría para la CLI de Atlas, consulte https://www.mongodb.com/es/docs/atlas/database-auditing/#example-auditing-filters Mutuamente excluyente con --auditFilter. |
-h, --ayuda | false | ayuda para actualizar | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
Auditing configuration successfully updated.
Ejemplos
# Audit all authentication events for known users: atlas auditing update --auditFilter '{"atype": "authenticate"}'
# Audit all authentication events for known user via a configuration file: atlas auditing update -f filter.json