FastTrack/scripts/Get-DocLibInventory

Microsoft FastTrack Open Source - Get-DocLibInventory

The purpose of this script is to gather a simple inventory for a SharePoint Online document library.

Usage

Setup

1. Copy all scripts "Lib folder" and "Get-DocLibInventory.ps1" to a folder on a computer with internet access
2. Ensure you install any needed dependencies listed.

Run

1. Open a PowerShell command window
2. Navigate to the folder where you placed the script files during setup
3. Execute the following command, or adjust based on the desired parameters (listed below)

.\Get-DocLibInventory.ps1 -Url <Absolute Url to web> -ListTitle "Documents"

4. If required, authenticate to the site using the pop-up. If already authenticated you will notice a pop-up appear and close
5. Once the script is complete you will see the results on the console window. You can also pipe the results to various output for formatters:

# save as csv
.\Get-DocLibInventory.ps1 -Url "{absolute web url}" -ListTitle "{list title}" | Export-Csv -Path "my.csv" -Delimiter "," -NoTypeInformation

# format as a table
.\Get-DocLibInventory.ps1 -Url "{absolute web url}" -ListTitle "{list title}" | Format-Table Id,Title,Size -AutoSize

All Options

The script supports additional options, none are required except for the Url parameter.

Option	Description	Default
Url	Absolute url of the SharePoint web to inventory	required
ListTitle	Title of the library to process	required

External Dependencies

• PowerShell Version >= 5
• SharePointPnPPowerShellOnline Module
  • For SharePoint online you can use the command Install-Module SharePointPnPPowerShellOnline

Applies To

• SharePoint Online

Author

Author	Original Publish Date
Patrick Rodgers, Microsoft	December 19, 2018

Issues

Please report any issues you find to the issues list.

Support Statement

The scripts, samples, and tools made available through the FastTrack Open Source initiative are provided as-is. These resources are developed in partnership with the community and do not represent official Microsoft software. As such, support is not available through premier or other official support channels. If you find an issue or have questions please reach out through the issues list and we'll do our best to assist, but there is no support SLA associated with these tools.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Legal Notices

Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found at https://privacy.microsoft.com/en-us/

Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.