Skip to content

Commit 0f5902f

Browse files
authored
(DOCSP-14126): Added a page and the nav for the mongocli atlas privateendpoint regionalmode disable command. (#481)
* (DOCSP-14126): Added a page and the nav for the mongocli atlas privateendpoint regionalmode disable command. * (DOCSP-14126): Fixed typo. * (DOCSP-14126): Fixed anchor. * (DOCSP-14126): Incorporated Julia's feedback.
1 parent a9d3d6b commit 0f5902f

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ Atlas ``privateEndpoint`` Commands
1616
Delete One Private Endpoint Service for One Provider </reference/atlas/private-endpoint-provider-delete>
1717

1818
Get the Regionalized Private Endpoint Setting </reference/atlas/private-endpoint-regionalmode-describe>
19+
20+
Disable the Regionalized Private Endpoint Setting </reference/atlas/private-endpoint-regionalmode-disable>
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
.. _mcli-atlas-private-endpoint-regionalmode-disable-cmd:
2+
3+
===================================================
4+
mongocli atlas privateendpoint regionalmode disable
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 regionalmode disable`` command disables the
16+
regionalized private endpoint setting for an |service| project. You can
17+
also disable the regionalized private endpoint setting through the
18+
|service| :atlas:`UI </security-private-endpoint/#regionalized-private-endpoints-for-multi-region-sharded-clusters>` or
19+
:atlas:`API </reference/api/private-endpoints-update-regional-mode/>`.
20+
21+
Syntax
22+
------
23+
24+
.. code-block:: text
25+
26+
mongocli atlas privateendpoint regionalMode(s)|regional-mode(s)|regionalmode(s) disable
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-regionalmode-disable-options:
34+
35+
Options
36+
-------
37+
38+
.. list-table::
39+
:widths: 20 10 60 10
40+
:header-rows: 1
41+
42+
* - Option
43+
- Type
44+
- Description
45+
- Required?
46+
47+
* - ``--output``, ``-o``
48+
- string
49+
- .. include:: /includes/extracts/fact-basic-options-output.rst
50+
- no
51+
52+
* - ``--profile``, ``-P``
53+
- string
54+
- Name of the profile where the public and private
55+
keys for the project are saved. If omitted, uses the
56+
{+default-profile+}. To learn more about creating a
57+
profile, see :ref:`mcli-configure`.
58+
- no
59+
60+
* - ``--projectId``
61+
- string
62+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
63+
- no
64+
65+
.. _atlas-private-endpoint-regionalmode-disable-output:
66+
67+
Output
68+
------
69+
70+
If the command succeeds, it returns the following output in the default
71+
format. If the command returns errors, see
72+
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
73+
74+
.. code-block:: sh
75+
:copyable: false
76+
77+
Regionalized private endpoint setting disabled.
78+
79+
Example
80+
-------
81+
82+
.. tabs::
83+
84+
.. tab:: Default Output
85+
:tabid: default-output
86+
87+
The following command disables the regionalized
88+
private endpoint setting in a project using the
89+
{+default-profile+}, which contains credentials for accessing the
90+
project and the project ID. The output is returned in the default
91+
format.
92+
93+
.. code-block:: sh
94+
95+
mongocli atlas privateendpoint regionalmode disable
96+
97+
The previous command prints the following to the terminal.
98+
99+
.. code-block:: sh
100+
:copyable: false
101+
102+
Regionalized private endpoint setting disabled.
103+
104+
.. tab:: JSON Output
105+
:tabid: json-output
106+
107+
The following command disables the regionalized
108+
private endpoint setting in a project using the
109+
{+default-profile+}, which contains credentials for accessing the
110+
project and the project ID. The output is returned
111+
in |json| format.
112+
113+
.. code-block:: sh
114+
115+
mongocli atlas privateendpoint regionalmode disable --output json
116+
117+
The previous command prints the following to the terminal in
118+
|json| format.
119+
120+
.. code-block:: json
121+
:copyable: false
122+
123+
{
124+
"enabled": false
125+
}

0 commit comments

Comments
 (0)