Skip to content

Commit bd0b4e5

Browse files
CLOUDP-349927: Update Autogenerated Commands (#4249)
Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent 70dcf23 commit bd0b4e5

10 files changed

+1588
-98
lines changed
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
.. _atlas-api-sandbox-generateSandboxClusterDescription:
2+
3+
===================================================
4+
atlas api sandbox generateSandboxClusterDescription
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+
Return cluster description from sandbox template configuration.
16+
17+
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API.
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-generategroupsandboxclusterdescription.
21+
22+
For more information and examples, see the referenced API documentation linked above.
23+
24+
Syntax
25+
------
26+
27+
.. code-block::
28+
:caption: Command Syntax
29+
30+
atlas api sandbox generateSandboxClusterDescription [options]
31+
32+
.. Code end marker, please don't delete this comment
33+
34+
Options
35+
-------
36+
37+
.. list-table::
38+
:header-rows: 1
39+
:widths: 20 10 10 60
40+
41+
* - Name
42+
- Type
43+
- Required
44+
- Description
45+
* - --envelope
46+
-
47+
- false
48+
- flag that indicates whether Application wraps the response in an envelope JSON object
49+
* - --groupId
50+
- string
51+
- true
52+
- unique 24-hexadecimal digit string that identifies your project
53+
* - -h, --help
54+
-
55+
- false
56+
- help for generateSandboxClusterDescription
57+
* - -o, --output
58+
- string
59+
- false
60+
- preferred api format, can be ["json", go-template] This value defaults to "json".
61+
* - --outputFile
62+
- string
63+
- false
64+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
65+
* - --pretty
66+
-
67+
- false
68+
- flag that indicates whether the response body should be in the prettyprint format
69+
* - --sandboxConfigId
70+
- string
71+
- true
72+
- unique 24-hexadecimal digit string that identifies the sandbox configuration
73+
* - --version
74+
- string
75+
- false
76+
- api version to use when calling the api call [options: "preview"], defaults to the latest version or the profiles api_version config value if set This value defaults to "preview".
77+
78+
Inherited Options
79+
-----------------
80+
81+
.. list-table::
82+
:header-rows: 1
83+
:widths: 20 10 10 60
84+
85+
* - Name
86+
- Type
87+
- Required
88+
- Description
89+
* - -P, --profile
90+
- string
91+
- false
92+
- 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.
93+

docs/command/atlas-api-sandbox.txt

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
.. _atlas-api-sandbox:
2+
3+
=================
4+
atlas api sandbox
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+
Returns, adds, edits, and removes sandbox templates.
16+
17+
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API.
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
Also enables/disables sandbox for an organization.
21+
22+
Options
23+
-------
24+
25+
.. list-table::
26+
:header-rows: 1
27+
:widths: 20 10 10 60
28+
29+
* - Name
30+
- Type
31+
- Required
32+
- Description
33+
* - -h, --help
34+
-
35+
- false
36+
- help for sandbox
37+
38+
Inherited Options
39+
-----------------
40+
41+
.. list-table::
42+
:header-rows: 1
43+
:widths: 20 10 10 60
44+
45+
* - Name
46+
- Type
47+
- Required
48+
- Description
49+
* - -P, --profile
50+
- string
51+
- false
52+
- 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.
53+
54+
Related Commands
55+
----------------
56+
57+
* :ref:`atlas-api-sandbox-generateSandboxClusterDescription` - Return cluster description from sandbox template configuration.
58+
59+
60+
.. toctree::
61+
:titlesonly:
62+
63+
generateSandboxClusterDescription </command/atlas-api-sandbox-generateSandboxClusterDescription>
64+

docs/command/atlas-api.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ Related Commands
215215
* :ref:`atlas-api-resourcePolicies` - Configure and manage Atlas Resource Policies within your organization.
216216
* :ref:`atlas-api-rollingIndex` - Creates one index to a database deployment in a rolling manner.
217217
* :ref:`atlas-api-root` - Returns details that describe the MongoDB Cloud build and the access token that requests this resource.
218+
* :ref:`atlas-api-sandbox` - Returns, adds, edits, and removes sandbox templates.
218219
* :ref:`atlas-api-serverlessInstances` - Returns, adds, edits, and removes serverless instances.
219220
* :ref:`atlas-api-serverlessPrivateEndpoints` - Returns, adds, edits, and removes private endpoints for serverless instances.
220221
* :ref:`atlas-api-serviceAccounts` - Endpoints for managing Service Accounts and secrets.
@@ -270,6 +271,7 @@ Related Commands
270271
resourcePolicies </command/atlas-api-resourcePolicies>
271272
rollingIndex </command/atlas-api-rollingIndex>
272273
root </command/atlas-api-root>
274+
sandbox </command/atlas-api-sandbox>
273275
serverlessInstances </command/atlas-api-serverlessInstances>
274276
serverlessPrivateEndpoints </command/atlas-api-serverlessPrivateEndpoints>
275277
serviceAccounts </command/atlas-api-serviceAccounts>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
deleteOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61 --sandboxConfigId 507f1f77bcf86cd799439011
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
getOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61 --sandboxConfigId 507f1f77bcf86cd799439011
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
listOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61

0 commit comments

Comments
 (0)