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

adding docs back with new ids

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-27 16:01:17 -05:00
parent 90087c5d3f
commit b4a279954e
2823 changed files with 130835 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/tools/sdk/powershell/reference/v2024/Models/BackupResponse.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: backup-response
title: BackupResponse
pagination_label: BackupResponse
sidebar_label: BackupResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse']
slug: /tools/sdk/powershell/v2024/models/backup-response
tags: ['SDK', 'Software Development Kit', 'BackupResponse']
---
# BackupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**JobId** | Pointer to **String** | Unique id assigned to this backup. | [optional]
**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional]
**Type** | Pointer to **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional]
**Tenant** | Pointer to **String** | The name of the tenant performing the upload | [optional]
**RequesterName** | Pointer to **String** | The name of the requester. | [optional]
**FileExists** | Pointer to **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true]
**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional]
**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional]
**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional]
**Name** | Pointer to **String** | The name assigned to the upload file in the request body. | [optional]
**UserCanDelete** | Pointer to **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true]
**IsPartial** | Pointer to **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false]
**BackupType** | Pointer to **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional]
**Options** | Pointer to [**BackupOptions**](backup-options) | | [optional]
**HydrationStatus** | Pointer to **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional]
**TotalObjectCount** | Pointer to **Int64** | Number of objects contained in this backup. | [optional]
**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional]
## Examples
- Prepare the resource
```powershell
$BackupResponse = Initialize-PSSailpoint.V2024BackupResponse -JobId 3469b87d-48ca-439a-868f-2160001da8c1 `
-Status COMPLETE `
-Type BACKUP `
-Tenant tenant-name `
-RequesterName Requester Name `
-FileExists true `
-Created 2021-05-11T22:23:16Z `
-Modified 2021-05-11T22:23:16Z `
-Completed 2021-05-11T22:23:16Z `
-Name Backup Name `
-UserCanDelete false `
-IsPartial false `
-BackupType MANUAL `
-Options null `
-HydrationStatus NOT_HYDRATED `
-TotalObjectCount 10 `
-CloudStorageStatus SYNCED
```
- Convert the resource to JSON
```powershell
$BackupResponse | ConvertTo-JSON
```
[[Back to top]](#)