LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 14212780503

Browse Source
This commit is contained in:
developer-relations-sp
2025-04-02 06:13:18 +00:00
parent 72b9bb1f90
commit cab77035bd
20 changed files with 6157 additions and 6104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

4
docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

2
docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md
View File

@@ -235,7 +235,7 @@ Param Type | Name | Data Type | Required | Description
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq*
### Return type ### Return type
[**ManagedCluster[]**](../models/managed-cluster) [**ManagedCluster[]**](../models/managed-cluster)
@@ -259,7 +259,7 @@ Code | Description | Data Type
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) $Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
# Get Managed Clusters # Get Managed Clusters

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

8
docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md
View File

@@ -18,8 +18,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**Id** | **String** | ManagedClient ID | [optional] [readonly] **Id** | **String** | ManagedClient ID | [optional] [readonly]
**AlertKey** | **String** | ManagedClient alert key | [optional] [readonly] **AlertKey** | **String** | ManagedClient alert key | [optional] [readonly]
**ApiGatewayBaseUrl** | **String** | | [optional] **ApiGatewayBaseUrl** | **String** | apiGatewayBaseUrl for the Managed client | [optional]
**Cookbook** | **String** | | [optional] **Cookbook** | **String** | cookbook id for the Managed client | [optional]
**CcId** | **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] **CcId** | **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional]
**ClientId** | **String** | The client ID used in API management | [required] **ClientId** | **String** | The client ID used in API management | [required]
**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] **ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required]
@@ -37,6 +37,7 @@ Name | Type | Description | Notes
**CreatedAt** | **System.DateTime** | The date/time this ManagedClient was created | [optional] **CreatedAt** | **System.DateTime** | The date/time this ManagedClient was created | [optional]
**UpdatedAt** | **System.DateTime** | The date/time this ManagedClient was last updated | [optional] **UpdatedAt** | **System.DateTime** | The date/time this ManagedClient was last updated | [optional]
**ProvisionStatus** | **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] **ProvisionStatus** | **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly]
**HealthIndicators** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The health indicators of the ManagedClient | [optional]
## Examples ## Examples
@@ -62,7 +63,8 @@ $ManagedClient = Initialize-PSSailpoint.V2024ManagedClient -Id 2c9180878eaf4204
-Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 `
-CreatedAt 2023-08-04T20:48:01.865Z ` -CreatedAt 2023-08-04T20:48:01.865Z `
-UpdatedAt 2023-08-04T20:48:01.865Z ` -UpdatedAt 2023-08-04T20:48:01.865Z `
-ProvisionStatus PROVISIONED -ProvisionStatus PROVISIONED `
-HealthIndicators { "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } }
``` ```
- Convert the resource to JSON - Convert the resource to JSON

14
docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md
View File

@@ -41,6 +41,12 @@ Name | Type | Description | Notes
**CcId** | **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] **CcId** | **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"]
**CreatedAt** | **System.DateTime** | The date/time this cluster was created | [optional] **CreatedAt** | **System.DateTime** | The date/time this cluster was created | [optional]
**UpdatedAt** | **System.DateTime** | The date/time this cluster was last updated | [optional] **UpdatedAt** | **System.DateTime** | The date/time this cluster was last updated | [optional]
**LastReleaseNotifiedAt** | **System.DateTime** | The date/time this cluster was notified for the last release | [optional]
**UpdatePreferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional]
**CurrentInstalledReleaseVersion** | **String** | The current installed release on the Managed cluster | [optional]
**UpdatePackage** | **String** | New available updates for the Managed cluster | [optional]
**IsOutOfDateNotifiedAt** | **System.DateTime** | The time at which out of date notification was sent for the Managed cluster | [optional]
**ConsolidatedHealthIndicatorsStatus** | **Enum** [ "NORMAL", "WARNING", "ERROR" ] | The consolidated Health Status for the Managed cluster | [optional]
## Examples ## Examples
@@ -70,7 +76,13 @@ $ManagedCluster = Initialize-PSSailpoint.V2024ManagedCluster -Id e1ff7bb24c9342
-ServiceCount 6 ` -ServiceCount 6 `
-CcId 1533 ` -CcId 1533 `
-CreatedAt 2023-08-04T20:48:01.865Z ` -CreatedAt 2023-08-04T20:48:01.865Z `
-UpdatedAt 2023-08-04T20:48:01.865Z -UpdatedAt 2023-08-04T20:48:01.865Z `
-LastReleaseNotifiedAt 2025-03-11T07:00:13.729721Z `
-UpdatePreferences null `
-CurrentInstalledReleaseVersion 123.1 `
-UpdatePackage null `
-IsOutOfDateNotifiedAt 2025-03-11T07:00:13.734393Z `
-ConsolidatedHealthIndicatorsStatus ERROR
``` ```
- Convert the resource to JSON - Convert the resource to JSON

39
docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-managed-cluster-update-preferences
title: ManagedClusterUpdatePreferences
pagination_label: ManagedClusterUpdatePreferences
sidebar_label: ManagedClusterUpdatePreferences
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences']
slug: /tools/sdk/powershell/v2024/models/managed-cluster-update-preferences
tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences']
---
# ManagedClusterUpdatePreferences
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ProcessGroups** | **String** | The processGroups for updatePreferences | [optional]
**UpdateState** | **Enum** [ "AUTO", "DISABLED" ] | The current updateState for the cluster | [optional]
**NotificationEmail** | **String** | The mail id to which new releases will be notified | [optional]
## Examples
- Prepare the resource
```powershell
$ManagedClusterUpdatePreferences = Initialize-PSSailpoint.V2024ManagedClusterUpdatePreferences -ProcessGroups null `
-UpdateState DISABLED `
-NotificationEmail test@mail.com
```
- Convert the resource to JSON
```powershell
$ManagedClusterUpdatePreferences | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

2
docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

2
docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

4
docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2025NonEmployee
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

2
docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

2
docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10 -Count 10
``` ```

4
docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq
-ApprovalStatus null ` -ApprovalStatus null `
-Comment approved ` -Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 ` -CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 ` -StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 ` -EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 ` -Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00 -Created 2020-03-24T11:11:41.139-05:00
``` ```

2
docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource - Prepare the resource
```powershell ```powershell
$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` $SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45 -Count 10.45
``` ```

2564
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

File diff suppressed because it is too large Load Diff

3592
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

File diff suppressed because it is too large Load Diff

3534
static/code-examples/v2025/powershell_code_examples_overlay.yaml
View File

File diff suppressed because it is too large Load Diff

2474
static/code-examples/v3/powershell_code_examples_overlay.yaml
View File

File diff suppressed because it is too large Load Diff