@pnp/cli-microsoft365 6.4.0-beta.6b65014 → 6.4.0-beta.8c5ba0e

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 (158) hide show
  1. package/README.md +12 -1
  2. package/dist/m365/aad/commands/user/user-get.js +3 -0
  3. package/dist/m365/aad/commands/user/user-set.js +3 -0
  4. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  5. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  6. package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +138 -0
  7. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +48 -14
  8. package/dist/m365/purview/commands.js +1 -0
  9. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  10. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  11. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  12. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  13. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  14. package/dist/m365/spo/commands/user/user-ensure.js +105 -0
  15. package/dist/m365/spo/commands.js +2 -0
  16. package/dist/utils/aadUser.js +37 -0
  17. package/dist/utils/md.js +7 -0
  18. package/dist/utils/spo.js +32 -0
  19. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  20. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  21. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  22. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  23. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  24. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  25. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  26. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  27. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  28. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  29. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  30. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  31. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  32. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  33. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  34. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  35. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  36. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  37. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  38. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  39. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  40. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  41. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  42. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  43. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  44. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  45. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  46. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  47. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  48. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  49. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  50. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  51. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  52. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  53. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  54. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  55. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  56. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +149 -0
  57. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  58. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -0
  59. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  60. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  61. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  62. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  63. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  64. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +21 -0
  65. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  66. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  67. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  68. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  69. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  70. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  71. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  72. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  73. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  74. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  75. package/docs/docs/cmd/spo/group/group-member-add.md +22 -0
  76. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  77. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  78. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  79. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  80. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  81. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  82. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  83. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  84. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  85. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  86. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +2 -2
  87. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +1 -1
  88. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  89. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  90. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  91. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  92. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  93. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  94. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  95. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  96. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  97. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  98. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  99. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  100. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  101. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  102. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  103. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  104. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  105. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  106. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  107. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  108. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  109. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  110. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  111. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +2 -0
  112. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  113. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  114. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  115. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  116. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  117. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  118. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  119. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  120. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  121. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  122. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  123. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  124. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  125. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  126. package/docs/docs/cmd/spo/user/user-ensure.md +109 -0
  127. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  128. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  129. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  130. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  131. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  132. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  133. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  134. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  135. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  136. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  137. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  138. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  139. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  140. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  141. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  142. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  143. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  144. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  145. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  146. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  147. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  148. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  149. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  150. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  151. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  152. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  153. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  154. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  155. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  156. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  157. package/npm-shrinkwrap.json +277 -192
  158. package/package.json +13 -13
