Get-KrTask

SYNOPSIS

Gets the status or result of a task by id.

SYNTAX

State 

Get-KrTask [-Server <KestrunHost>] [-Id <string>] [-State] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Without -Detailed returns task state; with -Detailed returns TaskResult snapshot.

EXAMPLES

EXAMPLE 1

Get-KrTask -Id ‘task-id’

Returns the current state of the specified task.

EXAMPLE 2

Get-KrTask -Id ‘task-id’ -Detailed Returns the detailed result of the specified task.

EXAMPLE 3

Get-KrTask

Returns a list of all tasks with their current states.

PARAMETERS

-Id

Task id to query.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Server

The Kestrun server instance.

Type: Kestrun.Hosting.KestrunHost
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-State

When present, return only the task state string.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: State
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Kestrun.Hosting.KestrunHost

{{ Fill in the Description }}

OUTPUTS

When -Detailed is specified

{{ Fill in the Description }}

Kestrun.Tasks.KrTask

{{ Fill in the Description }}

NOTES

{{ Fill in the related links here }}