mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update to powershell SDK docs: 14068083503
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload
|
||||
title: ScheduledActionPayload
|
||||
pagination_label: ScheduledActionPayload
|
||||
sidebar_label: ScheduledActionPayload
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionPayload
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**JobType** | **Enum** [ "BACKUP", "CREATE_DRAFT", "CONFIG_DEPLOY_DRAFT" ] | Type of the scheduled job. | [required]
|
||||
**StartTime** | **System.DateTime** | The time when this scheduled action should start. Optional. | [optional]
|
||||
**CronString** | **String** | Cron expression defining the schedule for this action. Optional for repeated events. | [optional]
|
||||
**TimeZoneId** | **String** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [optional]
|
||||
**Content** | [**ScheduledActionPayloadContent**](scheduled-action-payload-content) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionPayload = Initialize-PSSailpoint.V2024ScheduledActionPayload -JobType BACKUP `
|
||||
-StartTime 2024-08-16T14:16:58.389Z `
|
||||
-CronString 0 0 12 * * ? `
|
||||
-TimeZoneId America/Chicago `
|
||||
-Content null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionPayload | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload-content
|
||||
title: ScheduledActionPayloadContent
|
||||
pagination_label: ScheduledActionPayloadContent
|
||||
sidebar_label: ScheduledActionPayloadContent
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload-content
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionPayloadContent
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the scheduled action (maximum 50 characters). | [required]
|
||||
**BackupOptions** | [**ScheduledActionPayloadContentBackupOptions**](scheduled-action-payload-content-backup-options) | | [optional]
|
||||
**SourceBackupId** | **String** | ID of the source backup. Required for CREATE_DRAFT jobs. | [optional]
|
||||
**SourceTenant** | **String** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [optional]
|
||||
**DraftId** | **String** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionPayloadContent = Initialize-PSSailpoint.V2024ScheduledActionPayloadContent -Name Daily Backup `
|
||||
-BackupOptions null `
|
||||
-SourceBackupId 5678b87d-48ca-439a-868f-2160001da8c2 `
|
||||
-SourceTenant tenant-name `
|
||||
-DraftId 9012b87d-48ca-439a-868f-2160001da8c3
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionPayloadContent | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload-content-backup-options
|
||||
title: ScheduledActionPayloadContentBackupOptions
|
||||
pagination_label: ScheduledActionPayloadContentBackupOptions
|
||||
sidebar_label: ScheduledActionPayloadContentBackupOptions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload-content-backup-options
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionPayloadContentBackupOptions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IncludeTypes** | **[]String** | Object types that are to be included in the backup. | [optional]
|
||||
**ObjectOptions** | [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionPayloadContentBackupOptions = Initialize-PSSailpoint.V2024ScheduledActionPayloadContentBackupOptions -IncludeTypes [ROLE, IDENTITY_PROFILE] `
|
||||
-ObjectOptions {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionPayloadContentBackupOptions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response
|
||||
title: ScheduledActionResponse
|
||||
pagination_label: ScheduledActionResponse
|
||||
sidebar_label: ScheduledActionResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique identifier for this scheduled action. | [optional]
|
||||
**Created** | **System.DateTime** | The time when this scheduled action was created. | [optional]
|
||||
**JobType** | **Enum** [ "BACKUP", "CREATE_DRAFT", "CONFIG_DEPLOY_DRAFT" ] | Type of the scheduled job. | [optional]
|
||||
**Content** | [**ScheduledActionResponseContent**](scheduled-action-response-content) | | [optional]
|
||||
**StartTime** | **System.DateTime** | The time when this scheduled action should start. | [optional]
|
||||
**CronString** | **String** | Cron expression defining the schedule for this action. | [optional]
|
||||
**TimeZoneId** | **String** | Time zone ID for interpreting the cron expression. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionResponse = Initialize-PSSailpoint.V2024ScheduledActionResponse -Id 3469b87d-48ca-439a-868f-2160001da8c1 `
|
||||
-Created 2021-05-11T22:23:16Z `
|
||||
-JobType BACKUP `
|
||||
-Content null `
|
||||
-StartTime 2021-05-12T10:00Z `
|
||||
-CronString 0 0 12 * * ? `
|
||||
-TimeZoneId America/Chicago
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content
|
||||
title: ScheduledActionResponseContent
|
||||
pagination_label: ScheduledActionResponseContent
|
||||
sidebar_label: ScheduledActionResponseContent
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionResponseContent
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the scheduled action (maximum 50 characters). | [optional]
|
||||
**BackupOptions** | [**ScheduledActionResponseContentBackupOptions**](scheduled-action-response-content-backup-options) | | [optional]
|
||||
**SourceBackupId** | **String** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [optional]
|
||||
**SourceTenant** | **String** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [optional]
|
||||
**DraftId** | **String** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionResponseContent = Initialize-PSSailpoint.V2024ScheduledActionResponseContent -Name Daily Backup `
|
||||
-BackupOptions null `
|
||||
-SourceBackupId 5678b87d-48ca-439a-868f-2160001da8c2 `
|
||||
-SourceTenant tenant-name `
|
||||
-DraftId 9012b87d-48ca-439a-868f-2160001da8c3
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionResponseContent | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content-backup-options
|
||||
title: ScheduledActionResponseContentBackupOptions
|
||||
pagination_label: ScheduledActionResponseContentBackupOptions
|
||||
sidebar_label: ScheduledActionResponseContentBackupOptions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content-backup-options
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionResponseContentBackupOptions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IncludeTypes** | **[]String** | Object types that are to be included in the backup. | [optional]
|
||||
**ObjectOptions** | [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionResponseContentBackupOptions = Initialize-PSSailpoint.V2024ScheduledActionResponseContentBackupOptions -IncludeTypes [ROLE, IDENTITY_PROFILE] `
|
||||
-ObjectOptions {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionResponseContentBackupOptions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content-backup-options-object-options-value
|
||||
title: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
pagination_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
sidebar_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content-backup-options-object-options-value
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||
---
|
||||
|
||||
|
||||
# ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IncludedNames** | **[]String** | Set of names to be included. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ScheduledActionResponseContentBackupOptionsObjectOptionsValue = Initialize-PSSailpoint.V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue -IncludedNames [Admin Role, User Role]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ScheduledActionResponseContentBackupOptionsObjectOptionsValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user