| external help file | Module Name | online version | schema |
|---|---|---|---|
SPClientCore.dll-Help.xml |
SPClientCore |
2.0.0 |
Creates a new alert.
New-KshAlert [-AlertFrequency <AlertFrequency>] [-AlertTemplateName <String>] [-AlertTime <DateTime>]
[-AlertType <AlertType>] [-AlwaysNotify <Boolean>] [-DeliveryChannels <AlertDeliveryChannel>]
[-EventType <AlertEventType>] [-EventTypeBitmask <Int32>] [-Filter <String>] -List <List>
[-ListItem <ListItem>]
[-Properties <System.Collections.Generic.IReadOnlyDictionary`2[System.String,System.String]>]
[-Status <AlertStatus>] [-Title <String>] -User <User> [<CommonParameters>]
The New-KshAlert cmdlet adds a new alert to the current site.
PS C:\> The New-KshAlert -AlertFrequency 'Immediate' -AlertType 'List' -List (Get-KshList -ListUrl '/sites/japan/hr/Announcements') -User (Get-KshUser -UserName 'admin@example.onmicrosoft.com')Creates a new 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 template name.
Type: String
Parameter Sets: (All)
Aliases:
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 the alert type.
Type: AlertType
Parameter Sets: (All)
Aliases:
Accepted values: List, ListItem, Custom
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 event type as bitmask.
Type: Int32
Parameter Sets: (All)
Aliases:
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 list.
Type: List
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the list item.
Type: ListItem
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the custom properties.
Type: System.Collections.Generic.IReadOnlyDictionary`2[System.String,System.String]
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: FalseSpecifies the user.
Type: User
Parameter Sets: (All)
Aliases:
Required: True
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.