exports/Set-SysManMessage.ps1
|
<# .Synopsis Updates a message .Description Updates a message .Link https://docs.microsoft.com/en-us/powershell/module/sysman.webapi/set-sysmanmessage #> function Set-SysManMessage { [OutputType('SysMan.Powershell.Models.IMessage', 'SysMan.Powershell.Models.IApiErrorMessage')] [CmdletBinding(DefaultParameterSetName='Put', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] [SysMan.Powershell.Description('Updates a message')] param( [Parameter(Mandatory, HelpMessage='The id of the message')] [SysMan.Powershell.Category('Path')] [System.Int64] ${Id}, [Parameter(ParameterSetName='Put', ValueFromPipeline, HelpMessage='The Message class')] [SysMan.Powershell.Category('Body')] [SysMan.Powershell.Models.IMessage] ${Entry}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='Only applicable for alarm types. If true, the user is allowed to manually close the alarm. If false, the user cannot close the alarm until it has finished.')] [SysMan.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] ${AllowClose}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The background color in hex format #xxxxxx')] [SysMan.Powershell.Category('Body')] [System.String] ${BackgroundColor}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The text that should be displayed in the banner section of driftinformation. If empty, default behaviour is used.')] [SysMan.Powershell.Category('Body')] [System.String] ${BannerLinkText}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The url that should be displayed in the banner section of driftinformation.')] [SysMan.Powershell.Category('Body')] [System.String] ${BannerLinkUrl}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='CreatedBy')] [SysMan.Powershell.Category('Body')] [System.String] ${CreatedBy}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='Created Date')] [SysMan.Powershell.Category('Body')] [System.DateTime] ${CreatedDate}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='ExpireDate')] [SysMan.Powershell.Category('Body')] [System.DateTime] ${ExpireDate}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The font color hex format #xxxxxx')] [SysMan.Powershell.Category('Body')] [System.String] ${FontColor}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='If the message should be hidden or not for the user')] [SysMan.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] ${HideMessage}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='ID')] [SysMan.Powershell.Category('Body')] [System.Int64] ${Id1}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='Serverity')] [SysMan.Powershell.Category('Body')] [System.String] ${Severity}, [Parameter(ParameterSetName='PutExpanded', Mandatory, HelpMessage='Text of the message')] [SysMan.Powershell.Category('Body')] [System.String] ${Text}, [Parameter(ParameterSetName='PutExpanded', Mandatory, HelpMessage='Title of the message')] [SysMan.Powershell.Category('Body')] [System.String] ${Title}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The Message type')] [SysMan.Powershell.Category('Body')] [System.String] ${Type}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='If the messege shuld show up with gradiant')] [SysMan.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] ${UseGradient}, [Parameter(DontShow, HelpMessage='Wait for .NET debugger to attach')] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow, HelpMessage='SendAsync Pipeline Steps to be appended to the front of the pipeline')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [SysMan.Powershell.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow, HelpMessage='SendAsync Pipeline Steps to be prepended to the front of the pipeline')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [SysMan.Powershell.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow, HelpMessage='The URI for the proxy server to use')] [SysMan.Powershell.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow, HelpMessage='Credentials for a proxy server to use for the remote call')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow, HelpMessage='Use the default credentials for the proxy')] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PsCmdlet.ParameterSetName $mapping = @{ Put = 'SysMan.WebApi.private\Set-SysManMessage_Put'; PutExpanded = 'SysMan.WebApi.private\Set-SysManMessage_PutExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($myInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |