larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs Auto-Generation (#1023)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] 2022-10-03 23:53:39 +00:00 committed by GitHub
parent af12fba0c7
commit 8ab5d5c112
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 72 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/cli/corso_backup_create_exchange.md
View File

@ -7,7 +7,7 @@ hide_title: true
Backup M365 Exchange service data Backup M365 Exchange service data
```bash ```bash
corso backup create exchange [flags] corso backup create exchange --all | --user <userId or email> [flags]
``` ```
### Flags ### Flags
@ -15,8 +15,8 @@ corso backup create exchange [flags]
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--all`||`false`|Backup all Exchange data for all users| |`--all`||`false`|Backup all Exchange data for all users|
|`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users| |`--user`||``|Backup Exchange data by user ID; accepts * to select all users|
|`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events| |`--data`||``|Select one or more types of data to backup: email, contacts, or events|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
### Global and inherited flags ### Global and inherited flags

4
docs/docs/cli/corso_backup_create_onedrive.md
View File

@ -7,14 +7,14 @@ hide_title: true
Backup M365 OneDrive service data Backup M365 OneDrive service data
```bash ```bash
corso backup create onedrive [flags] corso backup create onedrive --user <userId or email> | * [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--user`||`[]`|Backup OneDrive data by user ID; accepts * to select all users| |`--user`||``|Backup OneDrive data by user ID; accepts * to select all users. <div class='required'>Required</div>|
|`--help`|`-h`|`false`|help for onedrive| |`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags

4
docs/docs/cli/corso_backup_delete_exchange.md
View File

@ -7,14 +7,14 @@ hide_title: true
Delete backed-up M365 Exchange service data Delete backed-up M365 Exchange service data
```bash ```bash
corso backup delete exchange [flags] corso backup delete exchange --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup containing the details to be shown| |`--backup`|||ID of the backup to delete. <div class='required'>Required</div>|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
### Global and inherited flags ### Global and inherited flags

4
docs/docs/cli/corso_backup_delete_onedrive.md
View File

@ -7,14 +7,14 @@ hide_title: true
Delete backed-up M365 OneDrive service data Delete backed-up M365 OneDrive service data
```bash ```bash
corso backup delete onedrive [flags] corso backup delete onedrive --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup containing the details to be shown| |`--backup`|||ID of the backup to delete. <div class='required'>Required</div>|
|`--help`|`-h`|`false`|help for onedrive| |`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags

38
docs/docs/cli/corso_backup_details_exchange.md
View File

@ -7,31 +7,31 @@ hide_title: true
Shows the details of a M365 Exchange service backup Shows the details of a M365 Exchange service backup
```bash ```bash
corso backup details exchange [flags] corso backup details exchange --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup containing the details to be shown| |`--backup`|||ID of the backup to explore. <div class='required'>Required</div>|
|`--user`||`[]`|Select backup details by user ID; accepts * to select all users| |`--user`||``|Select backup details by user ID; accepts * to select all users.|
|`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails| |`--email`||``|Select backup details for emails by email ID; accepts * to select all emails.|
|`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders| |`--email-folder`||``|Select backup details for emails within a folder; accepts * to select all email folders.|
|`--email-subject`|||Restore mail where the email subject lines contain this value| |`--email-subject`|||Select backup details for emails with a subject containing this value.|
|`--email-sender`|||Restore mail where the email sender matches this user id| |`--email-sender`|||Select backup details for emails from a specific sender.|
|`--email-received-after`|||Restore mail where the email was received after this datetime| |`--email-received-after`|||Select backup details for emails received after this datetime.|
|`--email-received-before`|||Restore mail where the email was received before this datetime| |`--email-received-before`|||Select backup details for emails received before this datetime.|
|`--event`||`[]`|Select backup details by event ID; accepts * to select all events| |`--event`||``|Select backup details for events by event ID; accepts * to select all events.|
|`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events| |`--event-calendar`||``|Select backup details for events under a calendar; accepts * to select all events.|
|`--event-subject`|||Select backup details where the event subject contains this value| |`--event-subject`|||Select backup details for events with a subject containing this value.|
|`--event-organizer`|||Select backup details where the event organizer user id contains this value| |`--event-organizer`|||Select backup details for events from a specific organizer.|
|`--event-recurs`|||Select backup details if the event recurs. Use `--event-recurs` false to select non-recurring events| |`--event-recurs`|||Select backup details for recurring events. Use `--event-recurs false` to select non-recurring events.|
|`--event-starts-after`|||Select backup details where the event starts after this datetime| |`--event-starts-after`|||Select backup details for events starting after this datetime.|
|`--event-starts-before`|||Select backup details where the event starts before this datetime| |`--event-starts-before`|||Select backup details for events starting before this datetime.|
|`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts| |`--contact`||``|Select backup details for contacts by contact ID; accepts * to select all contacts.|
|`--contact-folder`||`[]`|Select backup details by contact folder ID; accepts * to select all contact folders| |`--contact-folder`||``|Select backup details for contacts within a folder; accepts * to select all contact folders.|
|`--contact-name`|||Select backup details where the contact name contains this value| |`--contact-name`|||Select backup details for contacts whose contact name contains this value.|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
### Global and inherited flags ### Global and inherited flags

10
docs/docs/cli/corso_backup_details_onedrive.md
View File

@ -7,14 +7,20 @@ hide_title: true
Shows the details of a M365 OneDrive service backup Shows the details of a M365 OneDrive service backup
```bash ```bash
corso backup details onedrive [flags] corso backup details onedrive --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup containing the details to be shown| |`--backup`|||ID of the backup to explore. <div class='required'>Required</div>|
|`--folder`||``|Select backup details by OneDrive folder; defaults to root|
|`--file-name`||``|Select backup details by OneDrive file name|
|`--file-created-after`|||Select files created after this datetime|
|`--file-created-before`|||Select files created before this datetime|
|`--file-modified-after`|||Select files modified after this datetime|
|`--file-modified-before`|||Select files modified before this datetime|
|`--help`|`-h`|`false`|help for onedrive| |`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags

8
docs/docs/cli/corso_repo_connect_s3.md
View File

@ -7,16 +7,16 @@ hide_title: true
Ensures a connection to an existing S3 repository. Ensures a connection to an existing S3 repository.
```bash ```bash
corso repo connect s3 [flags] corso repo connect s3 --bucket <bucket> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--bucket`|||Name of the S3 bucket (required).| |`--bucket`|||Name of S3 bucket for repo. <div class='required'>Required</div>|
|`--prefix`|||Prefix applied to objects in the bucket.| |`--prefix`|||Repo prefix within bucket.|
|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| |`--endpoint`||`s3.amazonaws.com`|S3 service endpoint.|
|`--help`|`-h`|`false`|help for s3| |`--help`|`-h`|`false`|help for s3|
### Global and inherited flags ### Global and inherited flags

8
docs/docs/cli/corso_repo_init_s3.md
View File

@ -7,16 +7,16 @@ hide_title: true
Bootstraps a new S3 repository and connects it to your m356 account. Bootstraps a new S3 repository and connects it to your m356 account.
```bash ```bash
corso repo init s3 [flags] corso repo init s3 --bucket <bucket> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--bucket`|||Name of the S3 bucket (required).| |`--bucket`|||Name of S3 bucket for repo. <div class='required'>Required</div>|
|`--prefix`|||Prefix applied to objects in the bucket.| |`--prefix`|||Repo prefix within bucket.|
|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| |`--endpoint`||`s3.amazonaws.com`|S3 service endpoint.|
|`--help`|`-h`|`false`|help for s3| |`--help`|`-h`|`false`|help for s3|
### Global and inherited flags ### Global and inherited flags

38
docs/docs/cli/corso_restore_exchange.md
View File

@ -7,31 +7,31 @@ hide_title: true
Restore M365 Exchange service data Restore M365 Exchange service data
```bash ```bash
corso restore exchange [flags] corso restore exchange --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup to restore| |`--backup`|||ID of the backup to restore. <div class='required'>Required</div>|
|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| |`--user`||``|Restore data by user ID; accepts * to select all users.|
|`--email`||`[]`|Restore emails by ID; accepts * to select all emails| |`--email`||``|Restore emails by ID; accepts * to select all emails.|
|`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders| |`--email-folder`||``|Restore emails within a folder; accepts * to select all email folders.|
|`--email-subject`|||Restore mail where the email subject lines contain this value| |`--email-subject`|||Restore emails with a subject containing this value.|
|`--email-sender`|||Restore mail where the email sender matches this user id| |`--email-sender`|||Restore emails from a specific sender.|
|`--email-received-after`|||Restore mail where the email was received after this datetime| |`--email-received-after`|||Restore emails received after this datetime.|
|`--email-received-before`|||Restore mail where the email was received before this datetime| |`--email-received-before`|||Restore emails received before this datetime.|
|`--event`||`[]`|Restore events by ID; accepts * to select all events| |`--event`||``|Restore events by event ID; accepts * to select all events.|
|`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars| |`--event-calendar`||``|Restore events under a calendar; accepts * to select all event calendars.|
|`--event-subject`|||Restore events where the event subject contains this value| |`--event-subject`|||Restore events with a subject containing this value.|
|`--event-organizer`|||Restore events where the event organizer user id contains this value| |`--event-organizer`|||Restore events from a specific organizer.|
|`--event-recurs`|||Restore events if the event recurs. Use `--event-recurs false` to select non-recurring events| |`--event-recurs`|||Restore recurring events. Use `--event-recurs false` to restore non-recurring events.|
|`--event-starts-after`|||Restore events where the event starts after this datetime| |`--event-starts-after`|||Restore events starting after this datetime.|
|`--event-starts-before`|||Restore events where the event starts before this datetime| |`--event-starts-before`|||Restore events starting before this datetime.|
|`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts| |`--contact`||``|Restore contacts by contact ID; accepts * to select all contacts.|
|`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders| |`--contact-folder`||``|Restore contacts within a folder; accepts * to select all contact folders.|
|`--contact-name`|||Restore contacts where the contact name contains this value| |`--contact-name`|||Restore contacts whose contact name contains this value.|
|`--help`|`-h`|`false`|help for exchange| |`--help`|`-h`|`false`|help for exchange|
### Global and inherited flags ### Global and inherited flags

12
docs/docs/cli/corso_restore_onedrive.md
View File

@ -7,15 +7,21 @@ hide_title: true
Restore M365 OneDrive service data Restore M365 OneDrive service data
```bash ```bash
corso restore onedrive [flags] corso restore onedrive --backup <backupId> [flags]
``` ```
### Flags ### Flags
|Flag|Short|Default|Help| |Flag|Short|Default|Help|
|:----|:-----|:-------|:----| |:----|:-----|:-------|:----|
|`--backup`|||ID of the backup to restore| |`--backup`|||ID of the backup to restore. <div class='required'>Required</div>|
|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| |`--user`||``|Restore data by user ID; accepts * to select all users.|
|`--folder`||``|Restore items by OneDrive folder; defaults to root|
|`--file-name`||``|Restore items by OneDrive file name|
|`--file-created-after`|||Restore files created after this datetime|
|`--file-created-before`|||Restore files created before this datetime|
|`--file-modified-after`|||Restore files modified after this datetime|
|`--file-modified-before`|||Restore files modified before this datetime|
|`--help`|`-h`|`false`|help for onedrive| |`--help`|`-h`|`false`|help for onedrive|
### Global and inherited flags ### Global and inherited flags