public/Update-VSAAgentNote.ps1
|
function Update-VSAAgentNote { <# .Synopsis Changes an agent note. .DESCRIPTION Changes an agent note. Takes either persistent or non-persistent connection information. .PARAMETER VSAConnection Specifies existing non-persistent VSAConnection. .PARAMETER URISuffix Specifies URI suffix if it differs from the default. .PARAMETER NoteId Id of note that is changed. .PARAMETER Note Note text. .EXAMPLE Update-VSAAgentNote -NoteId 1 -Note 'Changed note' .EXAMPLE Update-VSAAgentNote -NoteId 1 -Note 'Changed note' -VSAConnection $connection .INPUTS Accepts piped non-persistent VSAConnection .OUTPUTS True if update was successful #> [CmdletBinding()] param ( [parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [ValidateNotNull()] [VSAConnection] $VSAConnection, [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [string] $URISuffix = 'api/v1.0/assetmgmt/agent/notes', [Parameter(Mandatory = $true)] [Parameter(ParameterSetName = 'NonPersistent', Mandatory = $false)] [ValidateScript({ if( $_ -notmatch "^\d+$" ) { throw "Non-numeric Id" } return $true })] [string] $NoteId, [Parameter(Mandatory = $true)] [Parameter(ParameterSetName = 'NonPersistent', Mandatory = $false)] [ValidateNotNullOrEmpty()] [string] $Note ) [bool]$result = $false [hashtable]$BodyHT=@{} $BodyHT.Add($NoteId, $Note) [hashtable]$Params = @{} if($VSAConnection) {$Params.Add('VSAConnection', $VSAConnection)} If ( $NoteId -in $(Get-VSAAgentNote @Params | Select-Object -ExpandProperty ID) ) { $Params.Add('URISuffix', $URISuffix) $Params.Add('Method', 'PUT') $Params.Add('Body', $(ConvertTo-Json $BodyHT)) $result = Update-VSAItems @Params } else { $Message = "The agent note with ID `'$NoteId`' does not exist" throw $Message } return $result } Export-ModuleMember -Function Update-VSAAgentNote |