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

Atlas dataFederation privateEndpoints describe

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Exemplos

Retorne os detalhes do endpoint privado da federação de dados especificado para o 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 do comando
atlas dataFederation privateEndpoints describe <endpointId> [options]
Nome
Tipo
Obrigatório
Descrição

endpointId

string

true

Identificador de endpoint do endpoint privado da Data Federation.

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.

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.

# retrieves data federation private endpoint '507f1f77bcf86cd799439011':
atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011

Voltar

excluir