- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Retornar os detalhes da conexão de Atlas Stream Processing especificada.
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
atlas streams connections describe <streamConnectionName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
streamConnectionName | string | true | Nome da conexão do Atlas Stream Processing. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para descrever | |
-i, --instance | string | true | Nome da sua instância do Atlas Stream Processing. |
-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 stream connection 'ExampleConnection' in instance 'ExampleInstance': atlas streams connection describe ExampleConnection --instance ExampleInstance