Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ /

A equipe do Atlas descrevem

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Retorne os detalhes da equipe especificada para sua organização.

Você pode retornar os detalhes de uma equipe usando o ID da equipe ou o nome da equipe. Você deve especificar a opção ID ou a opção name.

Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de membro da organização.

Sintaxe do comando
atlas teams describe [options]
Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para descrever

--id

string

false

Sequência única de 24 dígitos que identifica a equipe.

--name

string

false

Etiqueta que identifica a equipe.

--orgId

string

false

ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

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

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.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

ID NAME
<Id> <Name>
# Return the JSON-formatted details for the the team with the ID 5e44445ef10fab20b49c0f31 in the organization with ID 5e2211c17a3e5a48f5497de3:
atlas teams describe --id 5e44445ef10fab20b49c0f31 --projectId 5e1234c17a3e5a48f5497de3 --output json
# Return the JSON-formatted details for the the team with the name myTeam in the organization with ID 5e2211c17a3e5a48f5497de3:
atlas teams describe --name myTeam --projectId 5e1234c17a3e5a48f5497de3 --output json

Voltar

excluir