Skip to main content

BackupResponse

Properties

NameTypeDescriptionNotes
JobIdStringUnique id assigned to this backup.[optional]
StatusEnum [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ]Status of the backup.[optional]
TypeEnum [ "BACKUP" ]Type of the job, will always be BACKUP for this type of job.[optional]
TenantStringThe name of the tenant performing the upload[optional]
RequesterNameStringThe name of the requester.[optional]
FileExistsBooleanWhether or not a file was created and stored for this backup.[optional] [default to $true]
CreatedSystem.DateTimeThe time the job was started.[optional]
ModifiedSystem.DateTimeThe time of the last update to the job.[optional]
CompletedSystem.DateTimeThe time the job was completed.[optional]
NameStringThe name assigned to the upload file in the request body.[optional]
UserCanDeleteBooleanWhether this backup can be deleted by a regular user.[optional] [default to $true]
IsPartialBooleanWhether this backup contains all supported object types or only some of them.[optional] [default to $false]
BackupTypeEnum [ "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]
OptionsBackupOptions[optional]
HydrationStatusEnum [ "HYDRATED", "NOT_HYDRATED" ]Whether the object details of this backup are ready.[optional]
TotalObjectCountInt64Number of objects contained in this backup.[optional]
CloudStorageStatusEnum [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ]Whether this backup has been transferred to a customer storage location.[optional]

Examples

  • Prepare the resource
$BackupResponse = Initialize-PSSailpoint.V3BackupResponse  -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
$BackupResponse | ConvertTo-JSON

[Back to top]