@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
@@ -78,6 +78,9 @@ Note, how the clientSideComponentProperties option (-p) has escaped double quote
78
78
 
79
79
  The `--rights` option accepts **case sensitive** values.
80
80
 
81
+ !!! warning "Escaping JSON in PowerShell"
82
+ 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.
83
+
81
84
  ## Examples
82
85
 
83
86
  Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_
@@ -77,12 +77,13 @@ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for
77
77
  m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
78
78
  ```
79
79
 
80
- Note, how the `clientSideComponentProperties` option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
81
-
82
80
  The `--rights` option accepts **case-sensitive** values.
83
81
 
84
82
  Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
85
83
 
84
+ !!! warning "Escaping JSON in PowerShell"
85
+ 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.
86
+
86
87
  ## Examples
87
88
 
88
89
  Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_
@@ -37,6 +37,9 @@ m365 spo field set [options]
37
37
 
38
38
  Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
39
39
 
40
+ !!! warning "Escaping JSON in PowerShell"
41
+ When updating column formatting for a field 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.
42
+
40
43
  ## Examples
41
44
 
42
45
  Update the title of the site column specified by its internal name and push changes to existing lists
@@ -60,5 +63,5 @@ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --lis
60
63
  Update column formatting of the specified list column
61
64
 
62
65
  ```sh
63
- m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
66
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
64
67
  ```
@@ -11,28 +11,28 @@ m365 spo file roleassignment add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the file is located
14
+ : URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
17
+ : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `i, --fileId [fileId]`
20
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
20
+ : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
22
  `--principalId [principalId]`
23
- : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
23
+ : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
24
24
 
25
25
  `--upn [upn]`
26
- : upn/email of user to assign role to. Specify either upn, groupName or principalId.
26
+ : upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
27
27
 
28
28
  `--groupName [groupName]`
29
- : The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
29
+ : The group name of Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
30
 
31
31
  `--roleDefinitionId [roleDefinitionId]`
32
- : ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
32
+ : ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
33
33
 
34
34
  `--roleDefinitionName [roleDefinitionName]`
35
- : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
35
+ : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
36
36
 
37
37
  --8<-- "docs/cmd/_global.md"
38
38
 
@@ -54,4 +54,4 @@ Adds a role assignment to a file with a specified server-relative URL the for a
54
54
 
55
55
  ```sh
56
56
  m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
57
- ```
57
+ ```
@@ -20,13 +20,13 @@ m365 spo file roleassignment remove [options]
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
22
  `--principalId [principalId]`
23
- : The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId`.
23
+ : The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId` but not multiple.
24
24
 
25
25
  `--upn [upn]`
26
- : Upn/email of the user. Specify either `upn`, `groupName`, or `principalId`.
26
+ : Upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
27
27
 
28
28
  `--groupName [groupName]`
