@pnp/cli-microsoft365 6.4.0-beta.e3b0f5c → 6.4.0-beta.f8f3553

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 (174) hide show
  1. package/.eslintrc.js +3 -0
  2. package/README.md +12 -1
  3. package/dist/m365/aad/commands/user/user-get.js +3 -0
  4. package/dist/m365/aad/commands/user/user-set.js +3 -0
  5. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  6. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  7. package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +138 -0
  8. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +48 -14
  9. package/dist/m365/purview/commands.js +1 -0
  10. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  11. package/dist/m365/spo/commands/commandset/commandset-add.js +138 -0
  12. package/dist/m365/spo/commands/commandset/commandset-get.js +128 -0
  13. package/dist/m365/spo/commands/commandset/commandset-list.js +77 -0
  14. package/dist/m365/spo/commands/commandset/commandset-remove.js +146 -0
  15. package/dist/m365/spo/commands/commandset/commandset-set.js +182 -0
  16. package/dist/m365/spo/commands/file/file-move.js +1 -1
  17. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  18. package/dist/m365/spo/commands/list/list-add.js +11 -8
  19. package/dist/m365/spo/commands/list/list-set.js +3 -3
  20. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  21. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  22. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  23. package/dist/m365/spo/commands/user/user-ensure.js +105 -0
  24. package/dist/m365/spo/commands.js +7 -0
  25. package/dist/utils/aadUser.js +37 -0
  26. package/dist/utils/md.js +7 -0
  27. package/dist/utils/spo.js +32 -0
  28. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  29. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  30. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  31. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  32. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  33. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  34. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  35. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  36. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  37. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  38. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  39. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  40. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  41. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  42. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  43. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  44. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  45. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  46. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  47. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  48. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  49. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  50. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  51. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  52. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  53. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  54. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  55. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  56. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  57. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  58. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  59. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  60. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  61. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  62. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  63. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  64. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  65. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +149 -0
  66. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  67. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -0
  68. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  69. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  70. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  71. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  72. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  73. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +21 -0
  74. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  75. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  76. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  77. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  78. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  79. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  80. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  81. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  82. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  83. package/docs/docs/cmd/spo/commandset/commandset-add.md +159 -0
  84. package/docs/docs/cmd/spo/commandset/commandset-get.md +149 -0
  85. package/docs/docs/cmd/spo/commandset/commandset-list.md +109 -0
  86. package/docs/docs/cmd/spo/commandset/commandset-remove.md +55 -0
  87. package/docs/docs/cmd/spo/commandset/commandset-set.md +71 -0
  88. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  89. package/docs/docs/cmd/spo/group/group-member-add.md +22 -0
  90. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  91. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  92. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  93. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  94. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  95. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  96. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  97. package/docs/docs/cmd/spo/list/list-add.md +2 -2
  98. package/docs/docs/cmd/spo/list/list-set.md +2 -2
  99. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  100. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  101. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  102. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +2 -2
  103. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +1 -1
  104. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  105. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  106. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  107. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  108. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  109. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  110. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  111. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  112. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  113. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  114. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  115. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  116. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  117. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  118. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  119. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  120. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  121. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  122. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  123. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  124. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  125. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  126. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  127. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +2 -0
  128. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  129. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  130. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  131. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  132. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  133. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  134. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  135. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  136. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  137. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  138. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  139. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  140. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  141. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  142. package/docs/docs/cmd/spo/user/user-ensure.md +109 -0
  143. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  144. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  145. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  146. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  147. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  148. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  149. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  150. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  151. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  152. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  153. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  154. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  155. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  156. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  157. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  158. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  159. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  160. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  161. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  162. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  163. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  164. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  165. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  166. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  167. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  168. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  169. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  170. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  171. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  172. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  173. package/npm-shrinkwrap.json +277 -192
  174. package/package.json +13 -13
