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
}
- Move Copy Migrate SharePoint OneDrive files folders to different site collection location
- How to generate client id and secret to register SharePoint App with OAuth
- How to share SharePoint site or document with all users in organization
- Get-ADUser PowerShell - Get AD user details using email address
- error CAML Query containing special characters
- Access URL for SharePoint Tenant Admin Center (Online Office 365)
- Fix SharePoint Error - The Managed Metadata Service or Connection is currently not available. The Application Pool or Managed Metadata Web Service may not have been started
- SharePoint - The URL is invalid. It may refer to a nonexistent file or folder, or refer to a valid file or folder that is not in the current Web.
- How to delete SharePoint List Item programmatically using C#.Net
- How to Share Microsoft SharePoint Site with Users or Groups
- JSON column formatting to preview SharePoint Online file on mouse hover
- SharePoint List redirect user after submitting form NewForm.aspx
- See actual SharePoint error exception modify web.config
- SharePoint Server 2016 IT Preview Deprecated Removed features
- How to create SharePoint Document Library
- How to Get or Set SharePoint Document ID _dlc_DocId using PowerShell
- How to disable SharePoint subsite creation option for owners
- PowerShell - How to use Try Catch Finally blocks for error exception handling (Windows/SharePoint)
- SharePoint error - Your organization doesn't allow sharing with users from this domain. Please contact your IT department for help. (OSE403)
- [Solved] SharePoint Search Internal server error exception
- How to wrap column text in SharePoint Online Modern List Grid View using JSON formatting
- How to extend retiring SharePoint 2010 Workflows and continue with Office 365
- Changed AD user display name showing old name in SharePoint
- How to hide or remove quick launch left navigation from SharePoint Online Modern site page
- How to enable anonymous public access for SharePoint Online site collection, file, folder without login ?
- How to Get the List of Shells on Linux - Linux
- Android Eclipse This version of the rendering library is more recent than your version of ADT plug-in. Please update ADT plug-in - Android
- Android : Remove ListView Separator/divider programmatically or using xml property - Android
- Java JDBC Select Multiple Records from table as List using PreparedStatement - Java
- How to know installed version of Homebrew - MacOS
- Installation error: INSTALL_PARSE_FAILED_MANIFEST_MALFORMED - Android
- Redirect page using jQuery - jQuery
- Copy entire directory using Terminal Command [Linux, Mac, Bash] - Linux