@pnp/cli-microsoft365 6.3.0-beta.c3dc921 → 6.3.0-beta.e40d7b4

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 (241) hide show
  1. package/.eslintrc.js +8 -0
  2. package/dist/Auth.js +0 -18
  3. package/dist/Command.js +12 -1
  4. package/dist/cli/Cli.js +42 -1
  5. package/dist/m365/aad/commands/group/group-list.js +2 -1
  6. package/dist/m365/aad/commands/user/user-add.js +223 -0
  7. package/dist/m365/aad/commands/user/user-license-list.js +99 -0
  8. package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
  9. package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
  10. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  11. package/dist/m365/aad/commands/user/user-remove.js +107 -0
  12. package/dist/m365/aad/commands.js +6 -0
  13. package/dist/m365/base/O365MgmtCommand.js +10 -0
  14. package/dist/m365/context/commands/option/option-list.js +54 -0
  15. package/dist/m365/context/commands.js +1 -0
  16. package/dist/m365/file/commands/convert/convert-pdf.js +7 -6
  17. package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
  18. package/dist/m365/flow/commands/environment/environment-get.js +26 -11
  19. package/dist/m365/flow/commands/run/run-list.js +55 -3
  20. package/dist/m365/graph/commands/changelog/changelog-list.js +3 -2
  21. package/dist/m365/onenote/commands/notebook/notebook-list.js +50 -53
  22. package/dist/m365/onenote/commands/page/page-list.js +2 -16
  23. package/dist/m365/outlook/commands/mail/mail-send.js +3 -2
  24. package/dist/m365/outlook/commands/message/message-get.js +4 -3
  25. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  26. package/dist/m365/planner/commands/plan/plan-add.js +20 -6
  27. package/dist/m365/planner/commands/plan/plan-get.js +40 -26
  28. package/dist/m365/planner/commands/plan/plan-list.js +24 -14
  29. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  30. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  31. package/dist/m365/planner/commands/roster/roster-add.js +47 -0
  32. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  33. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  34. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  35. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  36. package/dist/m365/planner/commands/roster/roster-remove.js +88 -0
  37. package/dist/m365/planner/commands/task/task-add.js +3 -0
  38. package/dist/m365/planner/commands/task/task-checklistitem-add.js +2 -1
  39. package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
  40. package/dist/m365/planner/commands.js +6 -0
  41. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  42. package/dist/m365/pp/commands/solution/solution-get.js +2 -1
  43. package/dist/m365/pp/commands/solution/solution-list.js +2 -1
  44. package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
  45. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
  46. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
  47. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  48. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  49. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +75 -0
  50. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
  51. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  52. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  53. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  54. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  55. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  56. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  57. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  58. package/dist/m365/purview/commands.js +9 -0
  59. package/dist/m365/spfx/commands/project/WebApiPermissionRequests.js +3 -0
  60. package/dist/m365/spfx/commands/project/project-permissions-grant.js +81 -0
  61. package/dist/m365/spfx/commands.js +3 -2
  62. package/dist/m365/spo/commands/app/app-add.js +2 -1
  63. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  64. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  65. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  66. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  67. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  68. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +2 -1
  69. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  70. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  71. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  72. package/dist/m365/spo/commands/file/file-sharinglink-list.js +9 -29
  73. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  74. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  75. package/dist/m365/spo/commands/group/group-list.js +2 -1
  76. package/dist/m365/spo/commands/hubsite/hubsite-get.js +1 -1
  77. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  78. package/dist/m365/spo/commands/listitem/listitem-list.js +2 -1
  79. package/dist/m365/spo/commands/navigation/navigation-node-add.js +17 -3
  80. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  81. package/dist/m365/spo/commands/navigation/navigation-node-list.js +4 -7
  82. package/dist/m365/spo/commands/navigation/navigation-node-set.js +118 -0
  83. package/dist/m365/spo/commands/page/page-column-get.js +2 -1
  84. package/dist/m365/spo/commands/page/page-column-list.js +2 -1
  85. package/dist/m365/spo/commands/page/page-section-get.js +2 -1
  86. package/dist/m365/spo/commands/page/page-section-list.js +2 -1
  87. package/dist/m365/spo/commands/site/site-apppermission-add.js +2 -14
  88. package/dist/m365/spo/commands/site/site-apppermission-get.js +2 -14
  89. package/dist/m365/spo/commands/site/site-apppermission-list.js +2 -14
  90. package/dist/m365/spo/commands/site/site-apppermission-remove.js +2 -14
  91. package/dist/m365/spo/commands/site/site-apppermission-set.js +2 -14
  92. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  93. package/dist/m365/spo/commands/spo-search.js +2 -1
  94. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  95. package/dist/m365/spo/commands/term/term-list.js +2 -1
  96. package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -2
  97. package/dist/m365/spo/commands/web/web-set.js +11 -4
  98. package/dist/m365/spo/commands.js +6 -0
  99. package/dist/m365/teams/commands/chat/chat-list.js +4 -4
  100. package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +5 -5
  101. package/dist/m365/teams/commands/meeting/meeting-get.js +5 -5
  102. package/dist/m365/teams/commands/meeting/meeting-list.js +5 -4
  103. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  104. package/dist/m365/teams/commands/user/user-app-list.js +2 -1
  105. package/dist/m365/todo/commands/task/task-get.js +2 -1
  106. package/dist/m365/todo/commands/task/task-list.js +2 -1
  107. package/dist/m365/yammer/commands/yammer-search.js +2 -1
  108. package/dist/utils/aadUser.js +38 -0
  109. package/dist/utils/accessToken.js +1 -1
  110. package/dist/utils/planner.js +16 -5
  111. package/dist/utils/spo.js +116 -0
  112. package/docs/docs/cmd/aad/app/app-list.md +3 -0
  113. package/docs/docs/cmd/aad/user/user-add.md +168 -0
  114. package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
  115. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  116. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
  117. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  118. package/docs/docs/cmd/aad/user/user-remove.md +51 -0
  119. package/docs/docs/cmd/aad/user/user-set.md +2 -2
  120. package/docs/docs/cmd/context/option/option-list.md +63 -0
  121. package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
  122. package/docs/docs/cmd/flow/run/run-list.md +21 -0
  123. package/docs/docs/cmd/login.md +26 -0
  124. package/docs/docs/cmd/logout.md +4 -0
  125. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  126. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  127. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  128. package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
  129. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  130. package/docs/docs/cmd/planner/plan/plan-add.md +17 -6
  131. package/docs/docs/cmd/planner/plan/plan-get.md +21 -7
  132. package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
  133. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  134. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  135. package/docs/docs/cmd/planner/roster/roster-add.md +60 -0
  136. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  137. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  138. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  139. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  140. package/docs/docs/cmd/planner/roster/roster-remove.md +48 -0
  141. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  142. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  143. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  144. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  145. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  146. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  147. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  148. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  149. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  150. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  151. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  152. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  153. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  154. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  155. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  156. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  157. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  158. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  159. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  160. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  161. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  162. package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
  163. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  164. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  165. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  166. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  167. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +103 -0
  168. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  169. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  170. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  171. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  172. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  173. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  174. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  175. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  176. package/docs/docs/cmd/request.md +74 -0
  177. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +65 -0
  178. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  179. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  180. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  181. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  182. package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
  183. package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
  184. package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
  185. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
  186. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
  187. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
  188. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
  189. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
  190. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
  191. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
  192. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
  193. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
  194. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
  195. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
  196. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
  197. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
  198. package/docs/docs/cmd/spo/list/list-add.md +123 -57
  199. package/docs/docs/cmd/spo/list/list-contenttype-add.md +50 -5
  200. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +4 -4
  201. package/docs/docs/cmd/spo/list/list-contenttype-list.md +49 -4
  202. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +6 -6
  203. package/docs/docs/cmd/spo/list/list-get.md +70 -4
  204. package/docs/docs/cmd/spo/list/list-list.md +70 -2
  205. package/docs/docs/cmd/spo/list/list-remove.md +6 -6
  206. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
  207. package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
  208. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
  209. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
  210. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
  211. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
  212. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
  213. package/docs/docs/cmd/spo/list/list-set.md +61 -61
  214. package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
  215. package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
  216. package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
  217. package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
  218. package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
  219. package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
  220. package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
  221. package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
  222. package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
  223. package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
  224. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +19 -4
  225. package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
  226. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +8 -2
  227. package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
  228. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
  229. package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
  230. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +40 -3
  231. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  232. package/docs/docs/cmd/spo/navigation/navigation-node-list.md +30 -0
  233. package/docs/docs/cmd/spo/navigation/navigation-node-remove.md +1 -1
  234. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +59 -0
  235. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  236. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  237. package/docs/docs/cmd/spo/web/web-set.md +9 -0
  238. package/docs/docs/cmd/status.md +46 -0
  239. package/docs/docs/cmd/version.md +26 -0
  240. package/npm-shrinkwrap.json +911 -876
  241. package/package.json +12 -12