29
- : The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId`.
29
+ : The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
30
 
31
31
  `--confirm [confirm]`
32
32
  : Don't prompt for confirmation.
@@ -0,0 +1,76 @@
1
+ # spo file version list
2
+
3
+ Retrieves all versions of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file version list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-w, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located
15
+
16
+ `-u, --fileUrl [fileUrl]`
17
+ : The site-relative or server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
+
19
+ `-i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Examples
25
+
26
+ List file versions of a specific file based on the ID of the file
27
+
28
+ ```sh
29
+ m365 spo file version list --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
30
+ ```
31
+
32
+ List file versions of a specific file based on the site-relative URL of the file
33
+
34
+ ```sh
35
+ m365 spo file version list --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx'
36
+ ```
37
+
38
+ List file versions of a specific file based on the server-relative URL of the file
39
+
40
+ ```sh
41
+ m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/Shared Documents/Document.docx'
42
+ ```
43
+
44
+ ## Response
45
+
46
+ === "JSON"
47
+
48
+ ```json
49
+ [
50
+ {
51
+ "CheckInComment": "",
52
+ "Created": "2022-10-30T12:03:06Z",
53
+ "ID": 512,
54
+ "IsCurrentVersion": false,
55
+ "Length": "18898",
56
+ "Size": 18898,
57
+ "Url": "_vti_history/512/Shared Documents/Document.docx",
58
+ "VersionLabel": "1.0"
59
+ }
60
+ ]
61
+ ```
62
+
63
+ === "Text"
64
+
65
+ ```text
66
+ CheckInComment Created ID IsCurrentVersion Length Size Url VersionLabel
67
+ -------------- -------------------- ---- ---------------- ------ ----- ------------------------------------------------ ------------
68
+ 2022-10-30T12:03:06Z 512 false 18898 18898 _vti_history/512/Shared Documents/Document.docx 1.0
69
+ ```
70
+
71
+ === "CSV"
72
+
73
+ ```csv
74
+ CheckInComment,Created,ID,IsCurrentVersion,Length,Size,Url,VersionLabel
75
+ ,2022-10-30T12:03:06Z,512,,18898,18898,_vti_history/512/Shared Documents/Document.docx,1.0
76
+ ```
@@ -16,6 +16,9 @@ m365 spo folder list [options]
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
17
  : Site-relative URL of the parent folder
18
18
 
19
+ `-r, --recursive`
20
+ : Set to retrieve nested folders
21
+
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Examples
@@ -25,3 +28,45 @@ Gets list of folders under a parent folder with site-relative url _/Shared Docum
25
28
  ```sh
26
29
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
27
30
  ```
31
+
32
+ Gets recursive list of folders under a specific folder on a specific site
33
+
34
+ ```sh
35
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
36
+ ```
37
+
38
+ ## Response
39
+
40
+ === "JSON"
41
+
42
+ ```json
43
+ [
44
+ {
45
+ "Exists": true,
46
+ "IsWOPIEnabled": false,
47
+ "ItemCount": 9,
48
+ "Name": "Folder A",
49
+ "ProgID": null,
50
+ "ServerRelativeUrl": "/Shared Documents/Folder A",
51
+ "TimeCreated": "2022-04-26T12:30:56Z",
52
+ "TimeLastModified": "2022-04-26T12:50:14Z",
53
+ "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
54
+ "WelcomePage": ""
55
+ }
56
+ ]
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```text
62
+ Name ServerRelativeUrl
63
+ ------- -------------------------
64
+ Folder A /Shared Documents/Folder A
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ Name,ServerRelativeUrl
71
+ Folder A,/Shared Documents/Folder A
72
+ ```
@@ -37,3 +37,9 @@ Break the inheritance of a folder with a specified server-relative URL. It will
37
37
  ```sh
38
38
  m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --clearExistingPermissions --confirm
39
39
  ```
40
+
41
+ Break the inheritance of the specified root folder for the library with a specified server-relative URL. It will clear the existing permissions of the root folder. It will **not** prompt for confirmation before breaking the inheritance.
42
+
43
+ ```sh
44
+ m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --confirm
45
+ ```
@@ -34,3 +34,9 @@ Reset inheritance of folder with server-relative url _/sites/project-x/Shared Do
34
34
  ```sh
