M365Tools

This repo is for any useful tools and scripts for Microsoft 365.

PowerShell Cmdlets:

Copy-SPOFolder

Why it exists:

The PnP Powershell library has a Copy-PnPFile cmdlet with important advantages over copying or moving with the SharePoint UI:

• Copies include the version history
• Copies include the correct Created, CreatedBy, LastModified, and LastModifiedBy metadata wherever possible.

However there was nothing (when I wrote this) to copy an entire library or folder. I was working with a few clients on migrations, and once we did a lift-and-shift into the tenant, we needed a way to further copy/move folders around. Since no one loves building delimited files, I went with a SharePoint list with a UX similar to most migration tools, i.e., with Source and Target columns, and an Action column to indicate the status of each row.

An even better implementation might be to create a Form to "Request a folder Move" with guidance along the way (paste source, paste target, etc.), and to post a link to this form from a Help Desk page. Power Automate would copy new requests into the SPO list so no one ever needs to interact directly with the list, and perhaps a step for IT to notify the user by email that the job is complete would wrap it up.

Minimal path to awesome:

• Open Powershell to the folder with the .ps1 files and execute: Copy-SPOFolder -Source [url] -Target [url]

Alternative path to awesome:

1. Create and configure a SharePoint List:
   • Create a SharePoint List with the Blank List template named "Copy a Folder"
   • Open List Settings and rename the Title column to SourceUrl.
   • Create a Single line of text column named TargetUrl. Rename this column after creation if you prefer a different display name.
   • Create a Text column called Action. Set the column's default value to Copy
2. If you chose different column names or labels in Step 1, locate the section "# Define variables" below and update the values as needed.
3. Add a few rows with valid source and target values for testing. Note that the target library or subfolder must exist, create as needed.
4. Install PnP PowerShell
5. Execute the script, e.g.: Copy-SPOFolder -verbose -siteUrl "https://contoso.sharepoint.com/sites/SharePointTools"

Step 1:

Step 3:

Step 5:

Suggestions

There are a few ideas already considered (or [x] implemented): [x] Add a -ListUrl parameter (used instead of -SiteUrl) so no one ever needs to edit the hardcoded list name. Done! [ ] Either use this as a starting point of a Move-SPOList cmdlet, or add a -DeleteSource parameter to accomplish the same. [x] Support the SPO uri format provided by the Copy Link buttons. [x] Provide the option to set the Copy List column names as parameters. [ ] Submit a command-line only version to the PnP Powershell project. [ ] Document the steps to deploy the script as an Azure Function App, and provide a means of kicking off the Copy from the Copy List. This would require extensive changes to the authentication sections in order to use credentials securely stored with the Azure Function.

All are welcome to join the project, pull requests to implement these and other are ideas more than welcome.