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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,10 +27,13 @@ Method | HTTP request | Description
[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
## create-managed-cluster
Create a new Managed Cluster.
The API returns a result that includes the managed cluster ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,19 +72,22 @@ $ManagedClusterRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest
# New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-cluster
Delete an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $RemoveClients = $false # Boolean | Flag to determine the need to delete a clust
# Delete Managed Cluster
try {
Remove-V2024ManagedCluster -V2024Id $Id
Remove-V2024ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients
# Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-client-log-configuration
Get a managed cluster's log configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to
# Get Managed Cluster Log Configuration
try {
Get-V2024ClientLogConfiguration -V2024Id $Id
Get-V2024ClientLogConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ClientLogConfiguration -V2024Id $Id
# Get-V2024ClientLogConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-cluster
Get a managed cluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,19 +212,22 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get Managed Cluster
try {
Get-V2024ManagedCluster -V2024Id $Id
Get-V2024ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedCluster -V2024Id $Id
# Get-V2024ManagedCluster -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clusters
List current organization's managed clusters, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -248,19 +263,22 @@ $Filters = 'operational eq "operation"' # String | Filter results using the stan
# Get Managed Clusters
try {
Get-V2024ManagedClusters
Get-V2024ManagedClusters
# Below is a request that includes all optional parameters
# Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters
# Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-client-log-configuration
Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -294,19 +312,22 @@ $PutClientLogConfigurationRequest = @""@
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $Result
Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest
# Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-cluster
Update an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -345,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster"
Write-Host $_.ErrorDetails