@pnp/cli-microsoft365 11.7.0-beta.537911c → 11.7.0-beta.71e4ac5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/config.js +1 -0
  4. package/dist/m365/outlook/commands/calendar/calendar-add.js +85 -0
  5. package/dist/m365/outlook/commands/calendar/calendar-get.js +71 -0
  6. package/dist/m365/outlook/commands/calendar/calendar-remove.js +100 -0
  7. package/dist/m365/outlook/commands/event/event-list.js +115 -0
  8. package/dist/m365/outlook/commands.js +4 -0
  9. package/dist/utils/calendar.js +37 -0
  10. package/dist/utils/calendarGroup.js +22 -0
  11. package/docs/docs/cmd/outlook/calendar/calendar-add.mdx +165 -0
  12. package/docs/docs/cmd/outlook/calendar/calendar-get.mdx +165 -0
  13. package/docs/docs/cmd/outlook/calendar/calendar-remove.mdx +86 -0
  14. package/docs/docs/cmd/outlook/event/event-list.mdx +245 -0
  15. package/npm-shrinkwrap.json +320 -304
  16. package/package.json +32 -20
package/docs/docs/cmd/outlook/calendar/calendar-get.mdx ADDED
@@ -0,0 +1,165 @@
1
+ import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # outlook calendar get
6
+
7
+ Retrieves the calendar of a user or a group.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 outlook calendar get [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-i, --id [id]`
19
+ : ID of the calendar. Specify either `id` or `name`, but not both.
20
+
21
+ `-n, --name [name]`
22
+ : Name of the calendar. Specify either `id` or `name`, but not both.
23
+
24
+ `--userId [userId]`
25
+ : ID of the user. Specify either `userId` or `userName`, but not both.
26
+
27
+ `--userName [userName]`
28
+ : UPN of the user. Specify either `userId` or `userName`, but not both.
29
+
30
+ `--calendarGroupId [calendarGroupId]`
31
+ : ID of the calendar group. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
32
+
33
+ `--calendarGroupName [calendarGroupName]`
34
+ : Name of the calendar group. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
35
+ ```
36
+
37
+ <Global />
38
+
39
+ ## Permissions
40
+
41
+ <Tabs>
42
+ <TabItem value="Delegated">
43
+
44
+ | Resource | Permissions |
45
+ |-----------------|--------------------|
46
+ | Microsoft Graph | Calendar.ReadBasic |
47
+
48
+ </TabItem>
49
+ <TabItem value="Application">
50
+
51
+ | Resource | Permissions |
52
+ |-----------------|--------------------|
53
+ | Microsoft Graph | Calendar.ReadBasic |
54
+
55
+ </TabItem>
56
+ </Tabs>
57
+
58
+ ## Examples
59
+
60
+ Get the calendar for the current signed-in user by id.
61
+
62
+ ```sh
63
+ m365 outlook calendar get --userId "@meId" --id "AAMkAGI2TGuLAAA="
64
+ ```
65
+
66
+ Get the calendar from a specific calendar group for the current signed-in user by name.
67
+
68
+ ```sh
69
+ m365 outlook calendar get --userId "@meId" --calendarGroupName "Colleague calendars" --name "Calendar"
70
+ ```
71
+
72
+ Get the calendar from a specific calendar group for a specific user by name.
73
+
74
+ ```sh
75
+ m365 outlook calendar get --userId b743445a-112c-4fda-9afd-05943f9c7b36 --calendarGroupId "AAMkADIxYjJiYmIzLTFmNjYtNGNhMy0YOkcEEh3vhfAAAGgdFjAAA=" --name "Calendar"
76
+ ```
77
+
78
+ ## Response
79
+
80
+ <Tabs>
81
+ <TabItem value="JSON">
82
+
83
+ ```json
84
+ {
85
+ "id": "AQMkAGRAAAA==",
86
+ "name": "Calendar",
87
+ "color": "lightOrange",
88
+ "hexColor": "#f7630c",
89
+ "groupClassId": "0006f0b7-0000-0000-c000-000000000046",
90
+ "isDefaultCalendar": true,
91
+ "changeKey": "fJKVL07sbkmIfHqjbDnRgQAACWzbtQ==",
92
+ "canShare": true,
93
+ "canViewPrivateItems": true,
94
+ "canEdit": true,
95
+ "allowedOnlineMeetingProviders": [
96
+ "teamsForBusiness"
97
+ ],
98
+ "defaultOnlineMeetingProvider": "teamsForBusiness",
99
+ "isTallyingResponses": true,
100
+ "isRemovable": false,
101
+ "owner": {
102
+ "name": "John Doe",
103
+ "address": "john.doe@contoso.com"
104
+ }
105
+ }
106
+ ```
107
+
108
+ </TabItem>
109
+ <TabItem value="Text">
110
+
111
+ ```text
112
+ allowedOnlineMeetingProviders: ["teamsForBusiness"]
113
+ canEdit : true
114
+ canShare : true
115
+ canViewPrivateItems : true
116
+ changeKey : fJKVL07sbkmIfHqjbDnRgQAACWzbtQ==
117
+ color : lightOrange
118
+ defaultOnlineMeetingProvider : teamsForBusiness
119
+ groupClassId : 0006f0b7-0000-0000-c000-000000000046
120
+ hexColor : #f7630c
121
+ id : AQMkAGRAAAA==
122
+ isDefaultCalendar : true
123
+ isRemovable : false
124
+ isTallyingResponses : true
125
+ name : Calendar
126
+ owner : {"name":"John Doe","address":"john.doe@contoso.com"}
127
+ ```
128
+
129
+ </TabItem>
130
+ <TabItem value="CSV">
131
+
132
+ ```csv
133
+ id,name,color,hexColor,groupClassId,isDefaultCalendar,changeKey,canShare,canViewPrivateItems,canEdit,defaultOnlineMeetingProvider,isTallyingResponses,isRemovable
134
+ AQMkAGRAAAA==,Calendar,lightOrange,#f7630c,0006f0b7-0000-0000-c000-000000000046,1,fJKVL07sbkmIfHqjbDnRgQAACWzbtQ==,1,1,1,teamsForBusiness,1,0
135
+ ```
136
+
137
+ </TabItem>
138
+ <TabItem value="Markdown">
139
+
140
+ ```md
141
+ # outlook calendar get --name "Calendar" --userName "john.doe@contoso.com"
142
+
143
+ Date: 2/9/2026
144
+
145
+ ## Calendar (AQMkAGRAAAA==)
146
+
147
+ Property | Value
148
+ ---------|-------
149
+ id | AQMkAGRAAAA==
150
+ name | Calendar
151
+ color | lightOrange
152
+ hexColor | #f7630c
153
+ groupClassId | 0006f0b7-0000-0000-c000-000000000046
154
+ isDefaultCalendar | true
155
+ changeKey | fJKVL07sbkmIfHqjbDnRgQAACWzbtQ==
156
+ canShare | true
157
+ canViewPrivateItems | true
158
+ canEdit | true
159
+ defaultOnlineMeetingProvider | teamsForBusiness
160
+ isTallyingResponses | true
161
+ isRemovable | false
162
+ ```
163
+
164
+ </TabItem>
165
+ </Tabs>
package/docs/docs/cmd/outlook/calendar/calendar-remove.mdx ADDED
@@ -0,0 +1,86 @@
1
+ import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # outlook calendar remove
6
+
7
+ Removes the calendar of a user.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 outlook calendar remove [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-i, --id [id]`
19
+ : ID of the calendar. Specify either `id` or `name`, but not both.
20
+
21
+ `-n, --name [name]`
22
+ : Name of the calendar. Specify either `id` or `name`, but not both.
23
+
24
+ `--userId [userId]`
25
+ : ID of the user. Specify either `userId` or `userName`, but not both.
26
+
27
+ `--userName [userName]`
28
+ : UPN of the user. Specify either `userId` or `userName`, but not both.
29
+
30
+ `--calendarGroupId [calendarGroupId]`
31
+ : ID of the calendar group. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
32
+
33
+ `--calendarGroupName [calendarGroupName]`
34
+ : Name of the calendar group. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
35
+
36
+ `--permanent`
37
+ : Permanently remove the calendar, don't send it to the recycle bin.
38
+
39
+ `-f, --force`
40
+ : Don't prompt for confirmation.
41
+ ```
42
+
43
+ <Global />
44
+
45
+ ## Permissions
46
+
47
+ <Tabs>
48
+ <TabItem value="Delegated">
49
+
50
+ | Resource | Permissions |
51
+ |-----------------|---------------------|
52
+ | Microsoft Graph | Calendars.ReadWrite |
53
+
54
+ </TabItem>
55
+ <TabItem value="Application">
56
+
57
+ | Resource | Permissions |
58
+ |-----------------|---------------------|
59
+ | Microsoft Graph | Calendars.ReadWrite |
60
+
61
+ </TabItem>
62
+ </Tabs>
63
+
64
+ ## Examples
65
+
66
+ Remove the calendar for the current signed-in user by id.
67
+
68
+ ```sh
69
+ m365 outlook calendar remove --userId "@meId" --id "AAMkAGI2TGuLAAA="
70
+ ```
71
+
72
+ Permanently remove the calendar from a specific calendar group for the current signed-in user by name.
73
+
74
+ ```sh
75
+ m365 outlook calendar remove --userId "@meId" --calendarGroupName "Colleague calendars" --name "Calendar" --permanent
76
+ ```
77
+
78
+ Remove the calendar from a specific calendar group for a specific user by name.
79
+
80
+ ```sh
81
+ m365 outlook calendar remove --userId b743445a-112c-4fda-9afd-05943f9c7b36 --calendarGroupId "AAMkADIxYjJiYmIzLTFmNjYtNGNhMy0YOkcEEh3vhfAAAGgdFjAAA=" --name "Calendar"
82
+ ```
83
+
84
+ ## Response
85
+
86
+ The command won't return a response on success.
package/docs/docs/cmd/outlook/event/event-list.mdx ADDED
@@ -0,0 +1,245 @@
1
+ import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # event list
6
+
7
+ Retrieves a list of events from a specific calendar of a user.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 outlook event list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `--userId [userId]`
19
+ : ID of the user. Specify either `userId` or `userName`, but not both.
20
+
21
+ `--userName [userName]`
22
+ : UPN of the user. Specify either `userId` or `userName`, but not both.
23
+
24
+ `--calendarId [calendarId]`
25
+ : ID of the calendar. Specify either `calendarId` or `calendarName`, but not both.
26
+
27
+ `--calendarName [calendarName]`
28
+ : Name of the calendar. Specify either `calendarId` or `calendarName`, but not both.
29
+
30
+ `--startDateTime [startDateTime]`
31
+ : Time indicating the inclusive start of a time range when the event starts.
32
+
33
+ `--endDateTime [endDateTime]`
34
+ : Time indicating the exclusive end of a time range when the event starts.
35
+
36
+ `--timeZone [timeZone]`
37
+ : The time zone for the event start and end times.
38
+
39
+ `--properties [properties]`
40
+ : Comma-separated list of properties to retrieve.
41
+
42
+ `--filter [filter]`
43
+ : OData filter to apply when retrieving the events.
44
+ ```
45
+
46
+ <Global />
47
+
48
+ ## Remarks
49
+
50
+ :::info
51
+
52
+ When you specify a value for `timeZone`, consider the options of the [time zone list](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones), or [additional time zone list](https://learn.microsoft.com/en-us/graph/api/resources/datetimetimezone?view=graph-rest-1.0#additional-time-zones)
53
+
54
+ :::
55
+
56
+ ## Permissions
57
+
58
+ <Tabs>
59
+ <TabItem value="Delegated">
60
+
61
+ | Resource | Permissions |
62
+ |-----------------|-------------------------------------|
63
+ | Microsoft Graph | Calendars.ReadBasic, Calendars.Read |
64
+
65
+ </TabItem>
66
+ <TabItem value="Application">
67
+
68
+ | Resource | Permissions |
69
+ |-----------------|-------------------------------------|
70
+ | Microsoft Graph | Calendars.ReadBasic, Calendars.Read |
71
+
72
+ </TabItem>
73
+ </Tabs>
74
+
75
+
76
+ ## Examples
77
+
78
+ List all events for the current signed-in user from a calendar specified by id.
79
+
80
+ ```sh
81
+ m365 outlook event list --userId "@meId" --calendarId "AAMkAGRkZ"
82
+ ```
83
+
84
+ List all events for the current signed-in user from a calendar specified by id and return event times in Pacific Standard Time time zone.
85
+
86
+ ```sh
87
+ m365 outlook event list --userId "@meId" --calendarId "AAMkAGRkZ" --timeZone 'Pacific Standard Time'
88
+ ```
89
+
90
+ List only id, subject, start time and end time of all events for a specific user and specific calendar
91
+
92
+ ```sh
93
+ m365 outlook event list --userName "john.doe@contoso.com" --calendarName "Calendar" --properties "id,subject,start,end"
94
+ ```
95
+
96
+ Filter events for the current signed-in user
97
+
98
+ ```sh
99
+ m365 outlook event list --userId "@meId" --calendarId "AAMkAGRkZ" --filter "contains(subject, 'contoso')"
100
+ ```
101
+
102
+ List all events from specific date range
103
+
104
+ ```sh
105
+ m365 outlook event list --userId "@meId" --calendarId "AAMkAGRkZ" --startDateTime '2026-01-01' --endDateTime '2026-01-31'
106
+ ```
107
+
108
+ ## Response
109
+
110
+ <Tabs>
111
+ <TabItem value="JSON">
112
+
113
+ ```json
114
+ [
115
+ {
116
+ "id": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07AC6GQ5pgAAAA==",
117
+ "createdDateTime": "2026-03-29T13:57:47.9194633Z",
118
+ "lastModifiedDateTime": "2026-03-29T13:59:48.6329479Z",
119
+ "changeKey": "fJKVL07sbkmIfHqjbDnRgQAC54IeWA==",
120
+ "categories": [],
121
+ "transactionId": "localevent:c95ac848-7295-ad3e-ee1e-f3832b10bf3e",
122
+ "originalStartTimeZone": "Greenwich Standard Time",
123
+ "originalEndTimeZone": "Greenwich Standard Time",
124
+ "iCalUId": "040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9",
125
+ "uid": "040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9",
126
+ "reminderMinutesBeforeStart": 15,
127
+ "isReminderOn": true,
128
+ "hasAttachments": false,
129
+ "subject": "Retro",
130
+ "bodyPreview": "Retrospective",
131
+ "importance": "normal",
132
+ "sensitivity": "normal",
133
+ "isAllDay": false,
134
+ "isCancelled": false,
135
+ "isOrganizer": true,
136
+ "responseRequested": true,
137
+ "seriesMasterId": null,
138
+ "showAs": "busy",
139
+ "type": "singleInstance",
140
+ "webLink": "https://outlook.office365.com/owa/?itemid=AQMkAGRlM2Y%3D%3D&exvsurl=1&path=/calendar/item",
141
+ "onlineMeetingUrl": null,
142
+ "isOnlineMeeting": false,
143
+ "onlineMeetingProvider": "unknown",
144
+ "allowNewTimeProposals": true,
145
+ "occurrenceId": null,
146
+ "isDraft": false,
147
+ "hideAttendees": false,
148
+ "responseStatus": {
149
+ "response": "organizer",
150
+ "time": "0001-01-01T00:00:00Z"
151
+ },
152
+ "body": {
153
+ "contentType": "html",
154
+ "content": "<html>\r\\\n<head>\r\\\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\\\n</head>\r\\\n<body>\r\\\n<div class=\"elementToProof\" style=\"font-family:Aptos,Aptos_EmbeddedFont,Aptos_MSFontService,Calibri,Helvetica,sans-serif; font-size:12pt; color:rgb(0,0,0)\">\r\\\nRetrospective</div>\r\\\n</body>\r\\\n</html>\r\\\n"
155
+ },
156
+ "start": {
157
+ "dateTime": "2026-03-29T16:00:00.0000000",
158
+ "timeZone": "UTC"
159
+ },
160
+ "end": {
161
+ "dateTime": "2026-03-29T18:00:00.0000000",
162
+ "timeZone": "UTC"
163
+ },
164
+ "location": {
165
+ "displayName": "",
166
+ "locationType": "default",
167
+ "uniqueIdType": "unknown",
168
+ "address": {},
169
+ "coordinates": {}
170
+ },
171
+ "locations": [],
172
+ "recurrence": null,
173
+ "attendees": [],
174
+ "organizer": {
175
+ "emailAddress": {
176
+ "name": "John Doe",
177
+ "address": "john.doe@contoso.com"
178
+ }
179
+ },
180
+ "onlineMeeting": null
181
+ }
182
+ ]
183
+ ```
184
+
185
+ </TabItem>
186
+ <TabItem value="Text">
187
+
188
+ ```text
189
+ id subject
190
+ -------------------------------------------------------------------------------------------------------------------------------------------------------- -------
191
+ AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07AC6GQ5pgAAAA== Retro
192
+ ```
193
+
194
+ </TabItem>
195
+ <TabItem value="CSV">
196
+
197
+ ```csv
198
+ id,createdDateTime,lastModifiedDateTime,changeKey,transactionId,originalStartTimeZone,originalEndTimeZone,iCalUId,uid,reminderMinutesBeforeStart,isReminderOn,hasAttachments,subject,bodyPreview,importance,sensitivity,isAllDay,isCancelled,isOrganizer,responseRequested,seriesMasterId,showAs,type,webLink,onlineMeetingUrl,isOnlineMeeting,onlineMeetingProvider,allowNewTimeProposals,occurrenceId,isDraft,hideAttendees,recurrence,onlineMeeting
199
+ AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07AC6GQ5pgAAAA==,2026-03-29T13:57:47.9194633Z,2026-03-29T13:59:48.6329479Z,fJKVL07sbkmIfHqjbDnRgQAC54IeWA==,localevent:c95ac848-7295-ad3e-ee1e-f3832b10bf3e,Greenwich Standard Time,Greenwich Standard Time,040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9,040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9,15,1,0,Retro,Retrospective,normal,normal,0,0,1,1,,busy,singleInstance,https://outlook.office365.com/owa/?itemid=AQMkAGRlM2Y=1&path=/calendar/item,,0,unknown,1,,0,0,,
200
+ ```
201
+
202
+ </TabItem>
203
+ <TabItem value="Markdown">
204
+
205
+ ```md
206
+ # outlook event list --debug "false" --verbose "false" --userId "893f9116-e024-4bc6-8e98-54c245129485" --startDateTime "2026-03-29" --endDateTime "2026-03-31"
207
+
208
+ Date: 3/29/2026
209
+
210
+ ## AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07AC6GQ5pgAAAA==
211
+
212
+ Property | Value
213
+ ---------|-------
214
+ id | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07AC6GQ5pgAAAA==
215
+ createdDateTime | 2026-03-29T13:57:47.9194633Z
216
+ lastModifiedDateTime | 2026-03-29T13:59:48.6329479Z
217
+ changeKey | fJKVL07sbkmIfHqjbDnRgQAC54IeWA==
218
+ transactionId | localevent:c95ac848-7295-ad3e-ee1e-f3832b10bf3e
219
+ originalStartTimeZone | Greenwich Standard Time
220
+ originalEndTimeZone | Greenwich Standard Time
221
+ iCalUId | 040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9
222
+ uid | 040000008200E00074C5B7101A82E008000000006B71750684BFDC01000000000000000010000000872F2916501A8442A7DB64D2E460E3D9
223
+ reminderMinutesBeforeStart | 15
224
+ isReminderOn | true
225
+ hasAttachments | false
226
+ subject | Retro
227
+ bodyPreview | Retrospective
228
+ importance | normal
229
+ sensitivity | normal
230
+ isAllDay | false
231
+ isCancelled | false
232
+ isOrganizer | true
233
+ responseRequested | true
234
+ showAs | busy
235
+ type | singleInstance
236
+ webLink | https://outlook.office365.com/owa/?itemid=AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgBGAAADSG3wPE27kUeySjmT5eRT8QcAfJKVL07sbkmIfHqjbDnRgQAAAgENAAAAfJKVL07sbkmIfHqjbDnRgQAC6GQ5pgAAAA%3D%3D&exvsurl=1&path=/calendar/item
237
+ isOnlineMeeting | false
238
+ onlineMeetingProvider | unknown
239
+ allowNewTimeProposals | true
240
+ isDraft | false
241
+ hideAttendees | false
242
+ ```
243
+
244
+ </TabItem>
245
+ </Tabs>