Skip to content

Commit 345fff6

Browse files
apix-bot[bot]davidhou17kanchana-mongodb
authored
Copies Atlas CLI commands for release tag: atlascli/v1.40.0 (#947)
* Project import generated by Copybara. GitOrigin-RevId: 4c17545fa6fa598e119209254f2f236e29005d6b * Apply suggestions from code review Co-authored-by: kanchana-mongodb <[email protected]> --------- Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com> Co-authored-by: davidhou17 <[email protected]> Co-authored-by: kanchana-mongodb <[email protected]>
1 parent 1e87641 commit 345fff6

File tree

113 files changed

+799
-108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+799
-108
lines changed

source/command/atlas-alerts-settings-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Options
5252
* - -f, --file
5353
- string
5454
- false
55-
- Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
55+
- Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
5656
* - -h, --help
5757
-
5858
- false

source/command/atlas-alerts-settings-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Options
6868
* - -f, --file
6969
- string
7070
- false
71-
- Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
71+
- Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
7272
* - -h, --help
7373
-
7474
- false

source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByClusterName
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.
1616

17-
Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName
17+
Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName
1818

1919
Syntax
2020
------

source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByHostname
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.
1616

17-
Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname
17+
Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname
1818

1919
Syntax
2020
------

source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ Options
7373
- string
7474
- false
7575
- api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".
76+
* - -w, --watch
77+
-
78+
- false
79+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
80+
* - --watchTimeout
81+
- int
82+
- false
83+
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
7684

7785
Inherited Options
7886
-----------------

source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ Options
6969
- string
7070
- false
7171
- api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".
72+
* - -w, --watch
73+
-
74+
- false
75+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
76+
* - --watchTimeout
77+
- int
78+
- false
79+
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
7280

7381
Inherited Options
7482
-----------------

source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ Options
7373
- string
7474
- false
7575
- api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".
76+
* - -w, --watch
77+
-
78+
- false
79+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
80+
* - --watchTimeout
81+
- int
82+
- false
83+
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
7684

7785
Inherited Options
7886
-----------------

source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api cloudBackups cancelBackupRestoreJob
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Cancels one cloud backup restore job of one cluster from the specified project.
1616

17-
To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'cancelBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob
17+
To use this resource, the requesting API Key must have the Project Backup Manager role. This command is invoking the endpoint with OperationID: 'cancelBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob
1818

1919
Syntax
2020
------

source/command/atlas-api-cloudBackups-createBackupExportJob.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ Options
6969
- string
7070
- false
7171
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
72+
* - -w, --watch
73+
-
74+
- false
75+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
76+
* - --watchTimeout
77+
- int
78+
- false
79+
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
7280

7381
Inherited Options
7482
-----------------

source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api cloudBackups createBackupRestoreJob
1414

1515
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Restores one snapshot of one cluster from the specified project.
1616

17-
Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob
17+
Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Backup Manager role. This command is invoking the endpoint with OperationID: 'createBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob
1818

1919
Syntax
2020
------

0 commit comments

Comments
 (0)