Public/Get-MIATask.ps1
|
function Get-MIATask { <# .SYNOPSIS Get MOVEit Automation Task(s) #> [CmdletBinding(DefaultParameterSetName='List')] [OutputType('MOVEit.MIA.Task', ParameterSetName=('Detail','List'))] [OutputType('MOVEit.MIA.TaskRunning', ParameterSetName='Running')] param ( [Parameter(Mandatory, Position=0, ValueFromPipeline, ValueFromPipelineByPropertyName=$true, ParameterSetName='Detail')] [ValidateNotNullOrEmpty()] [Alias('Id')] [string]$TaskId, [Parameter(Mandatory, ParameterSetName='Running')] [switch]$Running, [Parameter(ParameterSetName='List')] [Parameter(ParameterSetName='Running')] [string]$Name, [Parameter(ParameterSetName='List')] [Parameter(ParameterSetName='Running')] [ValidateSet('Group','ID','Name','Info','NextActions', 'Schedules','Scheduled','steps','Active','AR', 'CacheNames','NextEID','TT','UseDefStateCaching', 'Watched',IgnoreCase = $false)] [string[]]$Fields, [Parameter(ParameterSetName='List')] [Parameter(ParameterSetName='Running')] [int32]$Page, [Parameter(ParameterSetName='List')] [Parameter(ParameterSetName='Running')] [int32]$PerPage, [Parameter(ParameterSetName='List')] [Parameter(ParameterSetName='Running')] [switch]$IncludePaging, # Context [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [string]$Context = $script:DEFAULT_CONTEXT ) begin { # Set the resourse for this request $resource = "tasks" # Set the typename for the output $typeName = 'MOVEit.MIA.Task' } # Place in a process block so if nothing is passed in, like via pipeline, the function doesn't try # to execute using missing data. process { try { # Send the request and write the response switch ($PSCmdlet.ParameterSetName) { 'Detail' { Invoke-MIARequest -Resource "$resource/$TaskId" -Context $Context | Write-MIAResponse -TypeName $typeName } 'Running' { $query = @{} switch ($PSBoundParameters.Keys) { Name { $query['name'] = $Name } Fields { $query['fields'] = $Fields -join ',' } Page { $query['page'] = $Page } PerPage { $query['perPage'] = $PerPage } } Invoke-MIARequest -Resource "$resource/running" -Body $query -Context $Context | Write-MIAResponse -Typename "${typeName}Running" -IncludePaging:$IncludePaging } 'List' { $query = @{} switch ($PSBoundParameters.Keys) { Name { $query['name'] = $Name } Fields { $query['fields'] = $Fields -join ',' } Page { $query['page'] = $Page } PerPage { $query['perPage'] = $PerPage } } Invoke-MIARequest -Resource "$resource" -Body $query -Context $Context | Write-MIAResponse -Typename $typeName -IncludePaging:$IncludePaging } } } catch { $PSCmdlet.ThrowTerminatingError($PSItem) } } } |