@pnp/cli-microsoft365 6.0.0-beta.a008afc → 6.0.0-beta.a2ec37b

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 (161) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/Command.js +16 -2
  3. package/dist/m365/aad/commands/app/app-add.js +36 -13
  4. package/dist/m365/aad/commands/app/app-list.js +38 -0
  5. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  6. package/dist/m365/aad/commands.js +2 -0
  7. package/dist/m365/commands/status.js +6 -1
  8. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  9. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  10. package/dist/m365/outlook/commands.js +1 -0
  11. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  12. package/dist/m365/planner/commands/plan/plan-get.js +5 -20
  13. package/dist/m365/pp/commands/card/card-get.js +110 -0
  14. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  15. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  16. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  17. package/dist/m365/pp/commands.js +4 -0
  18. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  19. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  26. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  27. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  28. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  29. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  30. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  31. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  32. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  33. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  34. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  35. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  36. package/dist/m365/spo/commands/field/field-add.js +26 -1
  37. package/dist/m365/spo/commands/field/field-set.js +23 -13
  38. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  39. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  40. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  41. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  42. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  43. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +14 -6
  44. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  45. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  46. package/dist/m365/spo/commands/list/list-webhook-list.js +17 -42
  47. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  48. package/dist/m365/spo/commands/list/list-webhook-set.js +27 -20
  49. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  50. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  51. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  52. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  53. package/dist/m365/spo/commands/listitem/listitem-list.js +21 -11
  54. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  55. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  56. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  57. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  58. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  59. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  60. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  61. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  62. package/dist/m365/spo/commands/site/site-add.js +4 -11
  63. package/dist/m365/spo/commands/{hubsite/hubsite-connect.js → site/site-hubsite-connect.js} +10 -10
  64. package/dist/m365/spo/commands/{hubsite/hubsite-disconnect.js → site/site-hubsite-disconnect.js} +13 -13
  65. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  66. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  67. package/dist/m365/spo/commands.js +5 -3
  68. package/dist/m365/teams/commands/team/team-set.js +0 -7
  69. package/dist/m365/todo/commands/list/list-get.js +89 -0
  70. package/dist/m365/todo/commands/task/task-add.js +55 -3
  71. package/dist/m365/todo/commands/task/task-get.js +108 -0
  72. package/dist/m365/todo/commands/task/task-set.js +53 -1
  73. package/dist/m365/todo/commands.js +2 -0
  74. package/docs/docs/_clisettings.md +18 -0
  75. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  76. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  77. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +3 -0
  78. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  79. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  80. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  81. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  82. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  83. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  84. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  85. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  86. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  87. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  88. package/docs/docs/cmd/planner/plan/plan-get.md +75 -6
  89. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  90. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  91. package/docs/docs/cmd/planner/task/task-get.md +0 -3
  92. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  93. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  94. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  95. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  96. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  97. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  98. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  99. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  100. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  101. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  102. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  103. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  104. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  105. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  106. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  107. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  108. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  109. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  110. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  111. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  112. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  113. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +16 -7
  114. package/docs/docs/cmd/spo/list/list-view-set.md +14 -3
  115. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  116. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  117. package/docs/docs/cmd/spo/list/list-webhook-list.md +13 -10
  118. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  119. package/docs/docs/cmd/spo/list/list-webhook-set.md +21 -12
  120. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  121. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  122. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  123. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  124. package/docs/docs/cmd/spo/listitem/listitem-list.md +10 -1
  125. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  126. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  127. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  128. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  129. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  130. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  131. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  132. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +5 -10
  133. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  134. package/docs/docs/cmd/spo/site/site-add.md +0 -3
  135. package/docs/docs/cmd/spo/{hubsite/hubsite-connect.md → site/site-hubsite-connect.md} +4 -4
  136. package/docs/docs/cmd/spo/{hubsite/hubsite-disconnect.md → site/site-hubsite-disconnect.md} +7 -7
  137. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  138. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  139. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  140. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  141. package/docs/docs/cmd/teams/team/team-clone.md +0 -3
  142. package/docs/docs/cmd/teams/team/team-set.md +0 -3
  143. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  144. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  145. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  146. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  147. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  148. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  149. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  150. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  151. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  152. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  153. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  154. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  155. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  156. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  157. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  158. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  159. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  160. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  161. package/package.json +13 -4
