Atlas dataFederation describe
Nesta página
Retorne os detalhes do banco de dados de federação de dados especificado para seu projeto.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
Sintaxe do comando
atlas dataFederation describe <name> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | true | Nome do banco de dados de federação de dados. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para descrever | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
# retrieves data federation 'DataFederation1': atlas dataFederation describe DataFederation1