atlas privateEndpoints azure describe
Return the details for the specified Azure private endpoint for your project.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas privateEndpoints azure describe <privateEndpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
privateEndpointId | string | true | Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID ENDPOINT SERVICE STATUS ERROR <Id> <PrivateLinkServiceName> <Status> <ErrorMessage>
Examples
# 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