@@ -0,0 +1,63 @@
1
+ # context option list
2
+
3
+ List all options added to the context
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 context option list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ List all options added to the context
18
+
19
+ ```sh
20
+ m365 context option list
21
+ ```
22
+
23
+ ## Response
24
+
25
+ The responses below are an example. The output may differ based on the contents of the context file
26
+
27
+ === "JSON"
28
+
29
+ ```json
30
+ {
31
+ "url": "https://contoso.sharepoint.com",
32
+ "list": "list name"
33
+ }
34
+ ```
35
+
36
+ === "Text"
37
+
38
+ ```text
39
+ list: list name
40
+ url : https://contoso.sharepoint.com
41
+ ```
42
+
43
+ === "CSV"
44
+
45
+ ```csv
46
+ url,list
47
+ https://contoso.sharepoint.com,list name
48
+ ```
49
+
50
+ === "Markdown"
51
+
52
+ ```md
53
+ # context option list
54
+
55
+ Date: 7/2/2023
56
+
57
+ ## https://contoso.sharepoint.com
58
+
59
+ Property | Value
60
+ ---------|-------
61
+ url | https://contoso.sharepoint.com
62
+ list | list name
63
+ ```
@@ -10,8 +10,8 @@ m365 flow environment get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-n, --name <name>`
14
- : The name of the environment to get information about
13
+ `-n, --name [name]`
14
+ : The name of the environment to get information about. When not specified, the default environment is retrieved.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -24,12 +24,17 @@ If the environment with the name you specified doesn't exist, you will get the `
24
24
 
