- 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.
Cree una función de base de datos personalizada para su proyecto.
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 customDbRoles create <roleName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
nombreDeRol | string | true | Nombre del rol personalizado a crear. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --ayuda | false | ayuda para crear | |
--inheritedRole | cadenas | false | Lista de roles heredados y la base de datos en la que se otorga el rol. |
-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. |
--privilege | cadenas | false | Lista de acciones por base de datos y colección. Si no se proporciona ninguna base de datos ni colección, se asume el ámbito del clúster. Para obtener más información sobre las acciones específicas de clústeres, bases de datos o colecciones, consulte https://dochub.mongodb.org/core/privilege-actions. |
--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.
Custom database role '<RoleName>' successfully created.
Ejemplos
# Create a custom database role atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName
# Create a custom database role on multiple collections atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.firstCollectionName,UPDATE@databaseName.secondCollectionName
# Create a customer database role with granted action on the cluster resource atlas customDbRoles create customRole --privilege GET_CMD_LINE_OPTS
# Use an inherited role atlas customDbRoles create customRole --inheritedRole read@databaseName