@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.289ab69

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 (225) hide show
  1. package/.eslintrc.js +2 -0
  2. package/README.md +6 -1
  3. package/dist/Command.js +6 -0
  4. package/dist/chili/chili.js +298 -0
  5. package/dist/chili/index.js +20 -0
  6. package/dist/cli/Cli.js +2 -2
  7. package/dist/m365/aad/commands/user/user-add.js +30 -21
  8. package/dist/m365/app/commands/permission/permission-add.js +279 -0
  9. package/dist/m365/app/commands.js +1 -0
  10. package/dist/m365/commands/commands.js +2 -0
  11. package/dist/m365/commands/docs.js +42 -0
  12. package/dist/m365/commands/login.js +1 -1
  13. package/dist/m365/commands/setup.js +180 -0
  14. package/dist/m365/commands/setupPresets.js +25 -0
  15. package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
  16. package/dist/m365/pa/commands.js +1 -0
  17. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
  18. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
  19. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
  20. package/dist/m365/purview/commands.js +3 -0
  21. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.17.2.js +25 -0
  22. package/dist/m365/spfx/commands/project/project-doctor/rules/FN001035_DEP_fluentui_react.js +18 -0
  23. package/dist/m365/spfx/commands/project/project-doctor/rules/FN021009_PKG_no_duplicate_oui_deps.js +11 -4
  24. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN001035_DEP_fluentui_react.js +18 -0
  26. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +2 -0
  27. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.2.js +61 -0
  28. package/dist/m365/spfx/commands/project/project-upgrade.js +2 -1
  29. package/dist/m365/spfx/commands/spfx-doctor.js +29 -30
  30. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-remove.js +146 -0
  31. package/dist/m365/spo/commands/file/file-list.js +15 -4
  32. package/dist/m365/spo/commands/file/file-remove.js +3 -0
  33. package/dist/m365/spo/commands/list/list-get.js +30 -3
  34. package/dist/m365/spo/commands/list/list-list.js +39 -2
  35. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +308 -0
  36. package/dist/m365/spo/commands/page/page-section-add.js +2 -3
  37. package/dist/m365/spo/commands/site/site-recyclebinitem-move.js +119 -0
  38. package/dist/m365/spo/commands/site/site-recyclebinitem-remove.js +106 -0
  39. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +30 -39
  40. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-list.js +47 -0
  41. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-remove.js +151 -0
  42. package/dist/m365/spo/commands/tenant/tenant-commandset-remove.js +152 -0
  43. package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +203 -0
  44. package/dist/m365/spo/commands/term/term-add.js +13 -4
  45. package/dist/m365/spo/commands/term/term-get.js +14 -5
  46. package/dist/m365/spo/commands/term/term-group-get.js +12 -3
  47. package/dist/m365/spo/commands/term/term-group-list.js +39 -4
  48. package/dist/m365/spo/commands/term/term-list.js +18 -9
  49. package/dist/m365/spo/commands/term/term-set-add.js +13 -4
  50. package/dist/m365/spo/commands/term/term-set-get.js +12 -3
  51. package/dist/m365/spo/commands/term/term-set-list.js +12 -3
  52. package/dist/m365/spo/commands.js +9 -0
  53. package/dist/m365/teams/commands/chat/chat-member-remove.js +137 -0
  54. package/dist/m365/teams/commands.js +1 -0
  55. package/dist/utils/formatting.js +35 -11
  56. package/dist/utils/pid.js +5 -0
  57. package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
  58. package/docs/docs/cmd/aad/user/user-add.md +4 -0
  59. package/docs/docs/cmd/aad/user/user-set.md +2 -2
  60. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +13 -13
  61. package/docs/docs/cmd/app/app-get.md +25 -6
  62. package/docs/docs/cmd/app/app-open.md +8 -2
  63. package/docs/docs/cmd/app/permission/permission-add.md +53 -0
  64. package/docs/docs/cmd/app/permission/permission-list.md +19 -19
  65. package/docs/docs/cmd/booking/business/business-get.md +30 -8
  66. package/docs/docs/cmd/booking/business/business-list.md +17 -8
  67. package/docs/docs/cmd/cli/cli-consent.md +6 -0
  68. package/docs/docs/cmd/cli/cli-doctor.md +17 -0
  69. package/docs/docs/cmd/cli/cli-issue.md +6 -0
  70. package/docs/docs/cmd/cli/cli-reconsent.md +6 -0
  71. package/docs/docs/cmd/cli/completion/completion-sh-setup.md +6 -0
  72. package/docs/docs/cmd/cli/config/config-get.md +6 -0
  73. package/docs/docs/cmd/docs.md +51 -0
  74. package/docs/docs/cmd/flow/environment/environment-list.md +18 -0
  75. package/docs/docs/cmd/flow/flow-get.md +20 -0
  76. package/docs/docs/cmd/flow/flow-list.md +17 -0
  77. package/docs/docs/cmd/graph/changelog/changelog-list.md +52 -0
  78. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +61 -0
  79. package/docs/docs/cmd/graph/schemaextension/schemaextension-get.md +61 -0
  80. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.md +61 -0
  81. package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.md +4 -0
  82. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -0
  83. package/docs/docs/cmd/graph/subscription/subscription-add.md +73 -0
  84. package/docs/docs/cmd/login.md +1 -1
  85. package/docs/docs/cmd/onedrive/onedrive-list.md +225 -0
  86. package/docs/docs/cmd/onedrive/report/report-activityfilecounts.md +39 -0
  87. package/docs/docs/cmd/onedrive/report/report-activityusercounts.md +39 -0
  88. package/docs/docs/cmd/onedrive/report/report-activityuserdetail.md +43 -0
  89. package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.md +38 -0
  90. package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.md +43 -0
  91. package/docs/docs/cmd/onedrive/report/report-usagefilecounts.md +38 -0
  92. package/docs/docs/cmd/onedrive/report/report-usagestorage.md +37 -0
  93. package/docs/docs/cmd/onenote/notebook/notebook-list.md +79 -0
  94. package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
  95. package/docs/docs/cmd/planner/plan/plan-get.md +1 -1
  96. package/docs/docs/cmd/planner/plan/plan-list.md +1 -1
  97. package/docs/docs/cmd/planner/roster/roster-add.md +2 -1
  98. package/docs/docs/cmd/planner/roster/roster-get.md +1 -1
  99. package/docs/docs/cmd/planner/roster/roster-remove.md +2 -1
  100. package/docs/docs/cmd/planner/task/task-get.md +0 -6
  101. package/docs/docs/cmd/planner/task/task-set.md +1 -1
  102. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +6 -7
  103. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +6 -7
  104. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +4 -4
  105. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +4 -4
  106. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +10 -10
  107. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +11 -11
  108. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +10 -10
  109. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +10 -10
  110. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +10 -10
  111. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -12
  112. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +8 -9
  113. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +8 -9
  114. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +8 -8
  115. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +8 -8
  116. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
  117. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
  118. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
  119. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +17 -0
  120. package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +17 -0
  121. package/docs/docs/cmd/setup.md +86 -0
  122. package/docs/docs/cmd/spfx/project/project-doctor.md +1 -1
  123. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  124. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +1 -1
  125. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.md +77 -0
  126. package/docs/docs/cmd/spo/commandset/commandset-set.md +1 -1
  127. package/docs/docs/cmd/spo/contenttype/contenttype-set.md +2 -2
  128. package/docs/docs/cmd/spo/customaction/customaction-add.md +1 -1
  129. package/docs/docs/cmd/spo/customaction/customaction-set.md +1 -1
  130. package/docs/docs/cmd/spo/file/file-list.md +9 -6
  131. package/docs/docs/cmd/spo/file/file-remove.md +12 -0
  132. package/docs/docs/cmd/spo/folder/folder-copy.md +1 -1
  133. package/docs/docs/cmd/spo/list/list-get.md +10 -0
  134. package/docs/docs/cmd/spo/list/list-list.md +28 -0
  135. package/docs/docs/cmd/spo/listitem/listitem-batch-set.md +67 -0
  136. package/docs/docs/cmd/spo/listitem/listitem-list.md +1 -1
  137. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +19 -0
  138. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +12 -0
  139. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +6 -0
  140. package/docs/docs/cmd/spo/page/page-column-get.md +15 -0
  141. package/docs/docs/cmd/spo/page/page-column-list.md +16 -0
  142. package/docs/docs/cmd/spo/page/page-control-get.md +18 -0
  143. package/docs/docs/cmd/spo/page/page-control-list.md +18 -0
  144. package/docs/docs/cmd/spo/page/page-copy.md +35 -0
  145. package/docs/docs/cmd/spo/page/page-get.md +39 -0
  146. package/docs/docs/cmd/spo/page/page-list.md +53 -0
  147. package/docs/docs/cmd/spo/page/page-section-get.md +12 -0
  148. package/docs/docs/cmd/spo/page/page-section-list.md +13 -0
  149. package/docs/docs/cmd/spo/page/page-template-list.md +31 -0
  150. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +6 -0
  151. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +13 -0
  152. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +7 -0
  153. package/docs/docs/cmd/spo/report/report-activitypages.md +7 -0
  154. package/docs/docs/cmd/spo/report/report-activityusercounts.md +7 -0
  155. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +7 -0
  156. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +7 -0
  157. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +7 -0
  158. package/docs/docs/cmd/spo/report/report-siteusagepages.md +7 -0
  159. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +7 -0
  160. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +7 -0
  161. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +20 -0
  162. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +20 -0
  163. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +20 -0
  164. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +18 -0
  165. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +20 -0
  166. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +17 -0
  167. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +13 -0
  168. package/docs/docs/cmd/spo/site/site-recyclebinitem-move.md +43 -0
  169. package/docs/docs/cmd/spo/site/site-recyclebinitem-remove.md +45 -0
  170. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +1 -1
  171. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.md +103 -0
  172. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.md +49 -0
  173. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.md +49 -0
  174. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.md +57 -0
  175. package/docs/docs/cmd/spo/term/term-add.md +107 -6
  176. package/docs/docs/cmd/spo/term/term-get.md +111 -10
  177. package/docs/docs/cmd/spo/term/term-group-get.md +71 -5
  178. package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
  179. package/docs/docs/cmd/spo/term/term-list.md +80 -8
  180. package/docs/docs/cmd/spo/term/term-set-add.md +95 -11
  181. package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
  182. package/docs/docs/cmd/spo/term/term-set-list.md +85 -5
  183. package/docs/docs/cmd/teams/app/app-list.md +17 -0
  184. package/docs/docs/cmd/teams/app/app-publish.md +18 -1
  185. package/docs/docs/cmd/teams/channel/channel-add.md +20 -0
  186. package/docs/docs/cmd/teams/channel/channel-get.md +21 -0
  187. package/docs/docs/cmd/teams/channel/channel-list.md +21 -0
  188. package/docs/docs/cmd/teams/channel/channel-member-list.md +20 -0
  189. package/docs/docs/cmd/teams/channel/channel-member-set.md +21 -0
  190. package/docs/docs/cmd/teams/chat/chat-get.md +22 -0
  191. package/docs/docs/cmd/teams/chat/chat-list.md +22 -0
  192. package/docs/docs/cmd/teams/chat/chat-member-list.md +20 -0
  193. package/docs/docs/cmd/teams/chat/chat-member-remove.md +52 -0
  194. package/docs/docs/cmd/teams/chat/chat-message-list.md +23 -0
  195. package/docs/docs/cmd/teams/funsettings/funsettings-list.md +15 -0
  196. package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +13 -0
  197. package/docs/docs/cmd/teams/membersettings/membersettings-list.md +17 -0
  198. package/docs/docs/cmd/teams/tab/tab-remove.md +1 -1
  199. package/docs/docs/cmd/todo/list/list-add.md +18 -0
  200. package/docs/docs/cmd/todo/list/list-get.md +18 -0
  201. package/docs/docs/cmd/todo/list/list-list.md +18 -0
  202. package/docs/docs/cmd/todo/task/task-get.md +21 -0
  203. package/docs/docs/cmd/todo/task/task-list.md +21 -0
  204. package/docs/docs/cmd/util/accesstoken/accesstoken-get.md +6 -0
  205. package/docs/docs/cmd/version.md +1 -1
  206. package/docs/docs/cmd/viva/connections/connections-app-create.md +3 -3
  207. package/docs/docs/cmd/yammer/group/group-list.md +42 -0
  208. package/docs/docs/cmd/yammer/message/message-add.md +32 -0
  209. package/docs/docs/cmd/yammer/message/message-get.md +32 -0
  210. package/docs/docs/cmd/yammer/message/message-list.md +34 -0
  211. package/docs/docs/cmd/yammer/network/network-list.md +70 -0
  212. package/docs/docs/cmd/yammer/report/report-activitycounts.md +7 -0
  213. package/docs/docs/cmd/yammer/report/report-activityusercounts.md +7 -0
  214. package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +7 -0
  215. package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +7 -0
  216. package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +7 -0
  217. package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +7 -0
  218. package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +7 -0
  219. package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +7 -0
  220. package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +7 -0
  221. package/docs/docs/cmd/yammer/user/user-get.md +55 -0
  222. package/docs/docs/cmd/yammer/user/user-list.md +55 -0
  223. package/docs/docs/cmd/yammer/yammer-search.md +15 -3
  224. package/npm-shrinkwrap.json +3 -2
  225. package/package.json +2 -1
