@pnp/cli-microsoft365 6.4.0 → 6.5.0-beta.699c15b

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 (48) hide show
  1. package/.eslintrc.js +2 -0
  2. package/README.md +3 -3
  3. package/dist/Command.js +17 -7
  4. package/dist/cli/Cli.js +15 -11
  5. package/dist/m365/cli/commands/config/config-set.js +1 -0
  6. package/dist/m365/commands/request.js +18 -1
  7. package/dist/m365/flow/commands/flow-export.js +6 -6
  8. package/dist/m365/pa/commands/app/app-export.js +197 -0
  9. package/dist/m365/pa/commands.js +1 -0
  10. package/dist/m365/purview/commands/threatassessment/threatassessment-get.js +79 -0
  11. package/dist/m365/purview/commands.js +2 -1
  12. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.17.0.js +23 -0
  13. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  14. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.17.0-beta.3.js → upgrade-1.17.0.js} +26 -26
  15. package/dist/m365/spfx/commands/project/project-upgrade.js +13 -15
  16. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  17. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +27 -13
  18. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-list.js +72 -0
  19. package/dist/m365/spo/commands/commandset/commandset-add.js +2 -1
  20. package/dist/m365/spo/commands/commandset/commandset-remove.js +12 -9
  21. package/dist/m365/spo/commands/commandset/commandset-set.js +12 -9
  22. package/dist/m365/spo/commands/file/file-move.js +1 -1
  23. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +22 -1
  24. package/dist/m365/spo/commands/listitem/listitem-get.js +21 -6
  25. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +35 -1
  26. package/dist/m365/spo/commands/web/web-set.js +33 -13
  27. package/dist/m365/spo/commands.js +1 -0
  28. package/dist/m365/teams/commands/team/team-list.js +4 -6
  29. package/dist/m365/todo/commands/task/task-set.js +25 -1
  30. package/dist/settingsNames.js +2 -1
  31. package/dist/utils/md.js +4 -3
  32. package/docs/docs/_clisettings.md +1 -0
  33. package/docs/docs/cmd/aad/o365group/o365group-add.md +3 -3
  34. package/docs/docs/cmd/pa/app/app-export.md +52 -0
  35. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.md +191 -0
  36. package/docs/docs/cmd/request.md +10 -4
  37. package/docs/docs/cmd/spfx/project/project-upgrade.md +2 -2
  38. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +4 -1
  39. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.md +109 -0
  40. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +12 -1
  41. package/docs/docs/cmd/spo/list/list-view-remove.md +1 -1
  42. package/docs/docs/cmd/spo/list/list-view-set.md +2 -2
  43. package/docs/docs/cmd/spo/listitem/listitem-get.md +14 -5
  44. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +15 -2
  45. package/docs/docs/cmd/teams/team/team-list.md +44 -4
  46. package/docs/docs/cmd/todo/task/task-set.md +50 -0
  47. package/npm-shrinkwrap.json +460 -273
  48. package/package.json +13 -12
@@ -22,12 +22,17 @@ m365 spo file retentionlabel ensure [options]
22
22
  `--name <name>`
23
23
  : Name of the retention label to apply to the file.
24
24
 
25
+ `-a, --assetId [assetId]`
26
+ : A Compliance Asset Id to set on the item when it's labeled. See below for more information.
27
+
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Remarks
28
31
 
29
32
  You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
30
33
 
34
+ The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
35
+
31
36
  ## Examples
32
37
 
33
38
  Applies a retention label to a file based on the label name and the fileUrl
@@ -39,7 +44,13 @@ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/site
39
44
  Applies a retention label to a file based on the label name and the fileId
40
45
 
41
46
  ```sh
42
- m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
47
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
48
+ ```
49
+
50
+ Applies a event-based retention label to a file and updates the Asset Id field
51
+
52
+ ```sh
53
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label' --assetId 'XYZ'
43
54
  ```
44
55
 
45
56
  ## Response
