Conexões de streams do Atlas descrever

Retornar os detalhes da conexão de Atlas Stream Processing especificada.

Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.

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 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