Skip to main content

TaskStatus

Properties

NameTypeDescriptionNotes
IdStringSystem-generated unique ID of the task this TaskStatus represents[required]
TypeEnum [ "QUARTZ", "QPOC", "QUEUED_TASK" ]Type of task this TaskStatus represents[required]
UniqueNameStringName of the task this TaskStatus represents[required]
DescriptionStringDescription of the task this TaskStatus represents[required]
ParentNameStringName of the parent of the task this TaskStatus represents[required]
LauncherStringService to execute the task this TaskStatus represents[required]
TargetTarget[optional]
CreatedSystem.DateTimeCreation date of the task this TaskStatus represents[required]
ModifiedSystem.DateTimeLast modification date of the task this TaskStatus represents[required]
LaunchedSystem.DateTimeLaunch date of the task this TaskStatus represents[required]
CompletedSystem.DateTimeCompletion date of the task this TaskStatus represents[required]
CompletionStatusEnum [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMPERROR" ]Completion status of the task this TaskStatus represents[required]
Messages[]TaskStatusMessageMessages associated with the task this TaskStatus represents[required]
Returns[]TaskReturnDetailsReturn values from the task this TaskStatus represents[required]
Attributes[map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4Attributes of the task this TaskStatus represents[required]
ProgressStringCurrent progress of the task this TaskStatus represents[required]
PercentCompleteInt32Current percentage completion of the task this TaskStatus represents[required]
TaskDefinitionSummaryTaskDefinitionSummary[optional]

Examples

  • Prepare the resource
$TaskStatus = Initialize-PSSailpoint.V2024TaskStatus  -Id id12345 `
-Type QUARTZ `
-UniqueName Big Task `
-Description A Really Big Task `
-ParentName Parent Task `
-Launcher sweep `
-Target null `
-Created 2020-07-11T21:23:15Z `
-Modified 2020-07-11T21:23:15Z `
-Launched 2020-07-11T21:23:15Z `
-Completed 2020-07-11T21:23:15Z `
-CompletionStatus SUCCESS `
-Messages null `
-Returns null `
-Attributes {identityCount=0} `
-Progress Started `
-PercentComplete 100 `
-TaskDefinitionSummary null
  • Convert the resource to JSON
$TaskStatus | ConvertTo-JSON

[Back to top]