25
25
  ## Examples
26
26
 
27
- Get information about the Microsoft Flow environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
27
+ Get information about a Microsoft Flow environment specified by name
28
28
 
29
29
  ```sh
30
30
  m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
31
31
  ```
32
32
 
33
+ Get information about the default Microsoft Flow environment
34
+ ```sh
35
+ m365 flow environment get
36
+ ```
37
+
33
38
  ## Response
34
39
 
35
40
  ### Standard response
@@ -129,3 +134,26 @@ m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
129
134
  name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
130
135
  Default-d87a7535-dd31-4437-bfe1-95340acd55c5,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5,india,contoso (default),Succeeded,Default,centralindia,1
131
136
  ```
137
+
138
+ === "Markdown"
139
+
140
+ ```md
141
+ # flow environment get
142
+
143
+ Date: 8/2/2023
144
+
145
+ ## contoso (default) (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5)
146
+
147
+ Property | Value
148
+ ---------|-------
149
+ name | Default-d87a7535-dd31-4437-bfe1-95340acd55c5
150
+ location | india
151
+ type | Microsoft.ProcessSimple/environments
152
+ id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5
153
+ properties | {"displayName":"contoso (default)","createdTime":"2019-12-21T18:32:11.8708704Z","createdBy":{"id":"SYSTEM","displayName": "SYSTEM","type": "NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"NotSpecified","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"isDefault":true,"isPayAsYouGoEnabled":false,"azureRegionHint":"centralindia","runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://india.api.bap.microsoft.com","microsoft.CommonDataModel":"https://india.api.cds.microsoft.com","microsoft.PowerApps":"https://india.api.powerapps.com",microsoft.PowerAppsAdvisor":"https://india.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.in-il101.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.INDIA.azure-apihub.net","microsoft.Flow":"https://india.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"NotSpecified","resourceId":"3aa550bf-52ac-42fc-98f7-5d1833c1501c","friendlyName":"contoso (default)","uniqueName":"orgfc80770f","domainName":"orgfc80770f","version":"9.2.22105.00154","instanceUrl":"https://orgfc80770f.crm8.dynamics.com/","instanceApiUrl":"https://orgfc80770f.api.crm8.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2019-12-25T15:46:14.433Z"},"environmentFeatures":{"isOpenApiEnabled":false},"cluster":{"category":"Prod","number":"101","uriSuffix":"in-il101.gateway.prod.island","geoShortName":"IN","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
154
+ displayName | contoso (default)
155
+ provisioningState | Succeeded
156
+ environmentSku | Default
157
+ azureRegionHint | centralindia
158
+ isDefault | true
159
+ ```
@@ -16,6 +16,15 @@ m365 flow run list [options]
16
16
  `-e, --environmentName <environmentName>`
17
17
  : The name of the environment to which the flow belongs
18
18
 
19
+ `--status [status]`
20
+ : Filter the results to only flow runs with a given status: `Succeeded`, `Running`, `Failed` or `Cancelled`. By default all flow runs are listed.
21
+
22
+ `--triggerStartTime [triggerStartTime]`
23
+ : Time indicating the inclusive start of a time range of flow runs to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z).
24
+
25
+ `--triggerEndTime [triggerEndTime]`
26
+ : Time indicating the exclusive end of a time range of flow runs to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z).
27
+
19
28
  --8<-- "docs/cmd/_global.md"
20
29
 
21
30
  ## Remarks
@@ -35,6 +44,18 @@ List runs of the specified Microsoft Flow
35
44
  m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a
36
45
  ```
37
46
 
47
+ List runs of the specified Microsoft Flow with a specific status
48
+
49
+ ```sh
50
+ m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --status Running
51
+ ```
52
+
53
+ List runs of the specified Microsoft Flow between a specific time range
54
+
55
+ ```sh
56
+ m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --triggerStartTime 2023-01-21T18:19:00Z --triggerEndTime 2023-01-22T00:00:00Z
57
+ ```
58
+
38
59
  ## Response
39
60
 
40
61
  ### Standard response
@@ -159,3 +159,29 @@ Log in to Microsoft 365 using a client secret.
159
159
  ```sh
160
160
  m365 login --authType secret --secret topSeCr3t@007
161
161
  ```
162
+
163
+ ## Response
164
+
165
+ === "JSON"
166
+
167
+ ```json
168
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
169
+ ```
170
+
171
+ === "Text"
172
+
173
+ ```text
174
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
175
+ ```
176
+
177
+ === "CSV"
178
+
179
+ ```csv
180
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
181
+ ```
182
+
183
+ === "Markdown"
184
+
185
+ ```md
186
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
187
+ ```
@@ -29,3 +29,7 @@ Log out from Microsoft 365 in debug mode including detailed debug information in
29
29
  ```sh
30
30
  m365 logout --debug
31
31
  ```
32
+
33
+ ## Response
34
+
35
+ The command won't return a response on success.
@@ -222,3 +222,27 @@ m365 pa app get --displayName App
222
222
  name,displayName,description,appVersion,owner
223
223
  37ea6004-f07b-46ca-8ef3-a256b67b4dbb,PowerApps Application,App Description,2022-10-25T21:28:12Z,user@tenant.onmicrosoft.com
224
224
  ```
225
+
226
+ === "Markdown"
227
+
228
+ ```md
229
+ # pa app get --displayName "PowerApps Application"
230
+
231
+ Date: 9/1/2023
232
+
233
+ ## PowerApps Application (/providers/Microsoft.PowerApps/apps/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
234
+
235
+ Property | Value
236
+ ---------|-------
237
+ name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
238
+ id | /providers/Microsoft.PowerApps/apps/fe36f75e-c103-410b-a18a-2bf6df06ac3a
239
+ type | Microsoft.PowerApps/apps
240
+ tags | {"primaryDeviceWidth":"1366","primaryDeviceHeight":"768","supportsPortrait":"true","supportsLandscape":"true","primaryFormFactor":"Tablet","publisherVersion":"3.22102.32","minimumRequiredApiVersion":"2.2.0","hasComponent":"false","hasUnlockedComponent":"false","isUnifiedRootApp":"false","sienaVersion":"20221025T212812Z-3.22102.32.0"}
241
+ properties | {"appVersion":"2022-10-25T21:28:12Z","lastDraftVersion":"2022-10-25T21:28:12Z","lifeCycleId":"Published","status":"Ready","createdByClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"minClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"owner":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"createdBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastModifiedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastPublishedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"backgroundColor":"RGBA(0,176,240,1)","backgroundImageUri":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/logoSmallFile?sv=2018-03-28&sr=c&sig=cOkbwChyhCO%2BEJpqMDRxrXaxRoPD1TbTy%2B%2BFkdJEOjI%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsColorIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamscoloricon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsOutlineIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamsoutlineicon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","displayName":"Test application","description":"","commitMessage":"","appUris":{"documentUri":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"imageUris":[],"additionalUris":[]},"createdTime":"2022-10-25T21:28:12.7171469Z","lastModifiedTime":"2022-10-25T21:28:12.7456297Z","lastPublishTime":"2022-10-25T21:28:12Z","sharedGroupsCount":0,"sharedUsersCount":0,"appOpenProtocolUri":"ms-apps:///providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb","appOpenUri":"https://apps.powerapps.com/play/e/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc","appPlayUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d","appPlayEmbeddedUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu","appPlayTeamsUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&source=teamstab&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu&locale={locale}&channelId={channelId}&channelType={channelType}&chatId={chatId}&groupId={groupId}&hostClientType={hostClientType}&isFullScreen={isFullScreen}&entityId={entityId}&subEntityId={subEntityId}&teamId={teamId}&teamType={teamType}&theme={theme}&userTeamRole={userTeamRole}","userAppMetadata":{"favorite":"NotSpecified","includeInAppsList":true},"isFeaturedApp":false,"bypassConsent":false,"isHeroApp":false,"environment":{"id":"/providers/Microsoft.PowerApps/environments/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d","name":"default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"},"appPackageDetails":{"playerPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"webPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"unauthenticatedWebPackage":{"value":"https://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"documentServerVersion":{"major":3,"minor":22102,"build":33,"revision":0,"majorRevision":0,"minorRevision":0},"appPackageResourcesKind":"Split","packagePropertiesJson":"{\"cdnUrl\":\"https://content.powerapps.com/resource/app\",\"preLoadIdx\":\"https://content.powerapps.com/resource/app/kdfj31mdao7t9/preloadindex.web.html\",\"id\":\"638023301009567627\",\"v\":2.1}","id":"20221025t000000zac5237a2672a4782ad5a7d71040c032bhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"almMode":"Environment","performanceOptimizationEnabled":true,"unauthenticatedWebPackageHint":"296b0ef7-b4d0-4124-b835-f9c220a1f4bc","canConsumeAppPass":true,"enableModernRuntimeMode":false,"executionRestrictions":{"isTeamsOnly":false,"dataLossPreventionEvaluationResult":{"status":"Compliant","lastEvaluationDate":"2022-10-25T21:28:30.2281817Z","violations":[],"violationsByPolicy":[],"violationErrorMessage":"De app gebruikt de volgende connectors:."}},"appPlanClassification":"Standard","usesPremiumApi":false,"usesOnlyGrandfatheredPremiumApis":true,"usesCustomApi":false,"usesOnPremiseGateway":false,"usesPcfExternalServiceUsage":false,"isCustomizable":true}
242
+ appLocation | europe
243
+ appType | ClassicCanvasApp
244
+ displayName | PowerApps Application
245
+ description | App Description
246
+ appVersion | 2022-10-25T21:28:12Z
247
+ owner | user@tenant.onmicrosoft.com
248
+ ```
@@ -221,3 +221,24 @@ m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --as
221
221
  name,displayName
222
222
  37ea6004-f07b-46ca-8ef3-a256b67b4dbb,"PowerApps Application"
223
223
  ```
224
+
225
+ === "Markdown"
226
+
227
+ ```md
228
+ # pa app list
229
+
230
+ Date: 9/1/2023
231
+
232
+ ## PowerApps Application (/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb)
233
+
234
+ Property | Value
235
+ ---------|-------
236
+ name | 37ea6004-f07b-46ca-8ef3-a256b67b4dbb
237
+ id | /providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb
238
+ type | Microsoft.PowerApps/apps
239
+ tags | {"primaryDeviceWidth":"1366","primaryDeviceHeight":"768","supportsPortrait":"true","supportsLandscape":"true","primaryFormFactor":"Tablet","publisherVersion":"3.22102.32","minimumRequiredApiVersion":"2.2.0","hasComponent":"false","hasUnlockedComponent":"false","isUnifiedRootApp":"false","sienaVersion":"20221025T212812Z-3.22102.32.0"}
240
+ properties | {"appVersion":"2022-10-25T21:28:12Z","lastDraftVersion":"2022-10-25T21:28:12Z","lifeCycleId":"Published","status":"Ready","createdByClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"minClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"owner":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"createdBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastModifiedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastPublishedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"backgroundColor":"RGBA(0,176,240,1)","backgroundImageUri":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/logoSmallFile?sv=2018-03-28&sr=c&sig=cOkbwChyhCO%2BEJpqMDRxrXaxRoPD1TbTy%2B%2BFkdJEOjI%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsColorIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamscoloricon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsOutlineIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamsoutlineicon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","displayName":"Test application","description":"","commitMessage":"","appUris":{"documentUri":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"imageUris":[],"additionalUris":[]},"createdTime":"2022-10-25T21:28:12.7171469Z","lastModifiedTime":"2022-10-25T21:28:12.7456297Z","lastPublishTime":"2022-10-25T21:28:12Z","sharedGroupsCount":0,"sharedUsersCount":0,"appOpenProtocolUri":"ms-apps:///providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb","appOpenUri":"https://apps.powerapps.com/play/e/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc","appPlayUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d","appPlayEmbeddedUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu","appPlayTeamsUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&source=teamstab&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu&locale={locale}&channelId={channelId}&channelType={channelType}&chatId={chatId}&groupId={groupId}&hostClientType={hostClientType}&isFullScreen={isFullScreen}&entityId={entityId}&subEntityId={subEntityId}&teamId={teamId}&teamType={teamType}&theme={theme}&userTeamRole={userTeamRole}","userAppMetadata":{"favorite":"NotSpecified","includeInAppsList":true},"isFeaturedApp":false,"bypassConsent":false,"isHeroApp":false,"environment":{"id":"/providers/Microsoft.PowerApps/environments/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d","name":"default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"},"appPackageDetails":{"playerPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"webPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"unauthenticatedWebPackage":{"value":"https://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"documentServerVersion":{"major":3,"minor":22102,"build":33,"revision":0,"majorRevision":0,"minorRevision":0},"appPackageResourcesKind":"Split","packagePropertiesJson":"{\"cdnUrl\":\"https://content.powerapps.com/resource/app\",\"preLoadIdx\":\"https://content.powerapps.com/resource/app/kdfj31mdao7t9/preloadindex.web.html\",\"id\":\"638023301009567627\",\"v\":2.1}","id":"20221025t000000zac5237a2672a4782ad5a7d71040c032bhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"almMode":"Environment","performanceOptimizationEnabled":true,"unauthenticatedWebPackageHint":"296b0ef7-b4d0-4124-b835-f9c220a1f4bc","canConsumeAppPass":true,"enableModernRuntimeMode":false,"executionRestrictions":{"isTeamsOnly":false,"dataLossPreventionEvaluationResult":{"status":"Compliant","lastEvaluationDate":"2022-10-25T21:28:30.2281817Z","violations":[],"violationsByPolicy":[],"violationErrorMessage":"De app gebruikt de volgende connectors: ."}},"appPlanClassification":"Standard","usesPremiumApi":false,"usesOnlyGrandfatheredPremiumApis":true,"usesCustomApi":false,"usesOnPremiseGateway":false,"usesPcfExternalServiceUsage":false,"isCustomizable":true}
241
+ appLocation | europe
242
+ appType | ClassicCanvasApp
243
+ displayName | PowerApps Application
244
+ ```
@@ -122,3 +122,20 @@ m365 pa connector list --environmentName Default-d87a7535-dd31-4437-bfe1-95340ac
122
122
  name,displayName
123
123
  shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012,My connector
124
124
  ```
125
+
126
+ === "Markdown"
127
+
128
+ ```md
129
+ # pa connector list --environmentName "Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"
130
+
131
+ Date: 9/1/2023
132
+
133
+ ## My connector (/providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012)
134
+
135
+ Property | Value
136
+ ---------|-------
137
+ name | shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
138
+ id | /providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
139
+ type | Microsoft.PowerApps/apis
140
+ properties | {"displayName":"My connector","iconUri":"https://az787822.vo.msecnd.net/defaulticons/api-dedicated.png","iconBrandColor":"#007ee5","contact":{},"license":{},"apiEnvironment":"Shared","isCustomApi":true,"connectionParameters":{},"runtimeUrls":["https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012"],"primaryRuntimeUrl":"https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012","metadata":{"source":"powerapps-user-defined","brandColor":"#007ee5","contact":{},"license":{},"publisherUrl":null,"serviceUrl":null,"documentationUrl":null,"environmentName":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","xrmConnectorId":null,"almMode":"Environment","createdBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","modifiedBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","allowSharing":false},"capabilities":[],"description":"","apiDefinitions":{"originalSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json_original?sv=2018-03-28&sr=b&sig=cOkjAecgpr6sSznMpDqiZitUOpVvVDJRCOZfe3VmReU%3D&se=2019-12-05T19%3A53%3A49Z&sp=r","modifiedSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json?sv=2018-03-28&sr=b&sig=rkpKHP8K%2F2yNBIUQcVN%2B0ZPjnP9sECrM%2FfoZMG%2BJZX0%3D&se=2019-12-05T19%3A53%3A49Z&sp=r"},"createdBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"modifiedBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"createdTime":"2019-12-05T18:45:03.4615313Z","changedTime":"2019-12-05T18:45:03.4615313Z","environment":{"id":"/providers/Microsoft.PowerApps/environments/Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","name":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"},"tier":"Standard","publisher":"MOD Administrator","almMode":"Environment"}
141
+ ```
@@ -10,8 +10,8 @@ m365 pa environment get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-n, --name <name>`
14
- : The name of the environment to get information about
13
+ `-n, --name [name]`
14
+ : The name of the environment. When not specified, the default environment is retrieved.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -24,6 +24,12 @@ If the environment with the name you specified doesn't exist, you will get the `
24
24
 
25
25
  ## Examples
26
26
 
27
+ Get information about the default Power Apps environment
28
+
29
+ ```sh
30
+ m365 pa environment get
31
+ ```
32
+
27
33
  Get information about the Power Apps environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
28
34
 
29
35
  ```sh
@@ -141,4 +147,22 @@ m365 pa environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
141
147
  name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
142
148
  Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,/providers/Microsoft.PowerApps/environments/Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,europe,environmentName (default),Succeeded,Default,westeurope,1
143
149
  ```
150
+
151
+ === "Markdown"
144
152
 
153
+ ```md
154
+ # pa environment get --name "Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"
155
+
156
+ Date: 9/1/2023
157
+
158
+ ## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
159
+
160
+ Property | Value
161
+ ---------|-------
162
+ id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
163
+ name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
164
+ location | europe
165
+ type | Microsoft.PowerApps/environments
166
+ properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
167
+ displayName | contoso (default) (org6633049a)
168
+ ```
@@ -133,3 +133,22 @@ m365 pa environment list
133
133
  name,displayName
134
134
  Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,environmentName (default) (org6633050c)
135
135
  ```
136
+
137
+ === "Markdown"
138
+
139
+ ```md
140
+ # pa environment list
141
+
142
+ Date: 9/1/2023
143
+
144
+ ## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
145
+
146
+ Property | Value
147
+ ---------|-------
148
+ id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
149
+ name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
150
+ location | europe
151
+ type | Microsoft.PowerApps/environments
152
+ properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
153
+ displayName | contoso (default) (org6633049a)
154
+ ```
@@ -14,10 +14,13 @@ m365 planner plan add [options]
14
14
  : Title of the plan to add.
15
15
 
16
16
  `--ownerGroupId [ownerGroupId]`
17
- : ID of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
17
+ : ID of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
18
18
 
19
19
  `--ownerGroupName [ownerGroupName]`
20
- : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
20
+ : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
21
+
22
+ `--rosterId [rosterId]`
23
+ : ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
21
24
 
22
25
  `--shareWithUserIds [shareWithUserIds]`
23
26
  : The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
@@ -29,23 +32,31 @@ m365 planner plan add [options]
29
32
 
30
33
  ## Remarks
31
34
 
32
- Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
35
+ - Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
36
+
37
+ - Hint: Unlike for groups, a Planner Roster can contain only 1 plan.
33
38
 
34
39
  ## Examples
35
40
 
36
- Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
41
+ Adds a Microsoft Planner plan with a Group by id
37
42
 
38
43
  ```sh
39
44
  m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
40
45
  ```
41
46
 
42
- Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
47
+ Adds a Microsoft Planner plan with with a Group by name
43
48
 
44
49
  ```sh
45
50
  m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
46
51
  ```
47
52
 
48
- Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
53
+ Adds a Microsoft Planner plan with a Roster by id
54
+
55
+ ```sh
56
+ m365 planner plan add --title 'My Planner Plan' --rosterId 'tYqYlNd6eECmsNhN_fcq85cAGAnd'
57
+ ```
58
+
59
+ Adds a Microsoft Planner plan with with a Group by name and share it with the given users
49
60
 
50
61
  ```sh
51
62
  m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
@@ -11,39 +11,53 @@ m365 planner plan get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the plan. Specify either `id` or `title` but not both.
14
+ : ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the plan. Specify either `id` or `title` but not both.
17
+ : Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
18
+
19
+ `--rosterId [rosterId]`
20
+ : ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
23
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
26
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
30
+ ## Remarks
31
+
32
+ !!! attention
33
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
34
+
27
35
  ## Examples
28
36
 
29
- Returns the Microsoft Planner plan with id _gndWOTSK60GfPQfiDDj43JgACDCb_
37
+ Returns the Microsoft Planner plan by id
30
38
 
31
39
  ```sh
32
40
  m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
33
41
  ```
34
42
 
35
- Returns the Microsoft Planner plan with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
43
+ Returns the Microsoft Planner plan by title and owner group id
36
44
 
37
45
  ```sh
38
46
  m365 planner plan get --title "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
39
47
  ```
40
48
 
41
- Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Group_
49
+ Returns the Microsoft Planner plan by title and owner group name
42
50
 
43
51
  ```sh
44
52
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
45
53
  ```
46
54
 
55
+ Returns the Microsoft Planner plan by roster id
56
+
57
+ ```sh
58
+ m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
59
+ ```
60
+
47
61
  ## Response
48
62
 
49
63
  === "JSON"
@@ -11,13 +11,21 @@ m365 planner plan list [options]
11
11
  ## Options
12
12
 
13
13
  `--ownerGroupId [ownerGroupId]`
14
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
14
+ : ID of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
15
15
 
16
16
  `--ownerGroupName [ownerGroupName]`
17
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
17
+ : Name of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
18
+
19
+ `--rosterId [rosterId]`
20
+ : ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
18
21
 
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
24
+ ## Remarks
25
+
26
+ !!! attention
27
+ When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
+
21
29
  ## Examples
22
30
 
23
31
  Returns a list of Microsoft Planner plans for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
@@ -32,6 +40,12 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
32
40
  m365 planner plan list --ownerGroupName "My Planner Group"
33
41
  ```
34
42
 
43
+ Returns a list of Microsoft Planner plans for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
44
+
45
+ ```sh
46
+ m365 planner plan list --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
47
+ ```
48
+
35
49
  ## Response
36
50
 
37
51
  === "JSON"
@@ -27,6 +27,10 @@ m365 planner plan remove [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
32
+ If you wish to delete a Planner plan contained within a Planner Roster, you'll have to remove the roster using [planner roster remove](../roster/roster-remove.md).
33
+
30
34
  ## Examples
31
35
 
32
36
  Removes the Microsoft Planner plan by ID
@@ -11,16 +11,19 @@ m365 planner plan set [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the plan. Specify either `id` or `title` but not both.
14
+ : ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the plan. Specify either `id` or `title` but not both.
17
+ : Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
18
+
19
+ `--rosterId [rosterId]`
20
+ : ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
23
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
26
+ : Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
24
27
 
25
28
  `--newTitle [newTitle]`
26
29
  : New title of the plan.
@@ -40,6 +43,9 @@ This command allows using unknown options.
40
43
  `--category1 [category1]`
41
44
  : New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., `--category4`, `--category12`.
42
45
 
46
+ !!! attention
47
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
48
+
43
49
  ## Examples
44
50
 
45
51
  Updates a Microsoft Planner plan title to New Title