Skip to content

Commit ec5fdee

Browse files
corryrootcorryroot
authored
(DOCSP-13962): Added page and navigation for the privateendpoint <provider> describe command. (#457)
* (DOCSP-13962): Added page and navigation for the privateendpoint <provider> describe command. * (DOCSP-13962): Fixed warnings. * (DOCSP-13962): Fixed warnings. * (DOCSP-13962): Incorporated Zach's feedback. * (DOCSP-13962): Fixed warnings. * (DOCSP-13962): Incorporated Guss's feebdack. * (DOCSP-13962): Fixed formatting.
1 parent 8f5a25e commit ec5fdee

File tree

6 files changed

+231
-5
lines changed

6 files changed

+231
-5
lines changed

‎source/quick-start.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Generate Programmatic Access Keys
6060
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6161

6262
{+mcli+} uses Programmatic Access Keys to access the |service|,
63-
|cloud-short|, or |on-prem| projects. Your |svc-api-key| must have:
63+
|cloud-short|, or |onprem| projects. Your |svc-api-key| must have:
6464

6565
- The ``project owner`` role
6666
- The access list entry for your IP address or |cidr| range

‎source/reference/atlas.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ Atlas ``mongocli`` Commands
7676
Metrics </reference/atlas/metric-commands>
7777
Networking </reference/atlas/networking-commands>
7878
Performance Advisor </reference/atlas/performanceadvisor-commands>
79-
Private Endpoints </reference/atlas/privateendpoint-commands>
79+
Private Endpoints </reference/atlas/private-endpoint-commands-new>
80+
Private Endpoints (Deprecated) </reference/atlas/privateendpoint-commands>
8081
Processes </reference/atlas/process-commands>
8182
Security </reference/atlas/security-commands>
8283
Whitelists </reference/atlas/whitelist-commands>

‎source/reference/atlas/private-endpoint-commands-new.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _mcli-reference-atlas-private-endpoint-new:
2+
3+
==================================
4+
Atlas ``privateEndpoint`` Commands
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Get One Private Endpoint Service for One Provider </reference/atlas/private-endpoint-provider-describe>

‎source/reference/atlas/private-endpoint-provider-describe.txt

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
.. _mcli-atlas-private-endpoint-provider-describe-cmd:
2+
3+
==================================================
4+
mongocli atlas privateendpoint <provider> describe
5+
==================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``privateendpoint <provider> describe`` command retrieves
16+
information about one private endpoint connection for |aws| or Azure in
17+
an |service| project. You can also retrieve this information through
18+
the |service| :atlas:`UI </security-private-endpoint/>` or :atlas:`API
19+
</reference/api/private-endpoints-service-get-one/>`.
20+
21+
Syntax
22+
------
23+
24+
.. code-block:: text
25+
26+
mongocli atlas privateendpoint(s)|privateEndpoint(s) aws|azure describe|get <private-endpoint-id>
27+
[ --output|-o <output-format> ]
28+
[ --profile|-P <profile-name> ]
29+
[ --projectId <project-ID> ]
30+
31+
.. include:: /includes/fact-command-line-help.rst
32+
33+
.. _atlas-private-endpoint-provider-describe-arguments:
34+
35+
Arguments
36+
---------
37+
38+
.. list-table::
39+
:header-rows: 1
40+
:widths: 20 10 60 10
41+
42+
* - Argument
43+
- Type
44+
- Description
45+
- Required?
46+
47+
* - ``<private-endpoint-id>``
48+
- string
49+
- Unique identifier of the private endpoint connection that you
50+
want to retrieve.
51+
- yes
52+
53+
.. _atlas-privateendpoint-provider-describe-options:
54+
55+
Options
56+
-------
57+
58+
.. list-table::
59+
:widths: 20 10 60 10
60+
:header-rows: 1
61+
62+
* - Option
63+
- Type
64+
- Description
65+
- Required?
66+
67+
* - ``--output``, ``-o``
68+
- string
69+
- .. include:: /includes/extracts/fact-basic-options-output.rst
70+
- no
71+
72+
* - ``--profile``, ``-P``
73+
- string
74+
- Name of the profile where the public and private
75+
keys for the project are saved. If omitted, uses the
76+
{+default-profile+}. To learn more about creating a
77+
profile, see :ref:`mcli-configure`.
78+
- no
79+
80+
* - ``--projectId``
81+
- string
82+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
83+
- no
84+
85+
.. _atlas-private-endpoint-provider-describe-output:
86+
87+
Output
88+
------
89+
90+
If the command succeeds, it returns the following output in the default
91+
format. If the command returns errors, see
92+
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
93+
94+
.. code-block:: sh
95+
:copyable: false
96+
97+
ID ENDPOINT SERVICE STATUS ERROR
98+
<private-endpoint-id> <private-endpoint-service> <private-endpoint-status> <private-endpoint-error>
99+
100+
.. include:: /includes/fact-default-output.rst
101+
102+
- :atlas:`Atlas API
103+
</reference/api/private-endpoints-service-get-one/#response-elements>`
104+
105+
Example
106+
-------
107+
108+
.. tabs::
109+
110+
.. tab:: Default Output
111+
:tabid: default-output
112+
113+
.. tabs::
114+
115+
.. tab:: |aws|
116+
:tabid: aws
117+
118+
The following command retrieves one private endpoint
119+
connection for |aws| in a project using the
120+
{+default-profile+}, which contains credentials and the
121+
project ID. The output is returned in the default format.
122+
123+
.. code-block:: sh
124+
125+
mongocli atlas privateendpoint aws describe 5f4fc81c1f03a835c2728ff7
126+
127+
The previous command prints the following to the terminal.
128+
129+
.. code-block:: sh
130+
:copyable: false
131+
132+
ID ENDPOINT SERVICE STATUS ERROR
133+
5f4fc81c1f03a835c2728ff7 com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44 WAITING_FOR_USER
134+
135+
.. tab:: Azure
136+
:tabid: azure
137+
138+
The following command retrieves one private endpoint
139+
connection for Azure in a project using the
140+
{+default-profile+}, which contains credentials and the
141+
project ID. The output is returned in the default format.
142+
143+
.. code-block:: sh
144+
145+
mongocli atlas privateendpoint azure describe 5f4fc81c1f03a835c2728ff7
146+
147+
The previous command prints the following to the terminal.
148+
149+
.. code-block:: sh
150+
:copyable: false
151+
152+
ID ENDPOINT SERVICE STATUS ERROR
153+
601d493ed3b64f69d7f3f2c2 pls_601d493ed3b64f69d7f3f2c2 AVAILABLE
154+
155+
.. tab:: JSON Output
156+
:tabid: json-output
157+
158+
.. tabs::
159+
160+
.. tab:: |aws|
161+
:tabid: aws
162+
163+
The following command retrieves one private endpoint
164+
connection for |aws| in a project using the
165+
{+default-profile+}, which contains credentials and the
166+
project ID. The output is returned in |json| format.
167+
168+
.. code-block:: sh
169+
170+
mongocli atlas privateendpoint aws describe 5f4fc81c1f03a835c2728ff7 --output json
171+
172+
The previous command prints the following to the terminal in
173+
|json| format.
174+
175+
.. code-block:: json
176+
:copyable: false
177+
178+
{
179+
"id": "5f4fc81c1f03a835c2728ff7",
180+
"endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44",
181+
"status": "WAITING_FOR_USER"
182+
}
183+
184+
.. tab:: Azure
185+
:tabid: azure
186+
187+
The following command retrieves one private endpoint
188+
connection for Azure in a project using the
189+
{+default-profile+}, which contains credentials and the
190+
project ID. The output is returned in |json| format.
191+
192+
.. code-block:: sh
193+
194+
mongocli atlas privateendpoint aws describe 5f4fc81c1f03a835c2728ff7 --output json
195+
196+
The previous command prints the following to the terminal in
197+
|json| format.
198+
199+
.. code-block:: json
200+
:copyable: false
201+
202+
{
203+
"id": "601d493ed3b64f69d7f3f2c2",
204+
"privateLinkServiceName": "pls_601d493ed3b64f69d7f3f2c2",
205+
"privateLinkServiceResourceId": "/subscriptions/4e133d35-e734-4380-a565-c0945535da37/resourceGroups/rg_601d4671d3b64f69d7f3ee82_ovv7qcyv/providers/Microsoft.Network/privateLinkServices/pls_601d493ed3b64f69d7f3f2c2",
206+
"status": "AVAILABLE"
207+
}

‎source/reference/atlas/privateendpoint-commands.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _mcli-reference-atlas-privateendpoint:
22

3-
==================================
4-
Atlas ``privateEndpoint`` Commands
5-
==================================
3+
===============================================
4+
Atlas ``privateEndpoint`` Commands (Deprecated)
5+
===============================================
66

77
.. default-domain:: mongodb
88

‎source/reference/atlas/privateendpoint-describe.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ mongocli atlas privateendpoint describe
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. important:: Deprecated
16+
17+
This command is deprecated. Use
18+
:doc:`Get One Private Endpoint Service for One Provider
19+
</reference/atlas/private-endpoint-provider-describe>` instead.
20+
1521
The ``privateendpoint describe`` command retrieves information about one
1622
private endpoint connection for a given |service| project.
1723

0 commit comments

Comments
 (0)