35
35
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
36
36
  ```
37
+
38
+ Reset inheritance of the specified root folder for the library with the server-relative url _/sites/project-x/Shared Documents located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
39
+
40
+ ```sh
41
+ m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
42
+ ```
@@ -0,0 +1,62 @@
1
+ # spo hubsite connect
2
+
3
+ Connect a hub site to a parent hub site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo hubsite connect [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id [id]`
14
+ : ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
18
+
19
+ `-u, --url [url]`
20
+ : Absolute or server-relative URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
21
+
22
+ `--parentId [parentId]`
23
+ : ID of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
24
+
25
+ `--parentTitle [parentTitle]`
26
+ : Title of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
27
+
28
+ `--parentUrl [parentUrl]`
29
+ : Absolute or server-relative URL of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Remarks
34
+
35
+ !!! important
36
+ To use this command you must be a Global or SharePoint administrator.
37
+
38
+ To connect a regular site to a hub site, use command [spo site hubsite connect](../site/site-hubsite-connect.md).
39
+
40
+ ## Examples
41
+
42
+ Connect a specific hub site to specific parent hub site by ID
43
+
44
+ ```sh
45
+ m365 spo hubsite connect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
46
+ ```
47
+
48
+ Connect a specific hub site to specific parent hub site by URL
49
+
50
+ ```sh
51
+ m365 spo hubsite connect --url https://contoso.sharepoint.com/sites/project-x --parentUrl https://contoso.sharepoint.com/sites/projects
52
+ ```
53
+
54
+ Connect a specific hub site with title to a parent hub site with ID
55
+
56
+ ```sh
57
+ m365 spo hubsite connect --title "My hub site" --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
58
+ ```
59
+
60
+ ## Response
61
+
62
+ The command won't return a response on success.
@@ -0,0 +1,58 @@
1
+ # spo hubsite disconnect
2
+
3
+ Disconnect a hub site from its parent hub site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo hubsite disconnect [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id [id]`
14
+ : ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
18
+
19
+ `-u, --url [url]`
20
+ : Absolute or server-relative URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirmation.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ !!! important
30
+ To use this command you must be a Global or SharePoint administrator.
31
+
32
+ To disconnect a regular site from a hub site, use command [spo site hubsite disconnect](../site/site-hubsite-disconnect.md).
33
+
34
+ If the specified id doesn't point to a valid hub site, you will get a ResourceNotFoundException error.
35
+
36
+ ## Examples
37
+
38
+ Disconnect a specific hub site with id from its parent hub site
39
+
40
+ ```sh
41
+ m365 spo hubsite disconnect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
42
+ ```
43
+
44
+ Disconnect a specific hub site with url from its parent hub site
45
+
46
+ ```sh
47
+ m365 spo hubsite disconnect --url https://contoso.sharepoint.com/sites/project-x
48
+ ```
49
+
50
+ Disconnect a specific hub site with title from its parent hub site
51
+
52
+ ```sh
53
+ m365 spo hubsite disconnect --title "My hub site"
54
+ ```
55
+
56
+ ## Response
57
+
58
+ The command won't return a response on success.
@@ -17,8 +17,8 @@ m365 spo hubsite register [options]
17
17
 
18
18
  ## Remarks
19
19
 
20
- !!! attention
21
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
20
+ !!! important
21
+ To use this command you must be a Global or SharePoint administrator.
22
22
 
23
23
  If the specified site collection is already registered as a hub site, you will get a `This site is already a HubSite.` error.
24
24
 
@@ -20,8 +20,8 @@ m365 spo hubsite unregister [options]
20
20
 
21
21
  ## Remarks
22
22
 
23
- !!! attention
24
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
23
+ !!! important
24
+ To use this command you must be a Global or SharePoint administrator.
25
25
 
26
26
  If the specified site collection is not registered as a hub site, you will get a `hubSiteId` error.
27
27
 
@@ -11,31 +11,31 @@ m365 spo list roleassignment add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list 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
  `--principalId [principalId]`
26
- : 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.
26
+ : 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.
27
27
 
28
28
  `--upn [upn]`
29
- : Upn/email of user to assign role to. Specify either upn or principalId
29
+ : Upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
30
30
 
31
31
  `--groupName [groupName]`
32
- : Enter group name of Azure AD or SharePoint group.. Specify either groupName or principalId
32
+ : Enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
33
33
 
34
34
  `--roleDefinitionId [roleDefinitionId]`
35
- : ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
35
+ : ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
36
36
 
37
37
  `--roleDefinitionName [roleDefinitionName]`
38
- : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
38
+ : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
@@ -11,28 +11,28 @@ m365 spo list roleassignment remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list 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
  `--principalId [principalId]`
26
- : 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.
26
+ : SharePoint ID of principal it may be either user id or group id you want to remove permissions. Specify either `principalId`, `upn`, or `groupName` but not multiple.
27
27
 
28
28
  `--upn [upn]`
29
- : upn/email of user. Specify either upn or principalId.
29
+ : upn/email of user. Specify either `principalId`, `upn`, or `groupName` but not multiple.
30
30
 
31
31
  `--groupName [groupName]`
32
- : enter group name of Azure AD or SharePoint group. Specify either groupName or principalId.
32
+ : enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
33
33
 
34
34
  `--confirm`
35
- : Don't prompt for confirming removing the role assignment
35
+ : Don't prompt for confirming removing the role assignment.
36
36
 
37
37
  --8<-- "docs/cmd/_global.md"
38
38
 
@@ -10,14 +10,20 @@ m365 spo list set [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : Id of the list to update
15
-
16
13
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the list to update is located
14
+ : URL of the site
15
+
16
+ `--id [id]`
17
+ : ID of the list. Specify either id, title or url but not multiple.
18
+
19
+ `--title [title]`
20
+ : Title of the list. Specify either id, title or url but not multiple.
21
+
22
+ `--url [url]`
23
+ : Relative URL of the list. Specify either id, title or url but not multiple.
18
24
 
19
- `-t, --title [title]`
20
- : The displayed title for the list
25
+ `--newTitle [newTitle]`
26
+ : New title for the list
21
27
 
22
28
  `--allowDeletion [allowDeletion]`
23
29
  : Boolean value specifying whether the list can be deleted. Valid values are `true,false`
@@ -221,6 +227,12 @@ Enable content types and versioning in the list with id _3EA5A977-315E-4E25-8B0F
221
227
  m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --id 3EA5A977-315E-4E25-8B0F-E4F949BF6B8F --contentTypesEnabled true --enableVersioning true --majorVersionLimit 50 --majorWithMinorVersionsLimit 100
222
228
  ```
223
229
 
230
+ Update the Title of a list retrieved by it's original Title
231
+
232
+ ```sh
233
+ m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --title Documents --newTitle 'Different Title'
234
+ ```
235
+
224
236
  ## More information
225
237
 
226
238
  - SPList Class Members information: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx)
