mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Refactor docusaurus site for Identity Security Cloud
This commit is contained in:
45
docs/tools/sdk/powershell/error-handling.md
Normal file
45
docs/tools/sdk/powershell/error-handling.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: powershell-sdk-error-handling
|
||||
title: Error Handling with the PowerShell SDK
|
||||
pagination_label: PowerShell SDK
|
||||
sidebar_label: Error Handling
|
||||
sidebar_position: 7
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'sdk', 'error']
|
||||
description: Learn how to delete resources using the PowerShell SDK in this guide.
|
||||
slug: /tools/sdk/powershell/error-handling
|
||||
tags: ['SDK']
|
||||
---
|
||||
|
||||
The SDK uses the Invoke-WebRequest cmdlet to handle HTTP requests. Invoke-WebRequest will throw a terminating error for any response that falls out of the range of 2xx. A non-2xx response will immediately halt the program and produce a stack trace.
|
||||
|
||||
You can use a `try/catch` function to intercept any non success response and take actions on the results, such as logging the message or performing additional actions before exiting the program:
|
||||
|
||||
```powershell
|
||||
# Catch any non 2xx response and log the status code and error message
|
||||
try {
|
||||
Get-Transforms -Filters "id eq"
|
||||
}
|
||||
catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
The `catch` block will handle the error, and the script execution will continue. If you want to stop the scripts execution, include an `Exit` in the `catch` block:
|
||||
|
||||
This code ensures that the `Get-AccessProfiles` cmdlet will never be called:
|
||||
|
||||
```powershell
|
||||
# Catch any non 2xx response and log the status code and error message. Stop the script with the Exit keyword.
|
||||
try {
|
||||
Get-Transforms -Filters "id eq"
|
||||
}
|
||||
catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__
|
||||
Write-Host $_.ErrorDetails
|
||||
Exit
|
||||
}
|
||||
|
||||
Get-AccessProfiles
|
||||
```
|
||||
Reference in New Issue
Block a user