Remove-RDSScheduleMessage

NAME

Remove-RDSScheduleMessage

SYNOPSIS

Removes an RDS Schedule Message from a RDS Schedule Item.

SYNTAX

Remove-RDSScheduleMessage [-RDSSchedObject] <RDSSchedItem> -Id <uint> [<CommonParameters>]

Remove-RDSScheduleMessage [-RDSSchedName] <string> [[-SiteId] <uint>] -Id <uint> [<CommonParameters>]

Remove-RDSScheduleMessage [-RDSSchedId] <uint> -Id <uint> [<CommonParameters>]

DESCRIPTION

Removes an RDS Schedule Message from a RDS Schedule Item.

PARAMETERS


-Id <uint>
Scheduler job message ID.

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RDSSchedObject <RDSSchedItem>
An object of type RDSSchedItem representing the target scheduler job.

To obtain the object, use the Get-RDSSchedule cmdlet.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-RDSSchedName <string>
Scheduler job name.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the schedule job.

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RDSSchedId <uint>
Scheduler job ID.

        Required?                    true
        Position?                    0
        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

RDSSchedItem

OUTPUTS

-none-

EXAMPLES


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

Remove-RDSScheduleMessage -RDSSchedName "RDSSchedItem" -Id 1

Removes the specified message by id within the specified RDS schedule item by name.

---------- EXAMPLE 2 ----------

Remove-RDSScheduleMessage -RDSSchedId 1 -Id 1

Removes the specified message by id within the specified RDS schedule item by id.

RELATED LINKS