@@ -14,10 +14,13 @@ m365 spo list view field add [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
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -50,8 +53,15 @@ Add field with title _Custom field_ to view with title _All Documents_ of the li
50
53
  m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field'
51
54
  ```
52
55
 
53
- Add field with title _Custom field_ at the position _0_ to view with title _All Documents_ of the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
56
+ Add field with title _Custom field_ at the position _0_ to view with title _My Events_ of the 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 field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'My Events' --title 'Custom field' --fieldPosition 0
60
+ ```
61
+
62
+ Add field with title _Custom field_ to view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
63
 
55
64
  ```sh
56
- m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 0
65
+ m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field'
57
66
  ```
67
+
@@ -14,10 +14,13 @@ m365 spo list view field remove [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
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -46,3 +49,9 @@ Remove field with title _Custom field_ from view with title _Custom view_ from t
46
49
  ```sh
47
50
  m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --title 'Custom field' --listTitle Documents --viewTitle 'Custom view'
48
51
  ```
52
+
53
+ Remove field with title _Custom field_ from view with title _Custom view_ from the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
+
55
+ ```sh
56
+ m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --fieldTitle 'Custom field' --listUrl '/sites/project-x/lists/Events' --viewTitle 'Custom view'
57
+ ```
@@ -14,10 +14,13 @@ m365 spo list view field 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
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -49,3 +52,16 @@ Move field with title _Custom field_ to position _1_ in view with title _All Doc
49
52
  ```sh
50
53
  m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 1
51
54
  ```
55
+
56
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the 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 field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
60
+ ```
61
+
62
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
63
+
64
+ ```sh
65
+ m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
66
+ ```
67
+