Skip to content

Commit f55e7c7

Browse files
authored
Merge branch 'master' into patch-2
2 parents 5651413 + 3219ae4 commit f55e7c7

File tree

580 files changed

+28406
-22821
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

580 files changed

+28406
-22821
lines changed

sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md

Lines changed: 21 additions & 696 deletions
Large diffs are not rendered by default.
Lines changed: 53 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,46 @@
11
---
2-
external help file:
3-
online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpalert
4-
applicable: SharePoint Online, SharePoint 2019
2+
Module Name: PnP.PowerShell
53
schema: 2.0.0
4+
applicable: SharePoint Online
5+
online version: https://pnp.github.io/powershell/cmdlets/Add-PnPAlert.html
6+
external help file: PnP.PowerShell.dll-Help.xml
67
title: Add-PnPAlert
78
---
8-
9+
910
# Add-PnPAlert
1011

1112
## SYNOPSIS
1213
Adds an alert for a user to a list
1314

14-
## SYNTAX
15+
## SYNTAX
1516

1617
```powershell
17-
Add-PnPAlert -List <ListPipeBind>
18-
[-Title <String>]
19-
[-User <UserPipeBind>]
20-
[-DeliveryMethod <AlertDeliveryChannel>]
21-
[-ChangeType <AlertEventType>]
22-
[-Frequency <AlertFrequency>]
23-
[-Filter <AlertFilter>]
24-
[-Time <DateTime>]
25-
[-Web <WebPipeBind>]
26-
[-Connection <PnPConnection>]
18+
Add-PnPAlert [-List] <ListPipeBind> [-Title <String>] [-User <UserPipeBind>]
19+
[-DeliveryMethod <AlertDeliveryChannel>] [-ChangeType <AlertEventType>] [-Frequency <AlertFrequency>]
20+
[-Filter <AlertFilter>] [-Time <DateTime>] [-Connection <PnPConnection>]
21+
[<CommonParameters>]
2722
```
2823

24+
## DESCRIPTION
25+
This cmdlets allows to add an alert for a user to a list.
26+
2927
## EXAMPLES
3028

31-
### ------------------EXAMPLE 1------------------
29+
### EXAMPLE 1
3230
```powershell
3331
Add-PnPAlert -List "Demo List"
3432
```
3533

3634
Adds a new alert to the "Demo List" for the current user.
3735

38-
### ------------------EXAMPLE 2------------------
36+
### EXAMPLE 2
3937
```powershell
4038
Add-PnPAlert -Title "Daily summary" -List "Demo List" -Frequency Daily -ChangeType All -Time (Get-Date -Hour 11 -Minute 00 -Second 00)
4139
```
4240

4341
Adds a daily alert for the current user at the given time to the "Demo List". Note: a timezone offset might be applied so please verify on your tenant that the alert indeed got the right time.
4442

45-
### ------------------EXAMPLE 3------------------
43+
### EXAMPLE 3
4644
```powershell
4745
Add-PnPAlert -Title "Alert for user" -List "Demo List" -User "i:0#.f|membership|[email protected]"
4846
```
@@ -54,147 +52,137 @@ Adds a new alert for user "Alice" to the "Demo List". Note: Only site owners and
5452
### -ChangeType
5553
Alert change type
5654

57-
Only applicable to: SharePoint Online, SharePoint Server 2019
58-
5955
```yaml
6056
Type: AlertEventType
6157
Parameter Sets: (All)
58+
Accepted values: AddObject, ModifyObject, DeleteObject, Discussion, All
6259

6360
Required: False
6461
Position: Named
62+
Default value: None
6563
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -Connection
68+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
69+
70+
```yaml
71+
Type: PnPConnection
72+
Parameter Sets: (All)
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
6679
```
6780
6881
### -DeliveryMethod
6982
Alert delivery method
7083
71-
Only applicable to: SharePoint Online, SharePoint Server 2019
72-
7384
```yaml
7485
Type: AlertDeliveryChannel
7586
Parameter Sets: (All)
87+
Accepted values: Email, Sms
7688