@@ -10,23 +10,26 @@ m365 spo term get [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to get a term from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `-i, --id [id]`
14
- : ID of the term to retrieve. Specify `name` or `id` but not both
17
+ : ID of the term to retrieve. Specify `name` or `id` but not both.
15
18
 
16
19
  `-n, --name [name]`
17
- : Name of the term to retrieve. Specify `name` or `id` but not both
20
+ : Name of the term to retrieve. Specify `name` or `id` but not both.
18
21
 
19
22
  `--termGroupId [termGroupId]`
20
- : ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
23
+ : ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
21
24
 
22
25
  `--termGroupName [termGroupName]`
23
- : Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
26
+ : Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
24
27
 
25
28
  `--termSetId [termSetId]`
26
- : ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both
29
+ : ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
27
30
 
28
31
  `--termSetName [termSetName]`
29
- : Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both
32
+ : Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -35,24 +38,122 @@ m365 spo term get [options]
35
38
  When retrieving term by its ID, it's sufficient to specify just the ID. When retrieving it by its name however, you need to specify the parent term group and term set using either their names or IDs.
36
39
 
37
40
  !!! important
38
- To use this command you have to have permissions to access the tenant admin site.
41
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
39
42
 
43
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term from the tenant term store as well as a term from the sitecollection term store.
44
+
40
45
  ## Examples
41
46
 
42
- Get information about a taxonomy term using its ID
47
+ Get information about a taxonomy term using its ID from the specified sitecollection.
48
+
49
+ ```sh
50
+ m365 spo term get --webUrl https://contoso.sharepoint.com/sites/project-x --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
51
+ ```
52
+
53
+ Get information about a taxonomy term using its ID.
43
54
 
44
55
  ```sh
45
56
  m365 spo term get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
46
57
  ```
47
58
 
48
- Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names
59
+ Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names.
49
60
 
50
61
  ```sh
51
62
  m365 spo term get --name IT --termGroupName People --termSetName Department
52
63
  ```
53
64
 
54
- Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs
65
+ Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs.
55
66
 
56
67
  ```sh
57
68
  m365 spo term get --name IT --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f
58
69
  ```
70
+
71
+ ## Response
72
+
73
+ === "JSON"
74
+
75
+ ```json
76
+ {
77
+ "CreatedDate": "2021-07-07T09:42:02.283Z",
78
+ "Id": "2b5c71a6-d72b-49a8-a3bf-d80636d85b44",
79
+ "LastModifiedDate": "2021-07-07T09:42:02.283Z",
80
+ "Name": "IT",
81
+ "CustomProperties": {},
82
+ "CustomSortOrder": null,
83
+ "IsAvailableForTagging": true,
84
+ "Owner": "NT Service\\SPTimerV4",
85
+ "Description": "",
86
+ "IsDeprecated": false,
87
+ "IsKeyword": false,
88
+ "IsPinned": false,
89
+ "IsPinnedRoot": false,
90
+ "IsReused": false,
91
+ "IsRoot": true,
92
+ "IsSourceTerm": true,
93
+ "LocalCustomProperties": {},
94
+ "MergedTermIds": [],
95
+ "PathOfTerm": "IT",
96
+ "TermsCount": 1
97
+ }
98
+ ```
99
+
100
+ === "Text"
101
+
102
+ ```text
103
+ CreatedDate : 2021-07-07T09:42:02.283Z
104
+ CustomProperties : {}
105
+ CustomSortOrder : null
106
+ Description :
107
+ Id : 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
108
+ IsAvailableForTagging: true
109
+ IsDeprecated : false
110
+ IsKeyword : false
111
+ IsPinned : false
112
+ IsPinnedRoot : false
113
+ IsReused : false
114
+ IsRoot : true
115
+ IsSourceTerm : true
116
+ LastModifiedDate : 2021-07-07T09:42:02.283Z
117
+ LocalCustomProperties: {}
118
+ MergedTermIds : []
119
+ Name : IT
120
+ Owner : NT Service\SPTimerV4
121
+ PathOfTerm : IT
122
+ TermsCount : 1
123
+ ```
124
+
125
+ === "CSV"
126
+
127
+ ```csv
128
+ CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Description,IsDeprecated,IsKeyword,IsPinned,IsPinnedRoot,IsReused,IsRoot,IsSourceTerm,PathOfTerm,TermsCount
129
+ 2021-07-07T09:42:02.283Z,2b5c71a6-d72b-49a8-a3bf-d80636d85b44,2021-07-07T09:42:02.283Z,IT,1,NT Service\SPTimerV4,,,,,,,1,1,IT,1
130
+ ```
131
+
132
+ === "Markdown"
133
+
134
+ ```md
135
+ # spo term get --termGroupName "People" --termSetName "Department" --name "IT"
136
+
137
+ Date: 5/8/2023
138
+
139
+ ## IT (2b5c71a6-d72b-49a8-a3bf-d80636d85b44)
140
+
141
+ Property | Value
142
+ ---------|-------
143
+ CreatedDate | 2021-07-07T09:42:02.283Z
144
+ Id | 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
145
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
146
+ Name | IT
147
+ IsAvailableForTagging | true
148
+ Owner | NT Service\SPTimerV4
149
+ Description |
150
+ IsDeprecated | false
151
+ IsKeyword | false
152
+ IsPinned | false
153
+ IsPinnedRoot | false
154
+ IsReused | false
155
+ IsRoot | true
156
+ IsSourceTerm | true
157
+ PathOfTerm | IT
158
+ TermsCount | 1
159
+ ```
@@ -10,29 +10,95 @@ m365 spo term group get [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to get a term group from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `-i, --id [id]`
14
- : ID of the term group to retrieve. Specify `name` or `id` but not both
17
+ : ID of the term group to retrieve. Specify `name` or `id` but not both.
15
18
 
16
19
  `-n, --name [name]`
17
- : Name of the term group to retrieve. Specify `name` or `id` but not both
20
+ : Name of the term group to retrieve. Specify `name` or `id` but not both.
18
21
 
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Remarks
22
25
 
23
26
  !!! important
24
- To use this command you have to have permissions to access the tenant admin site.
27
+ To use this command without the `--webUrl` option you have to have permissions to access the tenant admin site.
28
+
29
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term group from the tenant term store as well as a term group from the sitecollection term store.
25
30
 
26
31
  ## Examples
27
32
 
28
- Get information about a taxonomy term group using its ID
33
+ Get information about a taxonomy term group using its ID.
29
34
 
30
35
  ```sh
31
36
  m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
32
37
  ```
33
38
 
34
- Get information about a taxonomy term group using its name
39
+ Get information about a taxonomy term group using its name.
35
40
 
36
41
  ```sh
37
42
  m365 spo term group get --name PnPTermSets
38
43
  ```
44
+
45
+ Get information about a taxonomy term group from the specified sitecollection using its ID.
46
+
47
+ ```sh
48
+ m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x
49
+ ```
50
+
51
+ ## Response
52
+
53
+ === "JSON"
54
+
55
+ ```json
56
+ {
57
+ "CreatedDate": "2019-09-03T06:41:32.070Z",
58
+ "Id": "0e8f395e-ff58-4d45-9ff7-e331ab728beb",
59
+ "LastModifiedDate": "2019-09-03T06:41:32.070Z",
60
+ "Name": "PnPTermSets",
61
+ "Description": "",
62
+ "IsSiteCollectionGroup": false,
63
+ "IsSystemGroup": false
64
+ }
65
+ ```
66
+
67
+ === "Text"
68
+
69
+ ```text
70
+ CreatedDate : 2019-09-03T06:41:32.070Z
71
+ Description :
72
+ Id : 0e8f395e-ff58-4d45-9ff7-e331ab728beb
73
+ IsSiteCollectionGroup: false
74
+ IsSystemGroup : false
75
+ LastModifiedDate : 2019-09-03T06:41:32.070Z
76
+ Name : PnPTermSets
77
+ ```
78
+
79
+ === "CSV"
80
+
81
+ ```csv
82
+ CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
83
+ 2019-09-03T06:41:32.070Z,0e8f395e-ff58-4d45-9ff7-e331ab728beb,2019-09-03T06:41:32.070Z,PnPTermSets,,,
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo term group get --id "0e8f395e-ff58-4d45-9ff7-e331ab728beb"
90
+
91
+ Date: 5/14/2023
92
+
93
+ ## PnPTermSets (0e8f395e-ff58-4d45-9ff7-e331ab728beb)
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ CreatedDate | 2019-09-03T06:41:32.070Z
98
+ Id | 0e8f395e-ff58-4d45-9ff7-e331ab728beb
99
+ LastModifiedDate | 2019-09-03T06:41:32.070Z
100
+ Name | PnPTermSets
101
+ Description |
102
+ IsSiteCollectionGroup | false
103
+ IsSystemGroup | false
104
+ ```
@@ -10,17 +10,85 @@ m365 spo term group list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to list term groups from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  --8<-- "docs/cmd/_global.md"
14
17
 
15
18
  ## Remarks
16
19
 
17
20
  !!! important
18
- To use this command you have to have permissions to access the tenant admin site.
21
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
22
+
23
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to list term groups from the tenant term store as well as term groups from the sitecollection term store.
19
24
 
20
25
  ## Examples
21
26
 
22
- List taxonomy term groups
27
+ List taxonomy term groups.
23
28
 
24
29
  ```sh
25
30
  m365 spo term group list
26
31
  ```
32
+
33
+ List taxonomy term groups from the specified sitecollection.
34
+
35
+ ```sh
36
+ m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x
37
+ ```
38
+
39
+ ## Response
40
+
41
+ === "JSON"
42
+
43
+ ```json
44
+ [
45
+ {
46
+ "_ObjectType_": "SP.Taxonomy.TermGroup",
47
+ "_ObjectIdentity_": "5522b1a0-b01a-2000-4160-d04eee2e977f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=",
48
+ "CreatedDate": "2019-09-03T06:41:32.070Z",
49
+ "Id": "4aa9cd7a-d275-4fda-84b2-b83085dcee0f",
50
+ "LastModifiedDate": "2019-09-03T06:41:32.070Z",
51
+ "Name": "People",
52
+ "Description": "",
53
+ "IsSiteCollectionGroup": false,
54
+ "IsSystemGroup": false
55
+ }
56
+ ]
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```text
62
+ Id Name
63
+ ------------------------------------ -----------------------------------------------------------
64
+ 4aa9cd7a-d275-4fda-84b2-b83085dcee0f People
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ _ObjectType_,_ObjectIdentity_,CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
71
+ SP.Taxonomy.TermGroup,7522b1a0-804d-2000-41be-bba084eae72f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=,2019-09-03T06:41:32.070Z,4aa9cd7a-d275-4fda-84b2-b83085dcee0f,2019-09-03T06:41:32.070Z,People,,,
72
+ ```
73
+
74
+ === "Markdown"
75
+
76
+ ```md
77
+ # spo term group list
78
+
79
+ Date: 5/9/2023
80
+
81
+ ## People (4aa9cd7a-d275-4fda-84b2-b83085dcee0f)
82
+
83
+ Property | Value
84
+ ---------|-------
85
+ \_ObjectType\_ | SP.Taxonomy.TermGroup
86
+ \_ObjectIdentity\_ | 8c22b1a0-200f-2000-3976-694ba2bf8a01\|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=
87
+ CreatedDate | 2019-09-03T06:41:32.070Z
88
+ Id | 4aa9cd7a-d275-4fda-84b2-b83085dcee0f
89
+ LastModifiedDate | 2019-09-03T06:41:32.070Z
90
+ Name | People
91
+ Description |
92
+ IsSiteCollectionGroup | false
93
+ IsSystemGroup | false
94
+ ```
@@ -10,17 +10,20 @@ m365 spo term list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-u, --webUrl [webUrl]`
14
+ : If specified, allows you to list terms from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
+
13
16
  `--termGroupId [termGroupId]`
14
- : ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
17
+ : ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
15
18
 
16
19
  `--termGroupName [termGroupName]`
17
- : Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
20
+ : Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
18
21
 
19
22
  `--termSetId [termSetId]`
20
- : ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
23
+ : ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
21
24
 
22
25
  `--termSetName [termSetName]`
23
- : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
26
+ : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
24
27
 
25
28
  `--includeChildTerms`
26
29
  : If specified, child terms are loaded as well.
@@ -30,23 +33,31 @@ m365 spo term list [options]
30
33
  ## Remarks
31
34
 
32
35
  !!! important
33
- To use this command you have to have permissions to access the tenant admin site.
36
+ To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
37
+
38
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to list terms from the tenant term store as well as terms from the sitecollection term store.
34
39
 
35
40
  ## Examples
36
41
 
37
- List taxonomy terms from the term group and term set with the given name
42
+ List taxonomy terms from the specified sitecollection, the term group and term set with the given name
43
+
44
+ ```sh
45
+ m365 spo term list --webUrl https://contoso.sharepoint.com/sites/project-x --termGroupName PnPTermSets --termSetName PnP-Organizations
46
+ ```
47
+
48
+ List taxonomy terms from the term group and term set with the given name.
38
49
 
39
50
  ```sh
40
51
  m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations
41
52
  ```
42
53
 
43
- List taxonomy terms from the term group and term set with the given ID
54
+ List taxonomy terms from the term group and term set with the given ID.
44
55
 
45
56
  ```sh
46
57
  m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
47
58
  ```
48
59
 
49
- List taxonomy terms from the term group and term set with the given ID including child terms if any are found
60
+ List taxonomy terms from the term group and term set with the given ID including child terms if any are found.
50
61
 
51
62
  ```sh
52
63
  m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
@@ -104,6 +115,37 @@ m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetI
104
115
  c387e91c-b553-4b92-886b-9af717cd73b0,Financing
105
116
  ```
106
117
 
118
+ === "Markdown"
119
+
120
+ ```md
121
+ # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations"
122
+
123
+ Date: 5/8/2023
124
+
125
+ ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
126
+
127
+ Property | Value
128
+ ---------|-------
129
+ \_ObjectType\_ | SP.Taxonomy.Term
130
+ \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
131
+ CreatedDate | 2021-07-07T09:42:02.283Z
132
+ Id | c387e91c-b553-4b92-886b-9af717cd73b0
133
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
134
+ Name | Financing
135
+ IsAvailableForTagging | true
136
+ Owner | NT Service\SPTimerV4
137
+ Description |
138
+ IsDeprecated | false
139
+ IsKeyword | false
140
+ IsPinned | false
141
+ IsPinnedRoot | false
142
+ IsReused | false
143
+ IsRoot | true
144
+ IsSourceTerm | true
145
+ PathOfTerm | Financing
146
+ TermsCount | 0
147
+ ```
148
+
107
149
  ### `includeChildTerms` response
108
150
 
109
151
  When we make use of the option `includeChildTerms` the response will differ.
@@ -180,3 +222,33 @@ When we make use of the option `includeChildTerms` the response will differ.
180
222
  c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
181
223
  ```
182
224
 
225
+ === "Markdown"
226
+
227
+ ```md
228
+ # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations" --includeChildTerms "true"
229
+
230
+ Date: 5/8/2023
231
+
232
+ ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
233
+
234
+ Property | Value
235
+ ---------|-------
236
+ \_ObjectType\_ | SP.Taxonomy.Term
237
+ \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
238
+ CreatedDate | 2021-07-07T09:42:02.283Z
239
+ Id | c387e91c-b553-4b92-886b-9af717cd73b0
240
+ LastModifiedDate | 2021-07-07T09:42:02.283Z
241
+ Name | Financing
242
+ IsAvailableForTagging | true
243
+ Owner | NT Service\SPTimerV4
244
+ Description |
245
+ IsDeprecated | false
246
+ IsKeyword | false
247
+ IsPinned | false
248
+ IsPinnedRoot | false
249
+ IsReused | false
250
+ IsRoot | true
251
+ IsSourceTerm | true
252
+ PathOfTerm | Financing
253
+ TermsCount | 0
254
+ ```
@@ -11,22 +11,25 @@ m365 spo term set add [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --name <name>`
14
- : Name of the term set to add
14
+ : Name of the term set to add.
15
+
16
+ `-u, --webUrl [webUrl]`
17
+ : If specified, allows you to add a term set to the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
15
18
 
16
19
  `--termGroupId [termGroupId]`
17
- : ID of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both
20
+ : ID of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both.
18
21
 
19
22
  `--termGroupName [termGroupName]`
20
- : Name of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both
23
+ : Name of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both.
21
24
 
22
25
  `-i, --id [id]`
23
- : ID of the term set to add
26
+ : ID of the term set to add.
24
27
 
25
28
  `-d, --description [description]`
26
- : Description of the term set to add
29
+ : Description of the term set to add.
27
30
 
28
31
  `--customProperties [customProperties]`
29
- : JSON string with key-value pairs representing custom properties to set on the term set
32
+ : JSON string with key-value pairs representing custom properties to set on the term set.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -36,30 +39,111 @@ m365 spo term set add [options]
36
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.
37
40
 
38
41
  !!! important
39
- To use this command you have to have permissions to access the tenant admin site.
42
+ To use this command without the `--webUrl` option you have to have permissions to access the tenant admin site.
43
+
44
+ When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to add a term set to a term group in the tenant term store if you are listed as a term store administrator. It allows you to add a term set to a term group in the sitecollection term store if you are a site owner.
40
45
 
41
46
  ## Examples
42
47
 
43
- Add taxonomy term set to the term group specified by ID
48
+ Add taxonomy term set to the term group specified by ID.
44
49
 
45
50
  ```sh
46
51
  m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb
47
52
  ```
48
53
 
49
- Add taxonomy term set to the term group specified by name. Create the term set with the specified ID
54
+ Add taxonomy term set to the specified sitecollection's term group specified by ID.
55
+
56
+ ```sh
57
+ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x
58
+ ```
59
+
60
+ Add taxonomy term set to the term group specified by name. Create the term set with the specified ID.
50
61
 
51
62
  ```sh
52
63
  m365 spo term set add --name PnP-Organizations --termGroupName PnPTermSets --id aa70ede6-83d1-466d-8d95-30d29e9bbd7c
53
64
  ```
54
65
 
55
- Add taxonomy term set and set its description
66
+ Add taxonomy term set and set its description.
56
67
 
57
68
  ```sh
58
69
  m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --description 'Contains a list of organizations'
59
70
  ```
60
71
 
61
- Add taxonomy term set and set its custom properties
72
+ Add taxonomy term set and set its custom properties.
62
73
 
63
74
  ```sh
64
75
  m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '{"Property":"Value"}'
65
76
  ```
77
+
78
+ ## Response
79
+
80
+ ### Standard response
81
+
82
+ === "JSON"
83
+
84
+ ```json
85
+ {
86
+ "CreatedDate": "2023-05-14T10:28:31.041Z",
87
+ "Id": "c28cfcd2-0705-4b7b-b8e6-ba2fb107e5ec",
88
+ "LastModifiedDate": "2023-05-14T10:28:31.041Z",
89
+ "Name": "PnP-Organizations",
90
+ "CustomProperties": {},
91
+ "CustomSortOrder": null,
92
+ "IsAvailableForTagging": true,
93
+ "Owner": "i:0#.f|membership|john.doe@contoso.com",
94
+ "Contact": "",
95
+ "Description": "",
96
+ "IsOpenForTermCreation": false,
97
+ "Names": {
98
+ "1033": "PnP-Organizations"
99
+ },
100
+ "Stakeholders": []
101
+ }
102
+ ```
103
+
104
+ === "Text"
105
+
106
+ ```text
107
+ Contact :
108
+ CreatedDate : 2023-05-14T10:30:41.018Z
109
+ CustomProperties : {}
110
+ CustomSortOrder : null
111
+ Description :
112
+ Id : 41102744-9f7b-448b-a265-3bbe3db5c064
113
+ IsAvailableForTagging: true
114
+ IsOpenForTermCreation: false
115
+ LastModifiedDate : 2023-05-14T10:30:41.018Z
116
+ Name : PnP-Organizations
117
+ Names : {"1033":"PnP-Organizations"}
118
+ Owner : i:0#.f|membership|john.doe@contoso.com
119
+ Stakeholders : []
120
+ ```
121
+
122
+ === "CSV"
123
+
124
+ ```csv
125
+ CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Contact,Description,IsOpenForTermCreation
126
+ 2023-05-14T10:31:11.299Z,8f212d7d-eeb3-454b-811a-01b38fea56e1,2023-05-14T10:31:11.299Z,PnP-Organizations,1,i:0#.f|membership|john.doe@contoso.com,,,
127
+ ```
128
+
129
+ === "Markdown"
130
+
131
+ ```md
132
+ # spo term set add --name "PnP-Organizations" --termGroupId "0e8f395e-ff58-4d45-9ff7-e331ab728beb"
133
+
134
+ Date: 5/14/2023
135
+
136
+ ## PnP-Organizations (73824553-d254-44ef-ac0f-61926b65e925)
137
+
138
+ Property | Value
139
+ ---------|-------
140
+ CreatedDate | 2023-05-14T10:31:42.422Z
141
+ Id | 73824553-d254-44ef-ac0f-61926b65e925
142
+ LastModifiedDate | 2023-05-14T10:31:42.422Z
143
+ Name | PnP-Organizations
144
+ IsAvailableForTagging | true
145
+ Owner | i:0#.f\|membership\|john.doe@contoso.com
146
+ Contact |
147
+ Description |
148
+ IsOpenForTermCreation | false
149
+ ```