@@ -18,6 +18,8 @@ m365 spo orgnewssite remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -15,13 +15,13 @@ m365 spo orgnewssite set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-u, --url` option you can specify which site to add to the list of organizational news sites.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Set a site as an organizational news site
@@ -15,6 +15,8 @@ m365 spo site appcatalog add [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,13 +15,13 @@ m365 spo site appcatalog remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  While the command uses the term *'remove'*, like its equivalent PowerShell cmdlet, it does not remove the special library **Apps for SharePoint** from the site collection. Instead, it disables the site collection app catalog in that site. Packages deployed to the app catalog are not available within the site collection.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Remove the site collection app catalog from specified site
@@ -18,6 +18,8 @@ m365 spo site commsite enable [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -27,15 +27,15 @@ m365 spo site list [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Using the `-f, --filter` option you can specify which sites you want to retrieve. For example, to get sites with _project_ in their URL, use `Url -like 'project'` as the filter.
36
33
 
37
34
  When using the text output type, the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
38
35
 
36
+ !!! important
37
+ To use this command you have to have permissions to access the tenant admin site.
38
+
39
39
  ## Examples
40
40
 
41
41
  List all sites in the currently connected tenant
@@ -27,9 +27,6 @@ m365 spo site remove [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
@@ -38,6 +35,9 @@ If the site which you have selected to remove is groupified (Modern Team Site) a
38
35
 
39
36
  If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
40
37
 
38
+ !!! important
39
+ To use this command you have to have permissions to access the tenant admin site.
40
+
41
41
  ## Examples
42
42
 
43
43
  Remove the specified site and place it in the Recycle Bin
@@ -30,13 +30,13 @@ m365 spo site rename [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
- !!! important
34
- To use this command you must have permissions to access the tenant admin site.
35
-
36
33
  ## Remarks
37
34
 
38
35
  Renaming site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the operation to complete fully, you should use the `--wait` flag. When using this flag, the `spo site rename` command will keep running until it receives confirmation from Microsoft 365 that the site rename operation has completed.
39
36
 
37
+ !!! important
38
+ To use this command you must have permissions to access the tenant admin site.
39
+
40
40
  ## Examples
41
41
 
42
42
  Starts the rename of the site collection with name "samplesite" to "renamed" without modifying the title
@@ -69,9 +69,6 @@ m365 spo site set [options]
69
69
 
70
70
  --8<-- "docs/cmd/_global.md"
71
71
 
72
- !!! important
73
- To use this command you have to have permissions to access the tenant admin site.
74
-
75
72
  ## Remarks
76
73
 
77
74
  If the specified url doesn't refer to an existing site collection, you will get a `404 - "404 FILE NOT FOUND"` error.
@@ -94,6 +91,9 @@ For more information on configuring no script sites see [https://support.office.
94
91
 
95
92
  Setting site properties is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully configured, you should use the `--wait` flag. When using this flag, the `spo site set` command will keep running until it received confirmation from Microsoft 365 that the site has been fully configured.
96
93
 
94
+ !!! important
95
+ To use this command you have to have permissions to access the tenant admin site.
96
+
97
97
  ## Examples
98
98
 
99
99
  Update site collection's classification
@@ -159,13 +159,13 @@ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --sharingCapa
159
159
  Set the logo on the site
160
160
 
161
161
  ```sh
162
- m365 spo site set --url https://estruyfdev2.sharepoint.com/sites/sales --siteLogoUrl "/sites/sales/SiteAssets/parker-ms-1200.png"
162
+ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl "/sites/sales/SiteAssets/parker-ms-1200.png"
163
163
  ```
164
164
 
165
165
  Unset the logo on the site
166
166
 
167
167
  ```sh
168
- m365 spo site set --url https://estruyfdev2.sharepoint.com/sites/sales --siteLogoUrl ""
168
+ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl ""
169
169
  ```
170
170
 
171
171
  Lock the site preventing users from accessing it. Wait for the configuration to complete
@@ -21,13 +21,13 @@ m365 spo storageentity remove [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Tenant properties are stored in the app catalog site associated with that tenant. To remove a property, you have to specify the absolute URL of the app catalog site. If you specify the URL of a site different than the app catalog, you will get an access denied error.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Remove the _AnalyticsId_ tenant property. Yields a confirmation prompt before actually removing the property
@@ -27,15 +27,15 @@ m365 spo storageentity set [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Tenant properties are stored in the app catalog site associated with that tenant. To set a property, you have to specify the absolute URL of the app catalog site without a trailing slash. If you specify the URL with trailing slash you get the error `The managed path sites/apps is not a managed path in this tenant.`
36
33
 
37
34
  If you specify the URL of a site different than the app catalog, you will get an access denied error.
38
35
 
36
+ !!! important
37
+ To use this command you have to have permissions to access the tenant admin site.
38
+
39
39
  ## Examples
40
40
 
41
41
  Set _123_ as the value of the _AnalyticsId_ tenant property. Also include a description and a comment for additional clarification of the usage of the property.
@@ -27,9 +27,6 @@ m365 spo tenant appcatalog add [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  If there is an app catalog registered in your tenant, creating a new app catalog using this command will fail, unless you use the `force` option.
@@ -38,6 +35,9 @@ If you use the `force` option, and either the app catalog or the site at the spe
38
35
 
39
36
  Creating an app catalog site might take a while. If you need to wait for the site to be created before continuing, use the `wait` option.
40
37
 
38
+ !!! important
39
+ To use this command you have to have permissions to access the tenant admin site.
40
+
41
41
  ## Examples
42
42
 
43
43
  Creates new app catalog. Will fail if another app catalog or site at the specified URL exists
@@ -12,6 +12,8 @@ m365 spo tenant appcatalogurl get [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -24,9 +24,6 @@ m365 spo tenant applicationcustomizer add [options]
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
27
- !!! important
28
- To use this command, you need to be a SharePoint Admin.
29
-
30
27
  ## Remarks
31
28
 
32
29
  Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
@@ -40,6 +37,9 @@ Note, how the clientSideComponentProperties option has escaped double quotes `'{
40
37
  !!! warning "Escaping JSON in PowerShell"
