@pnp/cli-microsoft365 6.0.0-beta.a9609a1 → 6.0.0-beta.b62b543

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/dist/m365/aad/commands/app/app-add.js +4 -4
  2. package/dist/m365/aad/commands/app/app-list.js +38 -0
  3. package/dist/m365/aad/commands/user/user-get.js +1 -0
  4. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  5. package/dist/m365/aad/commands.js +2 -0
  6. package/dist/m365/adaptivecard/commands/adaptivecard-send.js +4 -4
  7. package/dist/m365/base/SpoCommand.js +12 -11
  8. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  9. package/dist/m365/outlook/commands.js +1 -0
  10. package/dist/m365/planner/commands/bucket/bucket-get.js +4 -7
  11. package/dist/m365/planner/commands/plan/plan-get.js +11 -16
  12. package/dist/m365/pp/commands/card/card-clone.js +122 -0
  13. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  14. package/dist/m365/pp/commands/solution/solution-remove.js +130 -0
  15. package/dist/m365/pp/commands.js +3 -0
  16. package/dist/m365/spfx/commands/project/project-doctor/{doctor-1.16.0-beta.1.js → doctor-1.16.0-rc.0.js} +6 -6
  17. package/dist/m365/spfx/commands/project/project-doctor.js +1 -1
  18. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.2.js → upgrade-1.16.0-rc.0.js} +26 -26
  19. package/dist/m365/spfx/commands/project/project-upgrade.js +5 -2
  20. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  21. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -15
  22. package/dist/m365/spo/commands/file/file-version-list.js +96 -0
  23. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  24. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  25. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  26. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +150 -0
  27. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +149 -0
  28. package/dist/m365/spo/commands/list/list-roleassignment-add.js +4 -22
  29. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +4 -15
  30. package/dist/m365/spo/commands/list/list-set.js +31 -8
  31. package/dist/m365/spo/commands/list/list-view-field-add.js +19 -5
  32. package/dist/m365/spo/commands/list/list-view-field-remove.js +18 -4
  33. package/dist/m365/spo/commands/list/list-view-field-set.js +18 -4
  34. package/dist/m365/spo/commands/list/list-view-list.js +14 -10
  35. package/dist/m365/spo/commands/list/list-view-remove.js +17 -8
  36. package/dist/m365/spo/commands/list/list-view-set.js +19 -7
  37. package/dist/m365/spo/commands/list/list-webhook-set.js +11 -12
  38. package/dist/m365/spo/commands/listitem/listitem-list.js +4 -7
  39. package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js +4 -15
  40. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +4 -7
  41. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  42. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  43. package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +4 -7
  44. package/dist/m365/spo/commands/web/web-roleassignment-add.js +4 -15
  45. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +4 -8
  46. package/dist/m365/spo/commands.js +5 -2
  47. package/dist/m365/teams/commands/Meeting.js +3 -0
  48. package/dist/m365/teams/commands/channel/channel-get.js +2 -2
  49. package/dist/m365/teams/commands/channel/channel-remove.js +56 -39
  50. package/dist/m365/teams/commands/channel/channel-set.js +57 -19
  51. package/dist/m365/teams/commands/meeting/meeting-list.js +153 -0
  52. package/dist/m365/teams/commands/team/team-archive.js +4 -7
  53. package/dist/m365/teams/commands/team/team-remove.js +3 -3
  54. package/dist/m365/teams/commands/team/team-unarchive.js +3 -3
  55. package/dist/m365/teams/commands.js +1 -0
  56. package/dist/utils/md.js +8 -1
  57. package/docs/docs/cmd/aad/app/app-add.md +19 -19
  58. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  59. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  60. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +12 -5
  61. package/docs/docs/cmd/app/app-get.md +156 -0
  62. package/docs/docs/cmd/app/app-open.md +20 -0
  63. package/docs/docs/cmd/app/permission/permission-list.md +43 -0
  64. package/docs/docs/cmd/booking/business/business-get.md +107 -0
  65. package/docs/docs/cmd/booking/business/business-list.md +34 -0
  66. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  67. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  68. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  69. package/docs/docs/cmd/pa/app/app-get.md +184 -0
  70. package/docs/docs/cmd/pa/app/app-list.md +181 -0
  71. package/docs/docs/cmd/pa/app/app-remove.md +4 -0
  72. package/docs/docs/cmd/pa/connector/connector-export.md +4 -0
  73. package/docs/docs/cmd/pa/connector/connector-list.md +89 -0
  74. package/docs/docs/cmd/pa/environment/environment-get.md +113 -0
  75. package/docs/docs/cmd/pa/environment/environment-list.md +109 -0
  76. package/docs/docs/cmd/pa/pcf/pcf-init.md +4 -0
  77. package/docs/docs/cmd/pa/solution/solution-init.md +5 -0
  78. package/docs/docs/cmd/pa/solution/solution-reference-add.md +4 -0
  79. package/docs/docs/cmd/planner/plan/plan-get.md +2 -2
  80. package/docs/docs/cmd/pp/card/card-clone.md +77 -0
  81. package/docs/docs/cmd/pp/card/card-get.md +71 -0
  82. package/docs/docs/cmd/pp/card/card-list.md +71 -0
  83. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  84. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +85 -0
  85. package/docs/docs/cmd/pp/environment/environment-get.md +308 -0
  86. package/docs/docs/cmd/pp/environment/environment-list.md +312 -0
  87. package/docs/docs/cmd/pp/gateway/gateway-get.md +32 -0
  88. package/docs/docs/cmd/pp/gateway/gateway-list.md +35 -0
  89. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +23 -0
  90. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +27 -0
  91. package/docs/docs/cmd/pp/solution/solution-get.md +35 -0
  92. package/docs/docs/cmd/pp/solution/solution-list.md +37 -0
  93. package/docs/docs/cmd/pp/solution/solution-remove.md +82 -0
  94. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +62 -0
  95. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  96. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  97. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  98. package/docs/docs/cmd/spo/field/field-set.md +4 -1
  99. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +9 -9
  100. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +3 -3
  101. package/docs/docs/cmd/spo/file/file-version-list.md +76 -0
  102. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  103. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  104. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  105. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +62 -0
  106. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +58 -0
  107. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  108. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  109. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +9 -9
  110. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +8 -8
  111. package/docs/docs/cmd/spo/list/list-set.md +18 -6
  112. package/docs/docs/cmd/spo/list/list-view-field-add.md +14 -4
  113. package/docs/docs/cmd/spo/list/list-view-field-remove.md +11 -2
  114. package/docs/docs/cmd/spo/list/list-view-field-set.md +18 -2
  115. package/docs/docs/cmd/spo/list/list-view-list.md +16 -7
  116. package/docs/docs/cmd/spo/list/list-view-remove.md +12 -3
  117. package/docs/docs/cmd/spo/list/list-view-set.md +20 -6
  118. package/docs/docs/cmd/spo/list/list-webhook-set.md +9 -2
  119. package/docs/docs/cmd/spo/listitem/listitem-list.md +9 -9
  120. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.md +8 -8
  121. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +14 -19
  122. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  123. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  124. package/docs/docs/cmd/spo/sitedesign/sitedesign-get.md +2 -2
  125. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  126. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  127. package/docs/docs/cmd/spo/web/web-roleassignment-add.md +6 -6
  128. package/docs/docs/cmd/spo/web/web-roleassignment-remove.md +4 -4
  129. package/docs/docs/cmd/teams/channel/channel-get.md +7 -7
  130. package/docs/docs/cmd/teams/channel/channel-remove.md +12 -9
  131. package/docs/docs/cmd/teams/channel/channel-set.md +13 -6
  132. package/docs/docs/cmd/teams/meeting/meeting-list.md +149 -0
  133. package/docs/docs/cmd/teams/message/message-get.md +80 -0
  134. package/docs/docs/cmd/teams/message/message-list.md +63 -0
  135. package/docs/docs/cmd/teams/message/message-reply-list.md +63 -0
  136. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +31 -0
  137. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +4 -0
  138. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +35 -0
  139. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +36 -0
  140. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +41 -0
  141. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +49 -0
  142. package/docs/docs/cmd/teams/report/report-pstncalls.md +49 -0
  143. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +39 -0
  144. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +33 -0
  145. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +58 -0
  146. package/docs/docs/cmd/teams/tab/tab-add.md +35 -0
  147. package/docs/docs/cmd/teams/tab/tab-get.md +35 -0
  148. package/docs/docs/cmd/teams/tab/tab-list.md +43 -0
  149. package/docs/docs/cmd/teams/tab/tab-remove.md +4 -0
  150. package/docs/docs/cmd/teams/team/team-add.md +145 -0
  151. package/docs/docs/cmd/teams/team/team-archive.md +7 -3
  152. package/docs/docs/cmd/teams/team/team-clone.md +4 -0
  153. package/docs/docs/cmd/teams/team/team-get.md +78 -0
  154. package/docs/docs/cmd/teams/team/team-list.md +30 -0
  155. package/docs/docs/cmd/teams/team/team-remove.md +7 -3
  156. package/docs/docs/cmd/teams/team/team-set.md +4 -0
  157. package/docs/docs/cmd/teams/team/team-unarchive.md +5 -2
  158. package/docs/docs/cmd/teams/user/user-app-add.md +4 -0
  159. package/docs/docs/cmd/teams/user/user-app-list.md +40 -0
  160. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -0
  161. package/docs/docs/cmd/teams/user/user-list.md +31 -0
  162. package/docs/docs/cmd/todo/list/list-add.md +32 -1
  163. package/docs/docs/cmd/todo/list/list-get.md +2 -2
  164. package/docs/docs/cmd/todo/list/list-list.md +31 -0
  165. package/docs/docs/cmd/todo/list/list-remove.md +10 -6
  166. package/docs/docs/cmd/todo/list/list-set.md +9 -5
  167. package/docs/docs/cmd/todo/task/task-add.md +58 -2
  168. package/docs/docs/cmd/todo/task/task-get.md +3 -3
  169. package/docs/docs/cmd/todo/task/task-list.md +47 -0
  170. package/docs/docs/cmd/todo/task/task-remove.md +9 -4
  171. package/docs/docs/cmd/todo/task/task-set.md +59 -5
  172. package/docs/docs/cmd/util/accesstoken/accesstoken-get.md +20 -0
  173. package/docs/docs/cmd/viva/connections/connections-app-create.md +4 -0
  174. package/package.json +3 -1
