New command: spo file archive

[Saurabh7019]

Usage

m365 spo file archive [options]

Description

Archives a file

Options

Option	Description
-u, --webUrl <webUrl>	The URL of the site where the file is located.
--url [url]	The server- or site-relative decoded URL of the file to archive. Specify either url or id, but not both.
-i, --id [id]	The UniqueId (GUID) of the file to archive. Specify either url or id, but not both.
-f, --force	Do not prompt for confirmation.

Examples

Archive a file without prompting for confirmation

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

Archive a file by URL with prompting for confirmation

m365 spo file archive --webUrl https://contoso.sharepoint.com/sites/Marketing --url /sites/Marketing/shared%20documents/document.docx

Default properties

No response

Additional Info

POST https://contoso.sharepoint.com/_api/Lists(guid'${listId}')/items(${itemId})/Archive`

[milanholemans]

Nice spec @Saurabh7019, once again, thanks for the help here!

A few comments from my side:

• Let's keep options in sync with other commands like spo file get
  • Use -u for webUrl
  • Rename fileUrl to url, do the same for fileId.
  • url should accept both server-relative and site-relative URLs.
• You mentioned the Microsoft Graph endpoint. I would like to prefer using the SharePoint REST API here. This way, we'll need fewer permission scopes to archive files. This will also make sure that the needed permissions are more in sync with other spo commands.

[Saurabh7019]

Hi @milanholemans, I checked the REST API and wanted to clarify the direction.

The /Archive endpoint is available on list items, and it works for bot files and folders.

POST /_api/Lists(guid'${listId}')/items(${itemId})/Archive

The file url/id parameters seems misleading. Should I update the spec to accept parameters like in spo listitem get

[milanholemans]

I would keep the parameters uniform. Since you can only archive files and folder and not list item (as far as I know), it won't make sense to expose this API as spo listitem archive.
I would still go with spo file archive and keep the same parameters which are used in other spo file commands. Behind the scenes, we'll just have to get the list item ID of that specific file in order to perform the API request.

[Saurabh7019]

Good, then I will keep it as is. Please assign it to me when it is ready to be opened.

also, will there be a new set of commands for folders, or the same command with additional examples for folders?

[milanholemans]

also, will there be a new set of commands for folders, or the same command with additional examples for folders?

I'd create additional commands for that: spo folder archive and spo folder unarchive. I've added them to the epic issue as well.