@@ -0,0 +1,51 @@
1
+ # pp card get
2
+
3
+ Gets a specific Microsoft Power Platform card in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp card get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the card. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The name of the card. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Get a specific card in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card"
33
+ ```
34
+
35
+ Get a specific card in a specific environment based on name as admin
36
+
37
+ ```sh
38
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --asAdmin
39
+ ```
40
+
41
+ Get a specific card in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa"
45
+ ```
46
+
47
+ Get a specific card in a specific environment based on id as admin
48
+
49
+ ```sh
50
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --asAdmin
51
+ ```
@@ -0,0 +1,82 @@
1
+ # pp card remove
2
+
3
+ Removes the specified Microsoft Power Platform card in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp card remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the card. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The name of the card. Specify either `id` or `name` but not both.
21
+
22
+ `--asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the name parameter
33
+
34
+ ```sh
35
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name"
36
+ ```
37
+
38
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the name parameter without confirmation
39
+
40
+ ```sh
41
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --confirm
42
+ ```
43
+
44
+ Removes the specified Microsoft Power Platform card owned by another user based on the name parameter
45
+
46
+ ```sh
47
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --asAdmin
48
+ ```
49
+
50
+ Removes the specified Microsoft Power Platform card owned by another user based on the name parameter without confirmation
51
+
52
+ ```sh
53
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --asAdmin --confirm
54
+ ```
55
+
56
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the id parameter
57
+
58
+ ```sh
59
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e
60
+ ```
61
+
62
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the id parameter without confirmation
63
+
64
+ ```sh
65
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --confirm
66
+ ```
67
+
68
+ Removes the specified Microsoft Power Platform card owned by another user based on the id parameter
69
+
70
+ ```sh
71
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --asAdmin
72
+ ```
73
+
74
+ Removes the specified Microsoft Power Platform card owned by another user based on the id parameter without confirmation
75
+
76
+ ```sh
77
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --asAdmin --confirm
78
+ ```
79
+
80
+ ## Response
81
+
82
+ The command won't return a response on success.
@@ -0,0 +1,24 @@
1
+ # pp gateway get
2
+
3
+ Get information about the specified gateway
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp gateway get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the Gateway.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get information about the specified gateway.
21
+
22
+ ```sh
23
+ m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
24
+ ```
@@ -0,0 +1,51 @@
1
+ # pp solution get
2
+
3
+ Gets a specific solution in a given environment.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp solution get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i --id [id]`
17
+ : The ID of the solution. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Gets a specific solution in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
33
+ ```
34
+
35
+ Gets a specific solution in a specific environment based on name as Admin
36
+
37
+ ```sh
38
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
39
+ ```
40
+
41
+ Gets a specific solution in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
45
+ ```
46
+
47
+ Gets a specific solution in a specific environment based on id as Admin
48
+
49
+ ```sh
50
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
51
+ ```
@@ -16,20 +16,7 @@ m365 spfx project rename [options]
16
16
  `--generateNewId`
17
17
  : Generate a new solution ID for the project
18
18
 
19
- `-h, --help`
20
- : output usage information
21
-
22
- `--query [query]`
23
- : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
24
-
25
- `-o, --output [output]`
26
- : Output type. `json,text,csv,md`. Default `json`
27
-
28
- `--verbose`
29
- : Runs command with verbose logging
30
-
31
- `--debug`
32
- : Runs command with debug logging
19
+ --8<-- "docs/cmd/_global.md"
33
20
 
34
21
  !!! important