@@ -10,27 +10,36 @@ m365 spo list view list [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-u, --webUrl <webUrl>`
13
+ `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located
15
15
 
16
- `-i, --listId [listId]`
17
- : ID of the list for which to list configured views. Specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
- `-t, --listTitle [listTitle]`
20
- : Title of the list for which to list configured views. Specify `listId` or `listTitle` but not both
19
+ `-t, --listTitle [listTitle]`
20
+ : Title of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- List all views for a list with title *Documents* located in site *https://contoso.sharepoint.com/sites/project-x*
29
+ List all views for a list by title
27
30
 
28
31
  ```sh
29
32
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
30
33
  ```
31
34
 
32
- List all views for a list with ID *0cd891ef-afce-4e55-b836-fce03286cccf* located in site *https://contoso.sharepoint.com/sites/project-x*
35
+ List all views for a list by ID
33
36
 
34
37
  ```sh
35
38
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
36
39
  ```
40
+
41
+ List all views for a list by URL
42
+
43
+ ```sh
44
+ m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events'
45
+ ```
@@ -14,10 +14,13 @@ m365 spo list view remove [options]
14
14
  : URL of the site where the list to remove the view from is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to remove. Specify either `id` or `title` but not both
@@ -32,7 +35,7 @@ m365 spo list view remove [options]
32
35
 
33
36
  ## Examples
34
37
 
35
- Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Remove view from the list by ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
39
 
37
40
  ```sh
38
41
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81
@@ -50,6 +53,12 @@ Remove view with title _MyView_ from a list with title _Documents_ located in si
50
53
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --title MyView
51
54
  ```
52
55
 
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
+
58
+ ```sh
59
+ m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle MyView
60
+ ```
61
+
53
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
54
63
 
55
64
  ```sh
@@ -14,10 +14,13 @@ m365 spo list view set [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to update. Specify `title` or `id` but not both
@@ -33,6 +36,9 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
33
36
 
34
37
  When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `&lt;` instead of `<`.
35
38
 
39
+ !!! warning "Escaping JSON in PowerShell"
40
+ When updating list view formatting for a view with the `--CustomFormatter` 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.
41
+
36
42
  ## Examples
37
43
 
38
44
  Update the title of the list view specified by its name
@@ -44,11 +50,19 @@ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x -
44
50
  Update the title of the list view specified by its ID
45
51
 
46
52
  ```sh
47
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
53
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
48
54
  ```
49
55
 
50
56
  Update view formatting of the specified list view
51
57
 
52
- ```sh
53
- 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', '')"}`'
54
- ```
58
+ === "PowerShell"
59
+
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'', '''')\"}'
62
+ ```
63
+
64
+ === "Bash"
65
+
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', '')\"}"
68
+ ```
@@ -31,6 +31,9 @@ m365 spo list webhook set [options]
31
31
  `-e, --expirationDateTime [expirationDateTime]`
32
32
  : The new expiration date. _Note: Expiration Time cannot be more than 6 months in future_
33
33
 
34
+ `-c, --clientState [clientState]`
35
+ : A client state information that will be passed through notifications.
36
+
34
37
  --8<-- "docs/cmd/_global.md"
35
38
 
36
39
  ## Remarks
@@ -51,8 +54,12 @@ Update the expiration date of a webhook with a specific ID attached to a list wi
51
54
  m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --expirationDateTime 2018-10-09T18:15
52
55
  ```
53
56
 
54
- Update the notification url of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
57
+ Update the notification url and clientState of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
55
58
 
56
59
  ```sh
57
- m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02
60
+ m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02 --clientState 'My client state'
58
61
  ```
62
+
63
+ ## Respone
64
+
65
+ The command won't return a response on success.
@@ -11,31 +11,31 @@ m365 spo listitem list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site from which the item should be retrieved
14
+ : URL of the site from which the item should be retrieved.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
17
+ : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
24
24
 
25
25
  `-q, --camlQuery [camlQuery]`
26
- : CAML query to use to query the list of items with
26
+ : CAML query to use to query the list of items with.
27
27
 
28
28
  `-f, --fields [fields]`
29
- : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both
29
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both.
30
30
 
31
31
  `-l, --filter [filter]`
32
- : OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both
32
+ : OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.
33
33
 
34
34
  `-p, --pageSize [pageSize]`
35
- : Number of list items to return. Specify `camlQuery` or `pageSize` but not both
35
+ : Number of list items to return. Specify `camlQuery` or `pageSize` but not both.
36
36
 
37
37
  `-n, --pageNumber [pageNumber]`
38
- : Page number to return if `pageSize` is specified (first page is indexed as value of 0)
38
+ : Page number to return if `pageSize` is specified (first page is indexed as value of 0).
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
@@ -11,31 +11,31 @@ m365 spo listitem roleassignment remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the listitem is located
14
+ : URL of the site where the listitem is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either listId, listTitle or listUrl but not multiple.
17
+ : ID of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either listId, listTitle or listUrl but not multiple.
20
+ : Title of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
21
21
 
22
22
  `--listUrl [listUrl]`
23
- : Relative URL of the list. Specify either listId, listTitle or listUrl but not multiple.
23
+ : Relative URL of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
24
24
 
25
25
  `--listItemId <listItemId>`
26
26
  : Id of the listitem to remove the role from.
27
27
 
28
28
  `--principalId [principalId]`
29
- : SharePoint ID of principal it may be either user id or group id we want to remove permissions Specify principalId only when upn or groupName are not used.
29
+ : SharePoint ID of principal it may be either user id or group id we want to remove permissions. Specify either `principalId`, `upn`, or `groupName` but not multiple.
30
30
 
31
31
  `--upn [upn]`
32
- : upn/email of user. Specify either upn or principalId.
32
+ : upn/email of user. Specify either `principalId`, `upn`, or `groupName` but not multiple.
33
33
 
34
34
  `--groupName [groupName]`
35
- : enter group name of Azure AD or SharePoint group. Specify either groupName or principalId.
35
+ : enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
36
36
 
37
37
  `--confirm`
38
- : Don't prompt for confirming removing the role assignment
38
+ : Don't prompt for confirming removing the role assignment.
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
@@ -11,31 +11,31 @@ m365 spo page clientsidewebpart add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the page to add the web part to is located
14
+ : URL of the site where the page to add the web part to is located.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page to which add the web part
17
+ : Name of the page to which add the web part.
18
18
 
19
19
  `--standardWebPart [standardWebPart]`
20
- : Name of the standard web part to add (see the possible values below)
20
+ : Name of the standard web part to add (see the possible values below). Specify either `standardWebPart` or `webPartId` but not both.
21
21
 
22
22
  `--webPartId [webPartId]`
23
- : ID of the custom web part to add
23
+ : ID of the custom web part to add. Specify either `standardWebPart` or `webPartId` but not both.
24
24
 
25
25
  `--webPartProperties [webPartProperties]`
26
- : JSON string with web part properties to set on the web part. Specify `webPartProperties` or `webPartData` but not both
26
+ : JSON string with web part properties to set on the web part. Specify `webPartProperties` or `webPartData` but not both.
27
27
 
28
28
  `--webPartData [webPartData]`
29
- : JSON string with web part data as retrieved from the web part maintenance mode. Specify `webPartProperties` or `webPartData` but not both
29
+ : JSON string with web part data as retrieved from the web part maintenance mode. Specify `webPartProperties` or `webPartData` but not both.
30
30
 
31
31
  `--section [section]`
32
- : Number of the section to which the web part should be added (1 or higher)
32
+ : Number of the section to which the web part should be added (1 or higher).
33
33
 
34
34
  `--column [column]`
35
- : Number of the column in which the web part should be added (1 or higher)
35
+ : Number of the column in which the web part should be added (1 or higher).
36
36
 
37
37
  `--order [order]`
38
- : Order of the web part in the column
38
+ : Order of the web part in the column.
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
@@ -45,7 +45,8 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
45
45
 
46
46
  To add a standard web part to the page, specify one of the following values: _ContentRollup, BingMap, ContentEmbed, DocumentEmbed, Image, ImageGallery, LinkPreview, NewsFeed, NewsReel, PowerBIReportEmbed, QuickChart, SiteActivity, VideoEmbed, YammerEmbed, Events, GroupCalendar, Hero, List, PageTitle, People, QuickLinks, CustomMessageRegion, Divider, MicrosoftForms, Spacer_.
47
47
 
48
- When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
48
+ !!! warning "Escaping JSON in PowerShell"
49
+ When using the `--webPartProperties` 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.
49
50
 
50
51
  ## Examples
51
52
 
@@ -67,20 +68,14 @@ Add a custom web part to the modern page
67
68
  m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --webPartId 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1
68
69
  ```
69
70
 
70
- Using PowerShell, add the standard Bing Map web part with the specific properties to a modern page
71
-
72
- ```PowerShell
73
- m365 --% spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties `"{""Title"":""Foo location""}"`
74
- ```
75
-
76
- Using Windows command line, add the standard Bing Map web part with the specific properties to a modern page
71
+ Add the standard Bing Map web part with the specific properties to a modern page
77
72
 
78
73
  ```sh
79
- m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties `"{""Title"":""Foo location""}"`
74
+ m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties '{"Title":"Foo location"}'
80
75
  ```
81
76
 
82
77
  Add the standard Image web part with the preconfigured image
83
78
 
84
79
  ```sh
85
- m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '`{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}`'
80
+ m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}'
86
81
  ```
@@ -31,7 +31,8 @@ m365 spo page control set [options]
31
31
 
32
32
  If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
33
33
 
34
- When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
34
+ !!! warning "Escaping JSON in PowerShell"
35
+ When using the `--webPartProperties` 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.
35
36
 
36
37
  ## Examples
37
38
 
@@ -1,11 +1,11 @@
1
- # spo hubsite theme sync
1
+ # spo site hubsite theme sync
2
2
 
3
- Applies any theme updates from the parent hub site.
3
+ Applies any theme updates from the hub site the site is connected to.
4
4
 
5
5
  ## Usage
6
6
 
7
7
  ```sh
