Get-RASAutoUpgradeMessage

NAME

Get-RASAutoUpgradeMessage

SYNOPSIS

Retrieves schedule message information from Auto-upgrade settings.

SYNTAX

Get-RASAutoUpgradeMessage -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings} [-MessageId (uint)] [-SiteId (uint)] [(CommonParameters)] **

Get-RASAutoUpgradeMessage [Id] (uint) -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [MessageId (uint)] [(CommonParameters)] **

Get-RASAutoUpgradeMessage [Name] (string) [[-SiteId] (uint)] -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [MessageId (uint)] [(CommonParameters)] **

DESCRIPTION

Retrieves schedule message information from Auto-upgrade settings.

PARAMETERS

MessageId (uint)

Auto-upgrade job message ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

The name or server for which to retrieve the Auto-upgrade settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve the Auto-upgrade settings.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of a server for which to retrieve the Auto-upgrade settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType (HostPoolObjType)

The Object Type for which to retrieve the Auto-upgrade settings.

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

DefObjType (ServerDefObjType)

The Default Object Type for which to retrieve the Auto-upgrade settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

ScheduleMessage

---------- EXAMPLE 1 ----------

Get-RASAutoUpgradeMessage -DefObjType RDSDef

Retrieves the list of Messages from the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Get-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool

Retrieves the list of Messages from the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------

Get-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool

Retrieves the list of Messages from the Auto-upgrade settings of the specified AVDHostPool by Id.

RELATED LINKS

• Get-RASAutoUpgrade

• Add-RASAutoUpgradeMessage

• Set-RASAutoUpgradeMessage

• Remove-RASAutoUpgradeMessage