@@ -0,0 +1,149 @@
1
+ # spo commandset get
2
+
3
+ Get a ListView Command Set that is added to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo commandset get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Url of the site.
15
+
16
+ `-t, --title [title]`
17
+ : The title of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
18
+
19
+ `-i, --id [id]`
20
+ : The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
21
+
22
+ `-c, --clientSideComponentId [clientSideComponentId]`
23
+ : The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
24
+
25
+ `-s, --scope [scope]`
26
+ : Scope of the ListView Command Set. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Remarks
31
+
32
+ If the command finds multiple command sets with the specified title, it will prompt you to disambiguate which command set it should use, listing the discovered IDs.
33
+
34
+ ## Examples
35
+
36
+ Retrieves a ListView Command Set by title.
37
+
38
+ ```sh
39
+ m365 spo commandset get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
40
+ ```
41
+
42
+ Retrieves a ListView Command Set by id with scope 'Web'.
43
+
44
+ ```sh
45
+ m365 spo commandset get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales -scope Web
46
+ ```
47
+
48
+ Retrieves a ListView Command Set by clientSideComponentId with scope 'Site'.
49
+
50
+ ```sh
51
+ m365 spo commandset get --clientSideComponentId c1cbd896-5140-428d-8b0c-4873be19f5ac --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
52
+ ```
53
+
54
+ ## Response
55
+
56
+ === "JSON"
57
+
58
+ ```json
59
+ {
60
+ "ClientSideComponentId": "c1cbd896-5140-428d-8b0c-4873be19f5ac",
61
+ "ClientSideComponentProperties": "{\"sampleTextOne\":\"One item is selected in the list.\", \"sampleTextTwo\":\"This command is always visible.\"}",
62
+ "CommandUIExtension": null,
63
+ "Description": null,
64
+ "Group": null,
65
+ "HostProperties": "",
66
+ "Id": "9a0674de-2f3d-4a26-ba79-62b460ddd327",
67
+ "ImageUrl": null,
68
+ "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
69
+ "Name": "{9a0674de-2f3d-4a26-ba79-62b460ddd327}",
70
+ "RegistrationId": "100",
71
+ "RegistrationType": 1,
72
+ "Rights": {
73
+ "High": "0",
74
+ "Low": "0"
75
+ },
76
+ "Scope": 3,
77
+ "ScriptBlock": null,
78
+ "ScriptSrc": null,
79
+ "Sequence": 65536,
80
+ "Title": "Notification",
81
+ "Url": null,
82
+ "VersionOfUserCustomAction": "1.0.1.0"
83
+ }
84
+ ```
85
+
86
+ === "Text"
87
+
88
+ ```text
89
+ ClientSideComponentId : c1cbd896-5140-428d-8b0c-4873be19f5ac
90
+ ClientSideComponentProperties: {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
91
+ CommandUIExtension : null
92
+ Description : null
93
+ Group : null
94
+ HostProperties :
95
+ Id : 9a0674de-2f3d-4a26-ba79-62b460ddd327
96
+ ImageUrl : null
97
+ Location : ClientSideExtension.ListViewCommandSet.CommandBar
98
+ Name : {9a0674de-2f3d-4a26-ba79-62b460ddd327}
99
+ RegistrationId : 100
100
+ RegistrationType : 1
101
+ Rights : {"High":"0","Low":"0"}
102
+ Scope : 3
103
+ ScriptBlock : null
104
+ ScriptSrc : null
105
+ Sequence : 65536
106
+ Title : Notification
107
+ Url : null
108
+ VersionOfUserCustomAction : 1.0.1.0
109
+ ```
110
+
111
+ === "CSV"
112
+
113
+ ```csv
114
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
115
+ c1cbd896-5140-428d-8b0c-4873be19f5ac,"{""sampleTextOne"":""One item is selected in the list."", ""sampleTextTwo"":""This command is always visible.""}",,,,,9a0674de-2f3d-4a26-ba79-62b460ddd327,,ClientSideExtension.ListViewCommandSet.CommandBar,{9a0674de-2f3d-4a26-ba79-62b460ddd327},100,1,"{""High"":""0"",""Low"":""0""}",3,,,65536,Notification,,1.0.1.0
116
+ ```
117
+
118
+ === "Markdown"
119
+
120
+ ```md
121
+ # spo commandset get --webUrl "https://contoso.sharepoint.com/sites/sales" --id "9a0674de-2f3d-4a26-ba79-62b460ddd327"
122
+
123
+ Date: 27/02/2023
124
+
125
+ ## Notification (9a0674de-2f3d-4a26-ba79-62b460ddd327)
126
+
127
+ Property | Value
128
+ ---------|-------
129
+ ClientSideComponentId | c1cbd896-5140-428d-8b0c-4873be19f5ac
130
+ ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
131
+ CommandUIExtension | null
132
+ Description | null
133
+ Group | null
134
+ HostProperties |
135
+ Id | 9a0674de-2f3d-4a26-ba79-62b460ddd327
136
+ ImageUrl | null
137
+ Location | ClientSideExtension.ListViewCommandSet.CommandBar
138
+ Name | {9a0674de-2f3d-4a26-ba79-62b460ddd327}
139
+ RegistrationId | 100
140
+ RegistrationType | 1
141
+ Rights | {"High":"0","Low":"0"}
142
+ Scope | 3
143
+ ScriptBlock | null
144
+ ScriptSrc | null
145
+ Sequence | 65536
146
+ Title | Notification
147
+ Url | null
148
+ VersionOfUserCustomAction | 1.0.1.0
149
+ ```
@@ -0,0 +1,109 @@
1
+ # spo commandset list
2
+
3
+ Get a list of ListView Command Sets that are added to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo commandset list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The url of the site.
15
+
16
+ `-s, --scope [scope]`
17
+ : Scope of the ListView Command Sets. Allowed values `Site`, `Web`, `All`. Default to `All`
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieves a list of ListView Command Sets.
24
+
25
+ ```sh
26
+ m365 spo commandset list --webUrl https://contoso.sharepoint.com/sites/sales
27
+ ```
28
+
29
+ ## Response
30
+
31
+ === "JSON"
32
+
33
+ ```json
34
+ [
35
+ {
36
+ "ClientSideComponentId": "b206e130-1a5b-4ae7-86a7-4f91c9924d0a",
37
+ "ClientSideComponentProperties": "",
38
+ "CommandUIExtension": null,
39
+ "Description": null,
40
+ "Group": null,
41
+ "HostProperties": "",
42
+ "Id": "e7000aef-f756-4997-9420-01cc84f9ac9c",
43
+ "ImageUrl": null,
44
+ "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
45
+ "Name": "{e7000aef-f756-4997-9420-01cc84f9ac9c}",
46
+ "RegistrationId": "100",
47
+ "RegistrationType": 0,
48
+ "Rights": {
49
+ "High": 0,
50
+ "Low": 0
51
+ },
52
+ "Scope": 2,
53
+ "ScriptBlock": null,
54
+ "ScriptSrc": null,
55
+ "Sequence": 0,
56
+ "Title": "test",
57
+ "Url": null,
58
+ "VersionOfUserCustomAction": "16.0.1.0"
59
+ }
60
+ ]
61
+ ```
62
+
63
+ === "Text"
64
+
65
+ ```text
66
+ Name Location Scope Id
67
+ -------------------------------------- ------------------------------------------------- ----- ------------------------------------
68
+ {e7000aef-f756-4997-9420-01cc84f9ac9c} ClientSideExtension.ListViewCommandSet.CommandBar 2 e7000aef-f756-4997-9420-01cc84f9ac9c
69
+ ```
70
+
71
+ === "CSV"
72
+
73
+ ```csv
74
+ Name,Location,Scope,Id
75
+ {e7000aef-f756-4997-9420-01cc84f9ac9c},ClientSideExtension.ListViewCommandSet.CommandBar,2,e7000aef-f756-4997-9420-01cc84f9ac9c
76
+ ```
77
+
78
+ === "Markdown"
79
+
80
+ ```md
81
+ # spo commandset list --webUrl "https://ordidev.sharepoint.com"
82
+
83
+ Date: 20/2/2023
84
+
85
+ ## test (e7000aef-f756-4997-9420-01cc84f9ac9c)
86
+
87
+ Property | Value
88
+ ---------|-------
89
+ ClientSideComponentId | b206e130-1a5b-4ae7-86a7-4f91c9924d0a
90
+ ClientSideComponentProperties |
91
+ CommandUIExtension | null
92
+ Description | null
93
+ Group | null
94
+ HostProperties |
95
+ Id | e7000aef-f756-4997-9420-01cc84f9ac9c
96
+ ImageUrl | null
97
+ Location | ClientSideExtension.ListViewCommandSet.CommandBar
98
+ Name | {e7000aef-f756-4997-9420-01cc84f9ac9c}
99
+ RegistrationId | 100
100
+ RegistrationType | 0
101
+ Rights | {"High":0,"Low":0}
102
+ Scope | 2
103
+ ScriptBlock | null
104
+ ScriptSrc | null
105
+ Sequence | 0
106
+ Title | test
107
+ Url | null
108
+ VersionOfUserCustomAction | 16.0.1.0
109
+ ```
@@ -0,0 +1,55 @@
1
+ # spo commandset remove
2
+
3
+ Remove a ListView Command Set that is added to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo commandset remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Url of the site.
15
+
16
+ `-t, --title [title]`
17
+ : The title of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
18
+
19
+ `-i, --id [id]`
20
+ : The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
21
+
22
+ `-c, --clientSideComponentId [clientSideComponentId]`
23
+ : The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
24
+
25
+ `-s, --scope [scope]`
26
+ : Scope of the ListView Command Set. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
27
+
28
+ `--confirm`
29
+ : Don't prompt for confirming removal of the ListView Command Set
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Examples
34
+
35
+ Remove a ListView Command Set by title.
36
+
37
+ ```sh
38
+ m365 spo commandset remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
39
+ ```
40
+
41
+ Remove a ListView Command Set by id.
42
+
43
+ ```sh
44
+ m365 spo commandset remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
45
+ ```
46
+
47
+ Remove a ListView Command Set by clientSideComponentId.
48
+
49
+ ```sh
50
+ m365 spo commandset remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
51
+ ```
52
+
53
+ ## Response
54
+
55
+ The command won't return a response on success.
@@ -0,0 +1,71 @@
1
+ # spo commandset set
2
+
3
+ Updates a ListView Command Set on a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo commandset set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The site to update the ListView Command Set on.
15
+
16
+ `-t, --title [title]`
17
+ : The title of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
18
+
19
+ `-i, --id [id]`
20
+ : The id of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
21
+
22
+ `-c, --clientSideComponentId [clientSideComponentId]`
23
+ : The Client Side Component Id (GUID) of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
24
+
25
+ `--newTitle [newTitle]`
26
+ : The new title of the ListView Command Set.
27
+
28
+ `-l, --listType [listType]`
29
+ : The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`.
30
+
31
+ `--clientSideComponentProperties [clientSideComponentProperties]`
32
+ : The Client Side Component properties of the ListView Command Set.
33
+
34
+ `-s, --scope [scope]`
35
+ : The scope where to lookup the ListView Command Set: at site level or web level. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
36
+
37
+ `--location [location]`
38
+ : The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`.
39
+
40
+ --8<-- "docs/cmd/_global.md"
41
+
42
+ ## Remarks
43
+
44
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how a ListView Command Set can be created from the Windows cmd.exe:
45
+
46
+ ```sh
47
+ m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "Both" --listType "List" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
48
+ ```
49
+
50
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
51
+
52
+ !!! warning "Escaping JSON in PowerShell"
53
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
54
+
55
+ ## Examples
56
+
57
+ Updates the title and location of a ListView Command Set on the sales site.
58
+
59
+ ```sh
60
+ m365 spo commandset set --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --newTitle "Some new title" --location Both --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
61
+ ```
62
+
63
+ Updates a ListView Command Set on the sales site with some properties.
64
+
65
+ ```sh
66
+ m365 spo commandset set --title "Some customizer" --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
67
+ ```
68
+
69
+ ## Response
70
+
71
+ The command won't return a response on success.
@@ -27,6 +27,8 @@ m365 spo externaluser list [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
30
32
  !!! important
31
33
  To use this command you have to have permissions to access the tenant admin site.
32
34
 
@@ -126,3 +126,25 @@ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --
126
126
  DisplayName,Email
127
127
  John Doe,john.doe@contoso.onmicrosoft.com
128
128
  ```
129
+
130
+ === "Markdown"
131
+
132
+ ```md
133
+ # spo group member add --webUrl "https://contoso.sharepoint.com" --groupId "5" --aadGroupId "f2fb2f10-cfd2-4054-8ffd-64533657a5ab"
134
+
135
+ Date: 13/2/2023
136
+
137
+ ## All Company Members
138
+
139
+ Property | Value
140
+ ---------|-------
141
+ AllowedRoles | [0]
142
+ CurrentRole | 0
143
+ DisplayName | All Company Members
144
+ Email | allcompany@contoso.onmicrosoft.com
145
+ InvitationLink | null
146
+ IsUserKnown | true
147
+ Message | null
148
+ Status | true
149
+ User | c:0o.c\|federateddirectoryclaimprovider\|f2fb2f10-cfd2-4054-8ffd-64533657a5ab
150
+ ```
@@ -12,6 +12,8 @@ m365 spo hidedefaultthemes get [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -15,6 +15,8 @@ m365 spo hidedefaultthemes set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,6 +15,8 @@ m365 spo homesite remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,6 +15,8 @@ m365 spo homesite set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -12,6 +12,8 @@ m365 spo knowledgehub get [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -15,6 +15,8 @@ m365 spo knowledgehub remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,13 +15,13 @@ m365 spo knowledgehub set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  If the specified url doesn't refer to an existing site collection, you will get a `404 - "404 FILE NOT FOUND"` error.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Sets the Knowledge Hub Site for your tenant.
@@ -13,8 +13,8 @@ m365 spo list add [options]
13
13
  `-t, --title <title>`
14
14
  : Title of the list to add.
15
15
 
16
- `--baseTemplate <baseTemplate>`
17
- : The list definition type on which the list is based. Allowed values `Announcements`, `Contacts`, `CustomGrid`, `DataSources`,`DiscussionBoard`, `DocumentLibrary`, `Events`, `GanttTasks`, `GenericList`, `IssuesTracking`, `Links`, `NoCodeWorkflows`,`PictureLibrary`, `Survey`, `Tasks`, `WebPageLibrary`, `WorkflowHistory`, `WorkflowProcess`, `XmlForm`. Default `GenericList`.
16
+ `--baseTemplate [baseTemplate]`
17
+ : The list definition type on which the list is based. Allowed values `Announcements`, `Contacts`, `CustomGrid`, `DataSources`,`DiscussionBoard`, `DocumentLibrary`, `Events`, `GanttTasks`, `GenericList`, `IssuesTracking`, `Links`, `NoCodeWorkflows`,`PictureLibrary`, `Survey`, `Tasks`, `WebPageLibrary`, `WorkflowHistory`, `WorkflowProcess`, `XmlForm`. Default value is `GenericList`.
18
18
 
19
19
  `-u, --webUrl <webUrl>`
20
20
  : URL of the site where the list should be added.
@@ -59,7 +59,7 @@ m365 spo list set [options]
59
59
  : Property for assigning or retrieving grid editing on the list. Valid values are `true`, `false`.
60
60
 
61
61
  `--draftVersionVisibility [draftVersionVisibility]`
62
- : Value that specifies the minimum permission required to view minor versions and drafts within the list. Allowed values `Reader`, `Author`, `Approver`. Default `Reader`.
62
+ : Value that specifies the minimum permission required to view minor versions and drafts within the list. Allowed values `Reader`, `Author`, `Approver`.
63
63
 
64
64
  `--emailAlias [emailAlias]`
65
65
  : If e-mail notification is enabled, gets or sets the e-mail address to use tonotify to the owner of an item when an assignment has changed or the item has been updated.
@@ -137,7 +137,7 @@ m365 spo list set [options]
137
137
  : Indicates whether this list should be treated as a top level navigation object or not.
138
138
 
139
139
  `--listExperienceOptions [listExperienceOptions]`
140
- : Gets or sets the list experience for the list. Allowed values `Auto`, `NewExperience`, `ClassicExperience`. Default `Auto`.
140
+ : Gets or sets the list experience for the list. Allowed values `Auto`, `NewExperience`, `ClassicExperience`.
141
141
 
142
142
  `--majorVersionLimit [majorVersionLimit]`
143
143
  : Gets or sets the maximum number of major versions allowed for an item in a document library that uses version control with major versions only.
@@ -59,7 +59,7 @@ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoin
59
59
  Add an item with Title _Demo Multi Person Field_ and a multi-select people field named _MultiPeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
60
60
 
61
61
  ```sh
62
- m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|adamb@conotoso.com'}]"
62
+ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|john.doe@conotoso.com'}]"
63
63
  ```
64
64
 
65
65
  Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _CustomHyperlink_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -53,7 +53,7 @@ A sample CSV can be found below. The first line of the CSV-file should contain t
53
53
 
54
54
  ```csv
55
55
  ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField
56
- Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|adamb@contoso.com'}]","https://bing.com, URL",5
56
+ Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5
57
57
  ```
58
58
 
59
59
  ## Response
@@ -62,7 +62,7 @@ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.
62
62
  Update an item with id _147_ with Title _Demo Multi Person Field_ and a multi-select people field named _MultiPeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
63
63
 
64
64
  ```sh
65
- m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|adamb@conotoso.com'}]"
65
+ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|john.doe@conotoso.com'}]"
66
66
  ```
67
67
 
68
68
  Update the field _Title_ and _CustomHyperlink_ of an item with a specific id in a list retrieved by server-relative URL in a specific site
@@ -19,8 +19,8 @@ m365 spo navigation node add [options]
19
19
  `-t, --title <title>`
20
20
  : Navigation node title.
21
21
 
22
- `--url <url>`
23
- : Navigation node URL.
22
+ `--url [url]`
23
+ : Navigation node URL. When not specified a linkless label will be created.
24
24
 
25
25
  `--parentNodeId [parentNodeId]`
26
26
  : ID of the node below which the node should be added. Specify either `location` or `parentNodeId` but not both.
@@ -20,7 +20,7 @@ m365 spo navigation node set [options]
20
20
  : New title of the navigation node.
21
21
 
22
22
  `--url [url]`
23
- : New URL of the navigation node.
23
+ : New URL of the navigation node. Specify an empty string `""` to update the navigation label to a linkless label.
24
24
 
25
25
  `--audienceIds [audienceIds]`
26
26
  : Comma-separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
@@ -21,6 +21,8 @@ m365 spo orgassetslibrary add [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
+ ## Remarks
25
+
24
26
  !!! important
25
27
  To use this command you have to have permissions to access the tenant admin site.
26
28
 
@@ -12,6 +12,8 @@ m365 spo orgassetslibrary list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -18,6 +18,8 @@ m365 spo orgassetslibrary remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -12,6 +12,8 @@ m365 spo orgnewssite list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -18,6 +18,8 @@ m365 spo orgnewssite remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -15,13 +15,13 @@ m365 spo orgnewssite set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-u, --url` option you can specify which site to add to the list of organizational news sites.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Set a site as an organizational news site
@@ -15,6 +15,8 @@ m365 spo site appcatalog add [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22