8
- m365 spo hubsite theme sync [options]
8
+ m365 spo site hubsite theme sync [options]
9
9
  ```
10
10
 
11
11
  ## Options
@@ -22,10 +22,10 @@ m365 spo hubsite theme sync [options]
22
22
 
23
23
  ## Examples
24
24
 
25
- Applies any theme updates from the parent hub site to the site with URL https://contoso.sharepoint.com/sites/project-x
25
+ Applies any theme updates from the hub site to a specific site
26
26
 
27
27
  ```sh
28
- m365 spo hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
28
+ m365 spo site hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
29
29
  ```
30
30
 
31
31
  ## More information
@@ -11,10 +11,10 @@ m365 spo sitedesign get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : Site design ID. Specify either id or title but not both
14
+ : Site design ID. Specify either `id` or `title` but not both.
15
15
 
16
16
  `--title [title]`
17
- : Site design title. Specify either id or title but not both
17
+ : Site design title. Specify either `id` or `title` but not both.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -45,6 +45,11 @@ m365 spo term add [options]
45
45
  !!! important
46
46
  To use this command you have to have permissions to access the tenant admin site.
47
47
 
48
+ ## Remarks
49
+
50
+ !!! warning "Escaping JSON in PowerShell"
51
+ When using the `--customProperties` and/or `--localCustomProperties` options 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.
52
+
48
53
  ## Examples
49
54
 
50
55
  Add taxonomy term with the specified name to the term group and term set specified by their names
@@ -33,6 +33,11 @@ m365 spo term set add [options]
33
33
  !!! important
34
34
  To use this command you have to have permissions to access the tenant admin site.
35
35
 
36
+ ## Remarks
37
+
38
+ !!! warning "Escaping JSON in PowerShell"
39
+ When using the `--customProperties` 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.
40
+
36
41
  ## Examples
37
42
 
38
43
  Add taxonomy term set to the term group specified by ID
@@ -56,5 +61,5 @@ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-
56
61
  Add taxonomy term set and set its custom properties
57
62
 
58
63
  ```sh
