New command: m365 spo archivefile list

[Saurabh7019]

Usage

m365 spo archivefile list [options]

Description

Lists archived files in a document library

Options

Option	Description
-u, --webUrl <webUrl>	The URL of the site where the document library is located.
-i, --id [id]	ID of the document library to list archived files from. Specify either id, title, or url, but not multiple.
-t, --title [title]	Title of the document library to list archived files from. Specify either id, title, or url, but not multiple.
--url [url]	Server- or site-relative URL of the document library. Specify either id, title, or url, but not multiple.

Examples

List archived files in a document library by title

m365 spo archivefile list --webUrl https://contoso.sharepoint.com/sites/Marketing --title Documents

List archived files in a document library by ID

m365 spo archivefile list --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7a8c9207-7745-4cda-b0e2-be2618ee3030

List archived files in a document library by URL

m365 spo archivefile list --webUrl https://contoso.sharepoint.com/sites/Marketing --url '/sites/Marketing/Documents'

Default properties

• name
• archiveStatus
• size
• webUrl
• createdDateTime
• lastModifiedDateTime

Additional Info

Per Microsoft 365 Archive developer guidance, the following enumeration APIs are recommended:

GET https://graph.microsoft.com/v1.0/drives/{drive-id}/root/children

GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items/driveItem

GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items?$expand=fields($select=_FileArchiveStatus)

[Saurabh7019]

I know the command name is not correct, but I am not sure what it should be.

[milanholemans]

I think there are two ways to go here:

1. We enhance spo file list with the ability to list archived files only.
2. We create a command spo file archive list (while we already have a spo file archive command.

I would slightly prefer option 1 here since the only thing we want to do is list all files, with an additional filter, right? Even the output will be the same, right? @pnp/cli-for-microsoft-365-maintainers, any other ideas?

What I also suggest: we try to use SP REST API as much as possible in the spo service. This makes sure that users can just consent SPO permissions and use nearly all commands. If we would use Graph for this command, it would differ a lot from the other commands and will require the user to consent additional permissions. Therefore, I also suggest that we look into a SP REST API for this command.

[Saurabh7019]

1. We enhance spo file list with the ability to list archived files only.

I thought about this, but spo file list requires --folderUrl. A user passing --folderUrl '/sites/Marketing/Documents/ABC' --type archived would expect only that subfolder to be scanned, not the entire library.