Public/Update-Operation.ps1
|
# Code generated from specification version 1.0.0: DO NOT EDIT Function Update-Operation { <# .SYNOPSIS Update operation .DESCRIPTION Update operation .EXAMPLE PS> Update-Operation -Id {{ NewOperation }} -Status EXECUTING Update an operation .EXAMPLE PS> Get-OperationCollection -Device $Agent.id -Status PENDING | Update-Operation -Status FAILED -FailureReason "manually cancelled" Update multiple operations #> [cmdletbinding(SupportsShouldProcess = $true, PositionalBinding=$true, HelpUri='', ConfirmImpact = 'High')] [Alias()] [OutputType([object])] Param( # Operation id [Parameter(ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [string] $Id, # Operation status, can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING. (required) [Parameter(Mandatory = $true)] [ValidateSet('PENDING','EXECUTING','SUCCESSFUL','FAILED')] [string] $Status, # Reason for the failure. Use when setting status to FAILED [Parameter()] [string] $FailureReason, # Additional properties describing the operation which will be performed on the device. [Parameter()] [hashtable] $Data, # Include raw response including pagination information [Parameter()] [switch] $Raw, # Outputfile [Parameter()] [string] $OutputFile, # NoProxy [Parameter()] [switch] $NoProxy, # Session path [Parameter()] [string] $Session, # Don't prompt for confirmation [Parameter()] [switch] $Force ) Begin { $Parameters = @{} if ($PSBoundParameters.ContainsKey("Status")) { $Parameters["status"] = $Status } if ($PSBoundParameters.ContainsKey("FailureReason")) { $Parameters["failureReason"] = $FailureReason } if ($PSBoundParameters.ContainsKey("Data")) { $Parameters["data"] = ConvertTo-JsonArgument $Data } if ($PSBoundParameters.ContainsKey("OutputFile")) { $Parameters["outputFile"] = $OutputFile } if ($PSBoundParameters.ContainsKey("NoProxy")) { $Parameters["noProxy"] = $NoProxy } if ($PSBoundParameters.ContainsKey("Session")) { $Parameters["session"] = $Session } } Process { $Parameters["id"] = PSc8y\Expand-Id $Id if (!$Force -and !$WhatIfPreference -and !$PSCmdlet.ShouldProcess( (PSc8y\Get-C8ySessionProperty -Name "tenant"), (Format-ConfirmationMessage -Name $PSCmdlet.MyInvocation.InvocationName -InputObject $item) )) { continue } Invoke-Command ` -Noun "operations" ` -Verb "update" ` -Parameters $Parameters ` -Type "application/vnd.com.nsn.cumulocity.operation+json" ` -ItemType "" ` -ResultProperty "" ` -Raw:$Raw ` -IncludeAll:$IncludeAll } End {} } |