Set-RASAutoUpgradeMessage
Last updated
Last updated
Set-RASAutoUpgradeMessage
Modifies an Auto-upgrade Message within Auto-upgrade settings.
Set-RASAutoUpgradeMessage - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - (uint) [ (bool)] [ (string)] [ (string)] [ (uint)] [- {Before | After}] [ (uint)] [()]
Set-RASAutoUpgradeMessage [] (uint) - (uint) - {RDSHostPool | VDIHostPool | AVDHostPool} [ (bool)] [ (string)] [ (string)] [ (uint)] [- {Before | After}] [()]
Set-RASAutoUpgradeMessage [-] () - (uint) [ (bool)] [ (string)] [ (string)] [ (uint)] [- {Before | After}] [()]
Set-RASAutoUpgradeMessage [] (string) [[-] (uint)] - (uint) - {RDSHostPool | VDIHostPool | AVDHostPool} [ (bool)] [ (string)] [ (string)] [ (uint)] [- {Before | After}] [()]
Modifies an Auto-upgrade Message within Auto-upgrade settings.
Auto-upgrade job message ID.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the AutoUpgrade is triggered.
SendMsgWhen can only be set to After in the case of Reboot.
Possible values: Before, After
The name or server for which to modify the Auto-upgrade settings.
Site ID from which to modify the Auto-upgrade settings.
If the parameter is omitted, the Licensing Server site ID will be used.
The ID of a server for which to modify the Auto-upgrade settings.
The Object Type for which to modify the Auto-upgrade settings.
Possible values: RDSHostPool, VDIHostPool, AVDHostPool
The Default Object Type for which to modify the Auto-upgrade settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
(CommonParameters)
-none-
-none-
**---------- EXAMPLE 1 ----------
Set-RASAutoUpgradeMessage -DefObjType RDSDef -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the RDS Default Settings. **---------- EXAMPLE 2 ----------
Set-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the specified VDIHostPool by Name. **---------- EXAMPLE 3 ----------
Set-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the specified AVDHostPool by Id.
() An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the Auto-upgrade settings.