@@ -56,7 +56,7 @@ m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-
56
56
  Remove view with title _MyView_ from a list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
57
 
58
58
  ```sh
59
- m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle MyView
59
+ m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --title MyView
60
60
  ```
61
61
 
62
62
  Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_ without being asked for confirmation
@@ -58,13 +58,13 @@ Update view formatting of the specified list view
58
58
  === "PowerShell"
59
59
 
60
60
  ```sh
61
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter '{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, ''sp-field-severity--severeWarning'', '''')\"}'
61
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'All items' --CustomFormatter '{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, ''sp-field-severity--severeWarning'', '''')\"}'
62
62
  ```
63
63
 
64
64
  === "Bash"
65
65
 
66
66
  ```sh
67
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter "{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')\"}"
67
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'All items' --CustomFormatter "{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')\"}"
68
68
  ```
69
69
 
70
70
  ## Response
@@ -13,17 +13,20 @@ m365 spo listitem get [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the item is located.
15
15
 
16
- `-i, --id <id>`
17
- : ID of the item to retrieve.
16
+ `-i, --id [id]`
17
+ : ID of the item to retrieve. Specify either `id` or `uniqueId` but not both.
18
+
19
+ `--uniqueId [uniqueId]`
20
+ : The Unique ID (GUID) of the item to retrieve. Specify either `id` or `uniqueId` but not both.
18
21
 
19
22
  `-l, --listId [listId]`
20
- : ID of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
23
+ : ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
24
 
22
25
  `-t, --listTitle [listTitle]`
23
- : Title of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
26
+ : Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
24
27
 
25
28
  `--listUrl [listUrl]`
26
- : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
29
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
27
30
 
28
31
  `-p, --properties [properties]`
29
32
  : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.
@@ -45,6 +48,12 @@ Get an item with the ID parameter from a given list in a given site.
45
48
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
46
49
  ```
47
50
 
51
+ Get an item with the Unique ID parameter from a given list in a given site.
52
+
53
+ ```sh
54
+ m365 spo listitem get --listTitle "Demo List" --uniqueId "64dc28c4-3c43-45f6-ba66-307d9eb7e6aa" --webUrl https://contoso.sharepoint.com/sites/project-x
55
+ ```
56
+
48
57
  Get an item columns with the ID parameter from a given list in a given site.
49
58
 
50
59
  ```sh
@@ -31,11 +31,18 @@ m365 spo listitem retentionlabel ensure [options]
31
31
  `-i, --id [id]`
32
32
  : The id of the retention label. Specify either `name` or `id`.
33
33
 
34
+ `-a, --assetId [assetId]`
35
+ : A Compliance Asset Id to set on the item when it's labeled. See below for more information.
36
+
34
37
  --8<-- "docs/cmd/_global.md"
35
38
 
39
+ ## Remarks
40
+
41
+ The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
42
+
36
43
  ## Examples
37
44
 
38
- Applies the retention label _Some label_ to a list item in a given site based on the list id and label name
45
+ Applies a retention label to a list item in a given site based on the list id and label name
39
46
 
40
47
  ```sh
41
48
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1 --name 'Some label'
@@ -47,12 +54,18 @@ Applies a retention label to a list item in a given site based on the list title
47
54
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1 --id '7a621a91-063b-461b-aff6-d713d5fb23eb'
48
55
  ```
49
56
 
50
- Applies the retention label _Some label_ to a list item in a given site based on the server relative list url
57
+ Applies a retention label to a list item in a given site based on the server relative list url
51
58
 
52
59
  ```sh
53
60
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label'
54
61
  ```
55
62
 
63
+ Applies a retention label to a list item in a given site based on the server relative list url and updates the Asset Id field
64
+
65
+ ```sh
66
+ m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label' --assetId 'XYZ'
67
+ ```
68
+
56
69
  ## Response
57
70
 
58
71
  The command won't return a response on success.
@@ -37,20 +37,60 @@ m365 teams team list --joined
37
37
 
38
38
  === "JSON"
39
39
 
40
- ``` json
40
+ ```json
41
41
  [
42
42
  {
43
43
  "id": "5dc7ba76-b9aa-4fdd-9e91-9fe7d0e8dca3",
44
+ "createdDateTime": "2022-12-08T09:17:55.039Z",
44
45
  "displayName": "Architecture",
46
+ "description": "Architecture Discussion",
47
+ "internalId": "19:pLknmKPPkvgeaG0FtegLfjoDINeY3gvmitMkNG9H3X41@thread.tacv2",
48
+ "classification": null,
49
+ "specialization": "none",
50
+ "visibility": "public",
51
+ "webUrl": "https://teams.microsoft.com/l/team/19:a5c6eccad3fb401997756a1501d561aa%40thread.skype/conversations?groupId=8090c93e-ba7c-433e-9f39-08c7ba07c0b3&tenantId=dcd219dd-bc68-4b9b-bf0b-4a33a796be35",
45
52
  "isArchived": false,
46
- "description": "Architecture Discussion"
53
+ "isMembershipLimitedToOwners": false,
54
+ "discoverySettings": {
55
+ "showInTeamsSearchAndSuggestions": true
56
+ },
57
+ "memberSettings": {
58
+ "allowCreateUpdateChannels": true,
59
+ "allowCreatePrivateChannels": true,
60
+ "allowDeleteChannels": true,
61
+ "allowAddRemoveApps": true,
62
+ "allowCreateUpdateRemoveTabs": true,
63
+ "allowCreateUpdateRemoveConnectors": true
64
+ },
65
+ "guestSettings": {
66
+ "allowCreateUpdateChannels": false,
67
+ "allowDeleteChannels": false
68
+ },
69
+ "messagingSettings": {
70
+ "allowUserEditMessages": false,
71
+ "allowUserDeleteMessages": false,
72
+ "allowOwnerDeleteMessages": false,
73
+ "allowTeamMentions": true,
74
+ "allowChannelMentions": true
75
+ },
76
+ "funSettings": {
77
+ "allowGiphy": true,
78
+ "giphyContentRating": "moderate",
79
+ "allowStickersAndMemes": true,
80
+ "allowCustomMemes": false
81
+ },
82
+ "summary": {
83
+ "ownersCount": 1,
84
+ "membersCount": 1,
85
+ "guestsCount": 0
86
+ }
47
87
  }
48
88
  ]
49
89
  ```
50
90
 
51
91
  === "Text"
52
92
 
53
- ``` text
93
+ ```text
54
94
  id displayName isArchived description
55
95
  ------------------------------------ ---------------- ---------- ---------------------------------------
56
96
  5dc7ba76-b9aa-4fdd-9e91-9fe7d0e8dca3 Architecture false Architecture Discussion
@@ -58,7 +98,7 @@ m365 teams team list --joined
58
98
 
59
99
  === "CSV"
60
100
 
61
- ``` text
101
+ ```csv
62
102
  id,displayName,isArchived,description
63
103
  5dc7ba76-b9aa-4fdd-9e91-9fe7d0e8dca3,Architecture,,Architecture Discussion
64
104
  ```
@@ -40,8 +40,21 @@ m365 todo task set [options]
40
40
  `--reminderDateTime [reminderDateTime]`
41
41
  : The date and time for a reminder alert of the task to occur. This should be defined as a valid ISO 8601 string in the UTC time zone.
42
42
 
43
+ `--categories [categories]`
44
+ : Comma-separated list of categories associated with the task.
45
+
46
+ `--completedDateTime [completedDateTime]`
47
+ : The date and time when the task was finished. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
48
+
49
+ `--startDateTime [startDateTime]`
50
+ : The date and time when the task is scheduled to start. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
51
+
43
52
  --8<-- "docs/cmd/_global.md"
44
53
 
54
+ ## Remarks
55
+
56
+ When you specify the values for `categories`, each category can correspond to the displayName property of an [outlookCategory](https://learn.microsoft.com/en-us/graph/api/resources/outlookcategory?view=graph-rest-1.0). It is permissible to use distinct names.
57
+
45
58
  ## Examples
46
59
 
47
60
  Update a task with title _New task_ to _Update doco_ in Microsoft To Do tasks list with a specific name
@@ -68,6 +81,18 @@ Update a task with due date in Microsoft To Do tasks list with list id
68
81
  m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMABGAAAAAADhr7P77n9xS6PdtDemRwpHBwCin1tvQMXzRKN1hQDz2S3VAAAXXsleAACin1tvQMXzRKN1hQDz2S3VAAAXXzr9AAA=" --listId "AQMkADlhMTRkOGEzLWQ1M2QtNGVkNS04NjdmLWU0NzJhMjZmZWNmMwAuAAADKvwNgAMNPE_zFNRJXVrU1wEAhHKQZHItDEOVCn8U3xuA2AABmQeVPwAAAA==" --dueDateTime 2023-01-01
69
82
  ```
70
83
 
84
+ Update a task to Microsoft To Do with several categories
85
+
86
+ ```sh
87
+ m365 todo task set --title "New task" --listName "My task list" --categories "Red category,Important"
88
+ ```
89
+
90
+ Update a task to Microsoft To Do with a start date and set a reminder for the task
91
+
92
+ ```sh
93
+ m365 todo task set --title "New task" --listName "My task list" --startDateTime "2023-12-16T18:28:48.6964197Z" --isReminderOn true
94
+ ```
95
+
71
96
  ## Response
72
97
 
73
98
  === "JSON"
@@ -121,3 +146,28 @@ m365 todo task set --id "AAMkADU3Y2E0OTMxLTllYTQtNGFlZS1hZGM0LWI1NjZjY2FhM2RhMAB
121
146
  importance,isReminderOn,status,title,createdDateTime,lastModifiedDateTime,hasAttachments,categories,id,body,dueDateTime,reminderDateTime
122
147
  high,1,notStarted,Update doco,2022-10-29T11:03:20.9175176Z,2022-10-30T14:09:14.7687057Z,,[],AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=,"{""content"":""I should not forget this"",""contentType"":""text""}","{""dateTime"":""2023-01-01T00:00:00.0000000"",""timeZone"":""UTC""}","{""dateTime"":""2023-01-01T12:00:00.0000000"",""timeZone"":""UTC""}"
123
148
  ```
149
+
150
+ === "Markdown"
151
+
152
+ ```md
153
+ # todo task set --id "AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=" --title "Update doco" --listName "My task list" --status "notStarted"
154
+
155
+ Date: 4/3/2023
156
+
157
+ ## Update doco (AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=)
158
+
159
+ Property | Value
160
+ ---------|-------
161
+ importance | high
162
+ isReminderOn | true
163
+ status | notStarted
164
+ title | Update doco
165
+ createdDateTime | 2022-10-29T11:03:20.9175176Z
166
+ lastModifiedDateTime | 2022-10-30T14:07:03.0718199Z
167
+ hasAttachments | false
168
+ categories | []
169
+ id | AAMkAGYzNjMxYTU4LTJjZjYtNDlhMi1iMzQ2LWVmMTU3YmUzOGM5MABGAAAAAAAw3-tXgryDSr5p162KnUPKBwDEwEFouXWWT50CfwqSN9cpAAL3xdLTAADEwEFouXWWT50CfwqSN9cpAAL3xhtSAAA=
170
+ body | {"content":"I should not forget this","contentType":"text"}
171
+ dueDateTime | {"dateTime": "2023-01-01T00:00:00.0000000","timeZone": "UTC"}
172
+ reminderDateTime | {"dateTime": "2023-01-01T12:00:00.0000000","timeZone": "UTC"}
173
+ ```