Página inicial do Docs → Iniciar e gerenciar o MongoDB → MongoDB Atlas
Atlas privateEndpoints Azure describe
Retorne os detalhes do endpoint privado do Azure especificado para seu projeto.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.
Sintaxe
Sintaxe do comando
atlas privateEndpoints azure describe <privateEndpointId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
privateEndpointId | string | true | String única alfanumérica de 24 caracteres que identifica o endpoint privado no Atlas. |
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
ID ENDPOINT SERVICE STATUS ERROR <Id> <PrivateLinkServiceName> <Status> <ErrorMessage>
Exemplos
# Return the JSON-formatted details for the Azure private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: atlas privateEndpoints azure describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json