Devuelve los detalles de la base de datos de data federation especificada para su proyecto.
Para usar este comando, debes autenticarte con una cuenta de usuario, una cuenta de servicio o una clave API que tenga el rol de Propietario del proyecto.
Sintaxis
atlas dataFederation describe <name> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre | string | true | Nombre de la Data Federation base de datos. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --help | false | ayuda para describir | |
-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, usa la opción -o json. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# retrieves data federation 'DataFederation1': atlas dataFederation describe DataFederation1