35
22
  Run this command in the folder where the project that you want to rename is located.
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-beta.1).
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-beta.2).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -14,7 +14,13 @@ m365 spo contenttype add [options]
14
14
  : Absolute URL of the site where the content type should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type should be created (if it should be created as a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id <id>`
20
26
  : The ID of the content type. Determines the parent content type
@@ -44,12 +50,24 @@ Create a site content type that inherits from the List item content type
44
50
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
45
51
  ```
46
52
 
47
- Create a list content type that inherits from the List item content type
53
+ Create a list (retrieved by Title) content type that inherits from the List item content type
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
51
57
  ```
52
58
 
59
+ Create a list (retrieved by ID) content type that inherits from the List item content type
60
+
61
+ ```sh
62
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
63
+ ```
64
+
65
+ Create a list (retrieved by URL) content type that inherits from the List item content type
66
+
67
+ ```sh
68
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
69
+ ```
70
+
53
71
  ## More information
54
72
 
55
73
  - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))
@@ -14,7 +14,13 @@ m365 spo contenttype field remove [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --contentTypeId <contentTypeId>`
20
26
  : The ID of the content type to remove the column from
@@ -32,20 +38,32 @@ m365 spo contenttype field remove [options]
32
38
 
33
39
  ## Examples
34
40
 
35
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
41
+ Remove column with a specific ID from a content type with a specific ID from a specific site.
36
42
 
37
43
  ```sh
38
44
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
39
45
  ```
40
46
 
41
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_ updating child content types
47
+ Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
42
48
 
43
49
  ```sh
44
50
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
45
51
  ```
46
52
 
47
- Remove fieldLink with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from list content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
53
+ Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
51
57
  ```
58
+
59
+ Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
60
+
61
+ ```sh
62
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
63
+ ```
64
+
65
+ Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
66
+
67
+ ```sh
68
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
69
+ ```
@@ -14,7 +14,13 @@ m365 spo contenttype get [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id [id]`
20
26
  : The ID of the content type to retrieve. Specify either id or name but not both
@@ -39,11 +45,23 @@ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-s
39
45
  Retrieve site content type by name
40
46
 
41
47
  ```sh
42
- m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name "Document"
48
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
43
49
  ```
44
50
 
45
- Retrieve list content type
51
+ Retrieve list (retrieved by Title) content type
46
52
 
47
53
  ```sh
48
54
  m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
49
55
  ```
56
+
57
+ Retrieve list (retrieved by ID) content type
58
+
59
+ ```sh
60
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
61
+ ```
62
+
63
+ Retrieve list (retrieved by URL) content type
64
+
65
+ ```sh
66
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
67
+ ```
@@ -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_
@@ -26,10 +26,10 @@ Specify either `listTitle`, `listId` or `listUrl`.
26
26
  Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-n, --name [name]`
29
- The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
29
+ : The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-i, --id [id]`
32
- The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
32
+ : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
33
 
34
34
  `-s, --scope [scope]`
35
35
  : The scope of which to retrieve the Event Receivers.
@@ -23,10 +23,10 @@ m365 spo eventreceiver remove [options]
23
23
  : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `-n, --name [name]`
26
- The name. Specify either `name` or `id` but not both.
26
+ : The name. Specify either `name` or `id` but not both.
27
27
 
28
28
  `-i, --id [id]`
29
- The id. Specify either `name` or `id` but not both.
29
+ : The id. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-s, --scope [scope]`
32
32
  : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
@@ -14,7 +14,13 @@ m365 spo field add [options]
14
14
  : Absolute URL of the site where the field should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the field should be created (if it should be created as a list column)
17
+ : Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
+
19
+ `--listId [listId]`
20
+ : ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
24
 
19
25
  `-x, --xml <xml>`
20
26
  : CAML field definition
@@ -36,7 +42,7 @@ Create a date time site column
36
42
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
37
43
  ```
38
44
 
39
- Create a URL list column
45
+ Create a URL list column to a list retrieved by Title
40
46
 
41
47
  ```sh
42
48
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
48
54
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
49
55
  ```
50
56
 
57
+ Create a URL list column to a list retrieved by ID
58
+
59
+ ```sh
60
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
61
+ ```
62
+
63
+ Create a date time list column to a list retrieved by URL
64
+
65
+ ```sh
66
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
67
+ ```
68
+
51
69
  ## More information
52
70
 
53
71
  - AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)
@@ -14,10 +14,13 @@ m365 spo field set [options]
14
14
  : Absolute URL of the site where the field is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-i, --id [id]`
23
26
  : ID of the field to update. Specify `id` or `title` but not both
@@ -34,6 +37,9 @@ m365 spo field set [options]
34
37
 
35
38
  Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
36
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
+
37
43
  ## Examples
38
44
 
39
45
  Update the title of the site column specified by its internal name and push changes to existing lists
@@ -48,8 +54,14 @@ Update the title of the list column specified by its ID
48
54
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
49
55
  ```
50
56
 
57
+ Update the description of a column specified by the ID on a list retrieved by the URL
58
+
59
+ ```sh
60
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
61
+ ```
62
+
51
63
  Update column formatting of the specified list column
52
64
 
53
65
  ```sh
54
- 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"}'
55
67
  ```
@@ -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
+ ```
@@ -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