| external help file | Module Name | online version | schema |
|---|---|---|---|
SPClientCore.dll-Help.xml |
SPClientCore |
2.0.0 |
Updates an alert.
Set-KshAlert [-Identity] <Alert> [-AlertFrequency <AlertFrequency>] [-AlertTime <DateTime>]
[-AlwaysNotify <Boolean>] [-DeliveryChannels <AlertDeliveryChannel>] [-EventType <AlertEventType>]
[-Filter <String>] [-Status <AlertStatus>] [-Title <String>] [-PassThru] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
The Set-KshAlert cmdlet updates properties of the alert.
PS C:\> Set-KshAlert -Identity (Get-KshAlert -AlertId '8e22b48d-680a-493a-b3d1-b4607108a94a') -Status 'Off'Updates property values of the alert.
Specifies the alert frequency.
Type: AlertFrequency
Parameter Sets: (All)
Aliases:
Accepted values: Immediate, Daily, Weekly
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the alert time.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to notify always.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the delivery channels.
Type: AlertDeliveryChannel
Parameter Sets: (All)
Aliases:
Accepted values: Email, Sms
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the event type.
Type: AlertEventType
Parameter Sets: (All)
Aliases:
Accepted values: AddObject, ModifyObject, DeleteObject, Discussion, All
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the filter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the alert.
Type: Alert
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIf specified, returns the updated object.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the status.
Type: AlertStatus
Parameter Sets: (All)
Aliases:
Accepted values: On, Off, Error
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the title.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDetermines how PowerShell responds to progress updates generated by a script, cmdlet, or provider.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.