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 successful #> [CmdletBinding()] param ( [parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [ValidateNotNull()] [VSAConnection] $VSAConnection, [parameter(DontShow, Mandatory=$false)] [ValidateNotNullOrEmpty()] [string] $URISuffix = 'api/v1.0/assetmgmt/agent/notes', [Parameter(Mandatory = $true)] [ValidateScript({ if( $_ -notmatch "^\d+$" ) { throw "Non-numeric Id" } return $true })] [string] $NoteId, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string] $Note ) process { [hashtable]$Params = @{ URISuffix = $URISuffix Method = 'PUT' Body = ConvertTo-Json @{ $NoteId = $Note } -Compress } if($VSAConnection) {$Params.Add('VSAConnection', $VSAConnection)} # No collection-wide existence pre-check (F-38): a nonexistent NoteId now surfaces as the # API's own 4xx error (via the transport's improved error handling) instead of a second, # wasteful GET-the-whole-collection call before every update. return Invoke-VSARestMethod @Params } } Export-ModuleMember -Function Update-VSAAgentNote |