59
- m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '`{"Property":"Value"}`'
64
+ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '{"Property":"Value"}'
60
65
  ```
@@ -11,22 +11,22 @@ m365 spo web roleassignment add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site
14
+ : URL of the site.
15
15
 
16
16
  `--principalId [principalId]`
17
- : SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify principalId only when upn or groupName are not used.
17
+ : SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
18
18
 
19
19
  `--upn [upn]`
20
- : upn/email of user to assign role to. Specify either upn or principalId
20
+ : upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
21
21
 
22
22
  `--groupName [groupName]`
23
- : enter group name of Azure AD or SharePoint group.. Specify either groupName or principalId
23
+ : enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
24
24
 
25
25
  `--roleDefinitionId [roleDefinitionId]`
26
- : ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
26
+ : ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
27
27
 
28
28
  `--roleDefinitionName [roleDefinitionName]`
29
- : enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
29
+ : enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
@@ -11,16 +11,16 @@ m365 spo web roleassignment remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site
14
+ : URL of the site.
15
15
 
16
16
  `--principalId [principalId]`
17
- : SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify principalId only when upn or groupName are not used.
17
+ : SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
18
18
 
19
19
  `--upn [upn]`
20
- : Upn/email of user to assign role to. Specify upn only when principalId or groupName are not used.
20
+ : Upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
21
21
 
22
22
  `--groupName [groupName]`
23
- : Enter group name of Azure AD or SharePoint group. Specify groupName only when principalId or upn are not used.
23
+ : Enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
24
24
 
25
25
  `--confirm [confirm]`
26
26
  : Don't prompt for confirming removing the roleassignment.
@@ -10,20 +10,20 @@ m365 teams channel get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId [teamId]`
14
- : The ID of the team to which the channel belongs to. Specify either teamId or teamName but not both
13
+ `--teamId [teamId]`
14
+ : The ID of the team to which the channel belongs to. Specify either `teamId` or `teamName` but not both.
15
15
 
