If you are a programmer, you certainly use exception handling logic in your code or script, which is a best practice while coding. Exceptions may break your code and its necessary to catch and handle errors for a smoother execution in case something goes wrong. Identify what is wrong and ensure it does not break the code execution.
PowerShell too provides option to use try-catch blocks similar to other programming languages like .Net, Java.
Though the below examples are related to SharePoint Online, the approach remains same for any PowerShell script. You may even use try-catch with CSOM (Client Side Object Model), PnP.
Assumption - You already know basic commands of SharePoint Online Management Shell / Window ISE PowerShell to establish a connection with Microsoft Office 365 SharePoint Online Site Collection. Ensure you "Run as Administrator".
PowerShell Example - Basic Try-Catch block
try {
Connect-SPOService -Url "https://code2care.sharepoint.com/sites/PowerShell"
}
catch {
"There was an error connecting to the SharePoint site"
}
PowerShell Example - Catch multiple errors
try {
//Script
}
catch [Exception 1],[Exception 2] {
"Friendly error message"
}
catch {
"Generic error message"
}
Within a Catch block, the current error exception information can be accessed using $_, which is also known as $PSItem. The object is of type ErrorRecord.
PowerShell Example - Access information of current exception
try {
//Script
}
catch {
Write-Host "There was an error, error details below"
Write-Host $_ //This will print the error details
}
Additional properties that can be accessed related to the exception.
ScriptStackTrace
Exception
ErrorDetails
PowerShell Example - Print exact exception message
Example - You can use $_.Exception.Message to print the exact exception messagetry {
Connect-SPOService -Url "https://code2care.sharepoint.com/sites/PowerShell"
}
catch {
Write-host "There was an error - " $_.Exception.Message
}
This will print a message - There was an error - Could not connect to SharePoint Online.
⚡️ Terminating and Non Terminating errors
Exceptions are classified into 2 types -- Terminating error - halt/pause the function or operation
- Non-Terminating error - allow to continue further execution
PowerShell Example - Use 'ErrorAction' parameter to catch non-terminating error
Add '-ErrorAction Stop' at the end of cmdlet.try {
Connect-SPOService -Url "https://code2care.sharepoint.com/sites/PowerShell" -ErrorAction Stop
}
catch {
Write-host "Looks like the SharePoint site does not exist, please re-check."
}
PowerShell Example - Use '$ErrorActionPreference' variable to catch non-terminating error
Add '-ErrorAction Stop' at the end of cmdlet. Set '$ErrorActionPreference = "Stop"' to make errors as terminating, and set it back to "Continue" in Finally block.try {
$ErrorActionPreference = "Stop"
Connect-SPOService -Url "https://code2care.sharepoint.com/sites/PowerShell" -ErrorAction Stop
}
catch {
Write-host "Looks like the SharePoint site does not exist, please verify."
}
finally {
$ErrorActionPreference = "Continue"
}
We have used 2 actions for $ErrorActionPreference variable here (Stop and Continue), but it supports below values which tells what action to take for the error.
- Continue (default action) - Display/Print error message and continue execution of further commands.
- Stop - Terminate action with error.
- SilentlyContinue - Do not display error message and continue.
- Break - Debug error/exception to troubleshoot what went wrong.
- Inquire - Ask user whether to terminate or or continue.
- Ignore - Suppresses error and continue. Not recommended.
PowerShell Example - Use Finally block
This block runs always, irrespective of whether there was error or not. Use this section to perform action which should execute whether there was an error or not.try {
Connect-SPOService -Url "https://code2care.sharepoint.com/sites/PowerShell" -ErrorAction Stop
}
catch {
Write-host "Custom message."
}
finally {
//Write something which you want to execute always
}
- Managed Metadata error - The data returned from the tagging UI was not formatted correctly
- How to generate client id and secret to register SharePoint App with OAuth
- Create SharePoint Site Collection with new Content database in existing web application
- Fix Error 2711 SQL RBS client - The installer has encountered an unexpected error. The specified Feature name ('Docs') not found in Feature table
- How to exclude results from SharePoint Search
- 'Edit Document' Requires a Windows Sharepoint Services-compatible application and Microsoft Internet Explorer 6.0 or higher
- [Solved] SharePoint Access Denied error editing Document Name
- Recommended size and resolution for SharePoint Online Site logo
- SharePoint Server 2016 IT Preview - new improved Features and Enhancements
- Restore deleted Office 365 SharePoint group site
- SharePoint An unexpected error has occurred - Correlation ID and PowerShell Merge-SPlogfile
- [Solved] SharePoint Search Internal server error exception
- SharePoint CAML query error - The XML source is not correct
- How to hide quick launch in SharePoint classic site
- Not receiving email notification alert in SharePoint Online workflow - Power Automate, FLOW
- Change SharePoint search results FullTextSqlQuery RowLimit 10000
- Fix Power BI error Access to the resource is forbidden when connecting SharePoint Online List as data source
- [Fix] Restricted View permission level missing in SharePoint Online site library
- How to upload file programmatically to SharePoint Document Library using Server Object Model C# .Net
- How to create classic site in SharePoint Online
- That did'nt work, Issue type User not in directory - SharePoint external access error
- Merge-SPlogfile PowerShell - SharePoint Correlation ID error
- Fix Power BI 404 not found error when connecting SharePoint Online List as Data Source
- SharePoint Server 2016 IT Preview Deprecated Removed features
- SharePoint error - An exception occurred when trying to issue security token: This implementation is not part of the Windows Platform FIPS validated cryptographic algorithms..
- Word wrap text in Notepad++ - NotepadPlusPlus
- ls: .: Operation not permitted - Mac Big Sur Terminal Zsh Error - MacOS
- Android Images with Rounded Corners : ImageView - Android
- How to Download Jira App for Mac - Jira
- Android Disable back button programatically - Android
- How to enable Dark Mode in Windows 11 - Windows-11
- Check Bluetooth is turned on or off on Android device programmatically [Java Code] - Android
- How to know docker Engine details - Docker