7789
Required: False
7890
Position: Named
91+
Default value: None
7992
Accept pipeline input: False
93+
Accept wildcard characters: False
8094
```
8195
8296
### -Filter
8397
Alert filter
8498
85-
Only applicable to: SharePoint Online, SharePoint Server 2019
86-
8799
```yaml
88100
Type: AlertFilter
89101
Parameter Sets: (All)
102+
Accepted values: AnythingChanges, SomeoneElseChangesAnItem, SomeoneElseChangesItemCreatedByMe, SomeoneElseChangesItemLastModifiedByMe
90103

91104
Required: False
92105
Position: Named
106+
Default value: None
93107
Accept pipeline input: False
108+
Accept wildcard characters: False
94109
```
95110
96111
### -Frequency
97112
Alert frequency
98113
99-
Only applicable to: SharePoint Online, SharePoint Server 2019
100-
101114
```yaml
102115
Type: AlertFrequency
103116
Parameter Sets: (All)
117+
Accepted values: Immediate, Daily, Weekly
104118

105119
Required: False
106120
Position: Named
121+
Default value: None
107122
Accept pipeline input: False
123+
Accept wildcard characters: False
108124
```
109125
110126
### -List
111127
The ID, Title or Url of the list.
112128
113-
Only applicable to: SharePoint Online, SharePoint Server 2019
114-
115129
```yaml
116130
Type: ListPipeBind
117131
Parameter Sets: (All)
118132

119133
Required: True
120134
Position: 0
121-
Accept pipeline input: True
135+
Default value: None
136+
Accept pipeline input: True (ByValue)
137+
Accept wildcard characters: False
122138
```
123139
124140
### -Time
125141
Alert time (if frequency is not immediate)
126142
127-
Only applicable to: SharePoint Online, SharePoint Server 2019
128-
129143
```yaml
130144
Type: DateTime
131145
Parameter Sets: (All)
132146

133147
Required: False
134148
Position: Named
149+
Default value: None
135150
Accept pipeline input: False
151+
Accept wildcard characters: False
136152
```
137153
138154
### -Title
139155
Alert title
140156
141-
Only applicable to: SharePoint Online, SharePoint Server 2019
142-
143157
```yaml
144158
Type: String
145159
Parameter Sets: (All)
146160

147161
Required: False
148162
Position: Named
163+
Default value: None
149164
Accept pipeline input: False
165+
Accept wildcard characters: False
150166
```
151167
152168
### -User
153169
User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users.
154170
155-
Only applicable to: SharePoint Online, SharePoint Server 2019
156-
157171
```yaml
158172
Type: UserPipeBind
159173
Parameter Sets: (All)
160174

161175
Required: False
162176
Position: Named
177+
Default value: None
163178
Accept pipeline input: False
179+
Accept wildcard characters: False
164180
```
165181
166-
### -Connection
167-
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
168-
169-
Only applicable to: SharePoint Online, SharePoint Server 2019
170-
171-
```yaml
172-
Type: PnPConnection
173-
Parameter Sets: (All)
174-
175-
Required: False
176-
Position: Named
177-
Accept pipeline input: False
178-
```
179182
180-
### -Web
181-
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
182183
183-
Only applicable to: SharePoint Online, SharePoint Server 2019
184-
185-
```yaml
186-
Type: WebPipeBind
187-
Parameter Sets: (All)
188-
189-
Required: False
190-
Position: Named
191-
Accept pipeline input: False
192-
```
193-
194-
## OUTPUTS
184+
## RELATED LINKS
195185
196-
### Microsoft.SharePoint.Client.AlertCreationInformation
186+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
197187
198-
## RELATED LINKS
199188
200-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

0 commit comments

Comments
 (0)