16
16
  `--teamName [teamName]`
17
- : The display name of the team to which the channel belongs to. Specify either teamId or teamName but not both
17
+ : The display name of the team to which the channel belongs to. Specify either `teamId` or `teamName` but not both.
18
18
 
19
- `-c, --id [id]`
20
- : The ID of the channel for which to retrieve more information. Specify either id or name but not both
19
+ `-i, --id [id]`
20
+ : The ID of the channel for which to retrieve more information. Specify either `id` or `name` but not both.
21
21
 
22
22
  `--name [name]`
23
- : The display name of the channel for which to retrieve more information. Specify either id or name but not both
23
+ : The display name of the channel for which to retrieve more information. Specify either `id` or `name` but not both.
24
24
 
25
25
  `--primary`
26
- : Gets the default channel, General, of a team. If specified, id or name are not needed
26
+ : Gets the default channel, General, of a team. If specified, id or name are not needed.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
@@ -10,17 +10,20 @@ m365 teams channel remove [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-c, --id [id]`
14
- : The ID of the channel to remove
13
+ `--teamId [teamId]`
14
+ : The ID of the team to which the channel to remove belongs. Specify either `teamId` or `teamName` but not both.
15
15
 
16
- `-n, --name [name]`
17
- : The name of the channel to remove. Specify id or name but not both
16
+ `--teamName [teamName]`
17
+ : The display name of the team to which the channel to remove belongs. Specify either `teamId` or `teamName` but not both.
18
+
19
+ `-i, --id [id]`
20
+ : The ID of the channel to remove. Specify `id` or `name` but not both.
18
21
 
19
- `-i, --teamId <teamId>`
20
- : The ID of the team to which the channel to remove belongs
22
+ `-n, --name [name]`
23
+ : The name of the channel to remove. Specify `id` or `name` but not both.
21
24
 
22
25
  `--confirm`
23
- : Don't prompt for confirmation
26
+ : Don't prompt for confirmation.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -45,13 +48,13 @@ m365 teams channel remove --id 19:f3dcbb1674574677abcae89cb626f1e6@thread.skype
45
48
  Remove the specified Microsoft Teams channel by Name
46
49
 
47
50
  ```sh
48
- m365 teams channel remove --name 'name' --teamId d66b8110-fcad-49e8-8159-0d488ddb7656
51
+ m365 teams channel remove --name 'name' --teamName "Team Name"
49
52
  ```
50
53
 
51
54
  Remove the specified Microsoft Teams channel by Name without confirmation
52
55
 
53
56
  ```sh
54
- m365 teams channel remove --name 'name' --teamId d66b8110-fcad-49e8-8159-0d488ddb7656 --confirm
57
+ m365 teams channel remove --name 'name' --teamName "Team Name" --confirm
55
58
  ```
56
59
 
57
60
  ## More information
@@ -10,17 +10,23 @@ m365 teams channel set [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
14
- : The ID of the team where the channel to update is located
13
+ `--teamId [teamId]`
14
+ : The ID of the team where the channel to update is located. Specify either `teamId` or `teamName` but not both.
15
15
 
16
- `--name <name>`
17
- : The name of the channel to update
16
+ `--teamName [teamName]`
17
+ : The display name of the team where the channel to update is located. Specify either `teamId` or `teamName` but not both.
18
+
19
+ `-i, --id [id]`
20
+ : The ID of the channel to update. Specify either `id` or `name` but not both.
21
+
22
+ `--name [name]`
23
+ : The name of the channel to update. Specify either `id` or `name` but not both.
18
24
 
19
25
  `--newName [newName]`
20
- : The new name of the channel
26
+ : The new name of the channel.
21
27
 
22
28
  `--description [description]`
23
- : The description of the channel
29
+ : The description of the channel.
24
30
 
25
31
  --8<-- "docs/cmd/_global.md"
26
32
 
@@ -37,3 +43,4 @@ Set new display name for the specified channel in the given Microsoft Teams team
37
43
  ```sh
38
44
  m365 teams channel set --teamId "00000000-0000-0000-0000-000000000000" --name Reviews --newName Projects
39
45
  ```
46
+