41
38
  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.
42
39
 
40
+ !!! important
41
+ To use this command, you need to be a SharePoint Admin.
42
+
43
43
  ## Examples
44
44
 
45
45
  Adds an application customizer that's deployed tenant wide
@@ -0,0 +1,142 @@
1
+ # spo tenant applicationcustomizer get
2
+
3
+ Get an application customizer that is installed tenant wide
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ spo tenant applicationcustomizer get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title [title]`
14
+ : The title of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
15
+
16
+ `-i, --id [id]`
17
+ : The product id of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
18
+
19
+ `-c, --clientSideComponentId [clientSideComponentId]`
20
+ : The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Examples
25
+
26
+ Retrieves an application customizer by title.
27
+
28
+ ```sh
29
+ m365 spo tenant applicationcustomizer get --title "Some customizer"
30
+ ```
31
+
32
+ Retrieves an application customizer by id.
33
+
34
+ ```sh
35
+ m365 spo tenant applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337
36
+ ```
37
+
38
+ Retrieves an application customizer by clientSideComponentId.
39
+
40
+ ```sh
41
+ m365 spo tenant applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc
42
+ ```
43
+
44
+ ## Response
45
+
46
+ === "JSON"
47
+
48
+ ```json
49
+ {
50
+ "FileSystemObjectType": 0,
51
+ "Id": 4,
52
+ "ServerRedirectedEmbedUri": null,
53
+ "ServerRedirectedEmbedUrl": "",
54
+ "ContentTypeId": "0x00693E2C487575B448BD420C12CEAE7EFE",
55
+ "Title": "Some customizer",
56
+ "Modified": "2023-01-11T15:47:38Z",
57
+ "Created": "2023-01-11T15:47:38Z",
58
+ "AuthorId": 9,
59
+ "EditorId": 9,
60
+ "OData__UIVersionString": "1.0",
61
+ "Attachments": false,
62
+ "GUID": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
63
+ "ComplianceAssetId": null,
64
+ "TenantWideExtensionComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
65
+ "TenantWideExtensionComponentProperties": "{\"testMessage\":\"Test message\"}",
66
+ "TenantWideExtensionWebTemplate": null,
67
+ "TenantWideExtensionListTemplate": 0,
68
+ "TenantWideExtensionLocation": "ClientSideExtension.ApplicationCustomizer",
69
+ "TenantWideExtensionSequence": 0,
70
+ "TenantWideExtensionHostProperties": null,
71
+ "TenantWideExtensionDisabled": false
72
+ }
73
+ ```
74
+
75
+ === "Text"
76
+
77
+ ```text
78
+ Attachments : false
79
+ AuthorId : 9
80
+ ComplianceAssetId : null
81
+ ContentTypeId : 0x00693E2C487575B448BD420C12CEAE7EFE
82
+ Created : 2023-01-11T15:47:38Z
83
+ EditorId : 9
84
+ FileSystemObjectType : 0
85
+ GUID : 14125658-a9bc-4ddf-9c75-1b5767c9a337
86
+ Id : 4
87
+ Modified : 2023-01-11T15:47:38Z
88
+ OData__UIVersionString : 1.0
89
+ ServerRedirectedEmbedUri : null
90
+ ServerRedirectedEmbedUrl :
91
+ TenantWideExtensionComponentId : 7096cded-b83d-4eab-96f0-df477ed7c0bc
92
+ TenantWideExtensionComponentProperties: {"testMessage":"Test message"}
93
+ TenantWideExtensionDisabled : false
94
+ TenantWideExtensionHostProperties : null
95
+ TenantWideExtensionListTemplate : 0
96
+ TenantWideExtensionLocation : ClientSideExtension.ApplicationCustomizer
97
+ TenantWideExtensionSequence : 0
98
+ TenantWideExtensionWebTemplate : null
99
+ Title : Some customizer
100
+ ```
101
+
102
+ === "CSV"
103
+
104
+ ```csv
105
+ FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,TenantWideExtensionComponentId,TenantWideExtensionComponentProperties,TenantWideExtensionWebTemplate,TenantWideExtensionListTemplate,TenantWideExtensionLocation,TenantWideExtensionSequence,TenantWideExtensionHostProperties,TenantWideExtensionDisabled
106
+ 0,4,,,0x00693E2C487575B448BD420C12CEAE7EFE,Some customizer,2023-01-11T15:47:38Z,2023-01-11T15:47:38Z,9,9,1.0,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,7096cded-b83d-4eab-96f0-df477ed7c0bc,"{""testMessage"":""Test message""}",,0,ClientSideExtension.ApplicationCustomizer,0,,
107
+ ```
108
+
109
+ === "Markdown"
110
+
111
+ ```md
112
+ # spo tenant applicationcustomizer get --title "Some customizer"
113
+
114
+ Date: 1/13/2023
115
+
116
+ ## Some customizer (4)
117
+
118
+ Property | Value
119
+ ---------|-------
120
+ FileSystemObjectType | 0
121
+ Id | 4
122
+ ServerRedirectedEmbedUri | null
123
+ ServerRedirectedEmbedUrl |
124
+ ContentTypeId | 0x00693E2C487575B448BD420C12CEAE7EFE
125
+ Title | Some customizer
126
+ Modified | 2023-01-11T15:47:38Z
127
+ Created | 2023-01-11T15:47:38Z
128
+ AuthorId | 9
129
+ EditorId | 9
130
+ OData\_\_UIVersionString | 1.0
131
+ Attachments | false
132
+ GUID | 14125658-a9bc-4ddf-9c75-1b5767c9a337
133
+ ComplianceAssetId | null
134
+ TenantWideExtensionComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
135
+ TenantWideExtensionComponentProperties | {"testMessage":"Test message"}
136
+ TenantWideExtensionWebTemplate | null
137
+ TenantWideExtensionListTemplate | 0
138
+ TenantWideExtensionLocation | ClientSideExtension.ApplicationCustomizer
139
+ TenantWideExtensionSequence | 0
140
+ TenantWideExtensionHostProperties | null
141
+ TenantWideExtensionDisabled | false
142
+ ```
@@ -12,6 +12,8 @@ m365 spo tenant recyclebinitem list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -21,13 +21,13 @@ m365 spo tenant recyclebinitem remove [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Removing a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully removed, you should use the `--wait` flag. When using this flag, the `m365 spo tenant recyclebinitem remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully removed.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Removes the specified deleted site collection from tenant recycle bin
@@ -18,13 +18,13 @@ m365 spo tenant recyclebinitem restore [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- !!! important
22
- To use this command you have to have permissions to access the tenant admin site.
23
-
24
21
  ## Remarks
25
22
 
26
23
  Restoring deleted site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully restored, you should use the `--wait` flag. When using this flag, the `spo tenant recyclebinitem restore` command will keep running until it received confirmation from Microsoft 365 that the site has been fully restored.
27
24
 
25
+ !!! important
26
+ To use this command you have to have permissions to access the tenant admin site.
27
+
28
28
  ## Examples
29
29
 
30
30
  Restore a deleted site collection from tenant recycle bin
@@ -12,6 +12,8 @@ m365 spo tenant settings list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -264,6 +264,8 @@ m365 spo tenant settings set [options]
264
264
 
265
265
  --8<-- "docs/cmd/_global.md"
266
266
 
267
+ ## Remarks
268
+
267
269
  !!! important
268
270
  To use this command you have to have permission to access the tenant admin site.
269
271
 
@@ -42,14 +42,14 @@ m365 spo term add [options]
42
42
 
43
43
  --8<-- "docs/cmd/_global.md"
44
44
 
45
- !!! important
46
- To use this command you have to have permissions to access the tenant admin site.
47
-
48
45
  ## Remarks
49
46
 
50
47
  !!! warning "Escaping JSON in PowerShell"
51
48
  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
49
 
50
+ !!! important
51
+ To use this command you have to have permissions to access the tenant admin site.
52
+
53
53
  ## Examples
54
54
 
55
55
  Add taxonomy term with the specified name to the term group and term set specified by their names
@@ -30,13 +30,13 @@ m365 spo term get [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
- !!! important
34
- To use this command you have to have permissions to access the tenant admin site.
35
-
36
33
  ## Remarks
37
34
 
38
35
  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.
39
36
 
37
+ !!! important
38
+ To use this command you have to have permissions to access the tenant admin site.
39
+
40
40
  ## Examples
41
41
 
42
42
  Get information about a taxonomy term using its ID
@@ -21,6 +21,8 @@ m365 spo term group add [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
+ ## Remarks
25
+
24
26
  !!! important
25
27
  To use this command you have to have permissions to access the tenant admin site.
26
28
 
@@ -18,6 +18,8 @@ m365 spo term group get [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -12,6 +12,8 @@ m365 spo term group list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -27,6 +27,8 @@ m365 spo term list [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
30
32
  !!! important
31
33
  To use this command you have to have permissions to access the tenant admin site.
32
34
 
@@ -145,7 +147,7 @@ When we make use of the option `includeChildTerms` the response will differ.
145
147
  "CustomProperties": {},
146
148
  "CustomSortOrder": null,
147
149
  "IsAvailableForTagging": true,
148
- "Owner": "i:0#.f|membership|admin@mathijsdev2.onmicrosoft.com",
150
+ "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
149
151
  "Description": "",
150
152
  "IsDeprecated": false,
151
153
  "IsKeyword": false,
@@ -30,14 +30,14 @@ m365 spo term set add [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
- !!! important
34
- To use this command you have to have permissions to access the tenant admin site.
35
-
36
33
  ## Remarks
37
34
 
38
35
  !!! warning "Escaping JSON in PowerShell"
39
36
  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
37
 
38
+ !!! important
39
+ To use this command you have to have permissions to access the tenant admin site.
40
+
41
41
  ## Examples
42
42
 
43
43
  Add taxonomy term set to the term group specified by ID
@@ -24,6 +24,8 @@ m365 spo term set get [options]
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
27
+ ## Remarks
28
+
27
29
  !!! important
28
30
  To use this command you have to have permissions to access the tenant admin site.
29
31
 
@@ -18,6 +18,8 @@ m365 spo term set list [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -21,13 +21,13 @@ m365 spo theme apply [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Following standard SharePoint themes are supported by the CLI for Microsoft 365: Blue, Orange, Red, Purple, Green, Gray, Dark Yellow and Dark Blue.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Apply theme to the specified site
@@ -15,6 +15,8 @@ m365 spo theme get [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -12,6 +12,8 @@ m365 spo theme list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -18,6 +18,8 @@ m365 spo theme remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -21,9 +21,6 @@ m365 spo theme set [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  To prevent the accidental creation of invalid themes the CLI for Microsoft 365 implements a set of checks. These checks are executed against the provided json file. A valid theme JSON file is as follows:
@@ -64,6 +61,9 @@ When executing the `m365 spo theme set` command the following checks are execute
64
61
 
65
62
  If any of these checks fails you are presented with a `The specified theme is not valid` error.
66
63
 
64
+ !!! important
65
+ To use this command you have to have permissions to access the tenant admin site.
66
+
67
67
  ## Examples
68
68
 
69
69
  Add or update a theme from a theme JSON file