Skip to content

Commit 87165fa

Browse files
fmenezesfmenezes
authored
CLOUDP-128898: Provide commands to enable/disable alert settings (#1473)
1 parent 6379348 commit 87165fa

20 files changed

+1077
-8
lines changed

‎docs/atlascli/command/atlas-alerts-settings-disable.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. _atlas-alerts-settings-disable:
2+
3+
=============================
4+
atlas alerts settings 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+
Disables one alert configuration for the specified project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas alerts settings disable <alertConfigId> [options]
23+
24+
.. Code end marker, please don't delete this comment
25+
26+
Arguments
27+
---------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - alertConfigId
38+
- string
39+
- true
40+
- ID of the alert configuration you want to disable.
41+
42+
Options
43+
-------
44+
45+
.. list-table::
46+
:header-rows: 1
47+
:widths: 20 10 10 60
48+
49+
* - Name
50+
- Type
51+
- Required
52+
- Description
53+
* - -h, --help
54+
-
55+
- false
56+
- help for disable
57+
* - -o, --output
58+
- string
59+
- false
60+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
61+
* - --projectId
62+
- string
63+
- false
64+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
65+
66+
Inherited Options
67+
-----------------
68+
69+
.. list-table::
70+
:header-rows: 1
71+
:widths: 20 10 10 60
72+
73+
* - Name
74+
- Type
75+
- Required
76+
- Description
77+
* - -P, --profile
78+
- string
79+
- false
80+
- Profile to use from your configuration file.
81+

‎docs/atlascli/command/atlas-alerts-settings-enable.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. _atlas-alerts-settings-enable:
2+
3+
============================
4+
atlas alerts settings enable
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+
Enables one alert configuration for the specified project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas alerts settings enable <alertConfigId> [options]
23+
24+
.. Code end marker, please don't delete this comment
25+
26+
Arguments
27+
---------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - alertConfigId
38+
- string
39+
- true
40+
- ID of the alert you want to enable.
41+
42+
Options
43+
-------
44+
45+
.. list-table::
46+
:header-rows: 1
47+
:widths: 20 10 10 60
48+
49+
* - Name
50+
- Type
51+
- Required
52+
- Description
53+
* - -h, --help
54+
-
55+
- false
56+
- help for enable
57+
* - -o, --output
58+
- string
59+
- false
60+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
61+
* - --projectId
62+
- string
63+
- false
64+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
65+
66+
Inherited Options
67+
-----------------
68+
69+
.. list-table::
70+
:header-rows: 1
71+
:widths: 20 10 10 60
72+
73+
* - Name
74+
- Type
75+
- Required
76+
- Description
77+
* - -P, --profile
78+
- string
79+
- false
80+
- Profile to use from your configuration file.
81+

‎docs/atlascli/command/atlas-alerts-settings.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas alerts settings
1414

1515
Manages alerts configuration for your project.
1616

17-
Use this command to list, create, edit, and delete alert configurations.
17+
Use this command to list, create, edit, delete, enable and disable alert configurations.
1818

1919
Options
2020
-------
@@ -53,6 +53,8 @@ Related Commands
5353

5454
* :ref:`atlas-alerts-settings-create` - Creates one alert configuration in the specified project.
5555
* :ref:`atlas-alerts-settings-delete` - Deletes the specified alert configuration in a specified project.
56+
* :ref:`atlas-alerts-settings-disable` - Disables one alert configuration for the specified project.
57+
* :ref:`atlas-alerts-settings-enable` - Enables one alert configuration for the specified project.
5658
* :ref:`atlas-alerts-settings-fields` - Manages alert configuration fields for your project.
5759
* :ref:`atlas-alerts-settings-list` - Returns alert configurations for the specified project.
5860
* :ref:`atlas-alerts-settings-update` - Updates one alert configuration in the specified project.
@@ -63,6 +65,8 @@ Related Commands
6365

6466
create </command/atlas-alerts-settings-create>
6567
delete </command/atlas-alerts-settings-delete>
68+
disable </command/atlas-alerts-settings-disable>
69+
enable </command/atlas-alerts-settings-enable>
6670
fields </command/atlas-alerts-settings-fields>
6771
list </command/atlas-alerts-settings-list>
6872
update </command/atlas-alerts-settings-update>

‎docs/mongocli/command/mongocli-atlas-alerts-settings-disable.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. _mongocli-atlas-alerts-settings-disable:
2+
3+
======================================
4+
mongocli atlas alerts settings 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+
Disables one alert configuration for the specified project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
mongocli atlas alerts settings disable <alertConfigId> [options]
23+
24+
.. Code end marker, please don't delete this comment
25+
26+
Arguments
27+
---------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - alertConfigId
38+
- string
39+
- true
40+
- ID of the alert configuration you want to disable.
41+
42+
Options
43+
-------
44+
45+
.. list-table::
46+
:header-rows: 1
47+
:widths: 20 10 10 60
48+
49+
* - Name
50+
- Type
51+
- Required
52+
- Description
53+
* - -h, --help
54+
-
55+
- false
56+
- help for disable
57+
* - -o, --output
58+
- string
59+
- false
60+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
61+
* - --projectId
62+
- string
63+
- false
64+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
65+
66+
Inherited Options
67+
-----------------
68+
69+
.. list-table::
70+
:header-rows: 1
71+
:widths: 20 10 10 60
72+
73+
* - Name
74+
- Type
75+
- Required
76+
- Description
77+
* - -P, --profile
78+
- string
79+
- false
80+
- Profile to use from your configuration file.
81+

‎docs/mongocli/command/mongocli-atlas-alerts-settings-enable.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. _mongocli-atlas-alerts-settings-enable:
2+
3+
=====================================
4+
mongocli atlas alerts settings enable
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+
Enables one alert configuration for the specified project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
mongocli atlas alerts settings enable <alertConfigId> [options]
23+
24+
.. Code end marker, please don't delete this comment
25+
26+
Arguments
27+
---------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - alertConfigId
38+
- string
39+
- true
40+
- ID of the alert you want to enable.
41+
42+
Options
43+
-------
44+
45+
.. list-table::
46+
:header-rows: 1
47+
:widths: 20 10 10 60
48+
49+
* - Name
50+
- Type
51+
- Required
52+
- Description
53+
* - -h, --help
54+
-
55+
- false
56+
- help for enable
57+
* - -o, --output
58+
- string
59+
- false
60+
- Output format. Valid values are json, json-path, go-template, or go-template-file.
61+
* - --projectId
62+
- string
63+
- false
64+
- Project ID to use. Overrides the settings in the configuration file or environment variable.
65+
66+
Inherited Options
67+
-----------------
68+
69+
.. list-table::
70+
:header-rows: 1
71+
:widths: 20 10 10 60
72+
73+
* - Name
74+
- Type
75+
- Required
76+
- Description
77+
* - -P, --profile
78+
- string
79+
- false
80+
- Profile to use from your configuration file.
81+

‎docs/mongocli/command/mongocli-atlas-alerts-settings.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ mongocli atlas alerts settings
1414

1515
Manages alerts configuration for your project.
1616

17-
Use this command to list, create, edit, and delete alert configurations.
17+
Use this command to list, create, edit, delete, enable and disable alert configurations.
1818

1919
Options
2020
-------
@@ -53,6 +53,8 @@ Related Commands
5353

5454
* :ref:`mongocli-atlas-alerts-settings-create` - Creates one alert configuration in the specified project.
5555
* :ref:`mongocli-atlas-alerts-settings-delete` - Deletes the specified alert configuration in a specified project.
56+
* :ref:`mongocli-atlas-alerts-settings-disable` - Disables one alert configuration for the specified project.
57+
* :ref:`mongocli-atlas-alerts-settings-enable` - Enables one alert configuration for the specified project.
5658
* :ref:`mongocli-atlas-alerts-settings-fields` - Manages alert configuration fields for your project.
5759
* :ref:`mongocli-atlas-alerts-settings-list` - Returns alert configurations for the specified project.
5860
* :ref:`mongocli-atlas-alerts-settings-update` - Updates one alert configuration in the specified project.
@@ -63,6 +65,8 @@ Related Commands
6365

6466
create </command/mongocli-atlas-alerts-settings-create>
6567
delete </command/mongocli-atlas-alerts-settings-delete>
68+
disable </command/mongocli-atlas-alerts-settings-disable>
69+
enable </command/mongocli-atlas-alerts-settings-enable>
6670
fields </command/mongocli-atlas-alerts-settings-fields>
6771
list </command/mongocli-atlas-alerts-settings-list>
6872
update </command/mongocli-atlas-alerts-settings-update>

0 commit comments

Comments
 (0)