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

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 (188) 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-recyclebinitem-clear.js +103 -0
  7. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  8. package/dist/m365/aad/commands.js +2 -0
  9. package/dist/m365/base/O365MgmtCommand.js +10 -0
  10. package/dist/m365/context/commands/option/option-list.js +54 -0
  11. package/dist/m365/context/commands.js +1 -0
  12. package/dist/m365/file/commands/convert/convert-pdf.js +7 -6
  13. package/dist/m365/flow/commands/run/run-list.js +55 -3
  14. package/dist/m365/graph/commands/changelog/changelog-list.js +3 -2
  15. package/dist/m365/onenote/commands/notebook/notebook-list.js +50 -53
  16. package/dist/m365/onenote/commands/page/page-list.js +2 -16
  17. package/dist/m365/outlook/commands/mail/mail-send.js +3 -2
  18. package/dist/m365/outlook/commands/message/message-get.js +4 -3
  19. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  20. package/dist/m365/planner/commands/plan/plan-add.js +20 -6
  21. package/dist/m365/planner/commands/plan/plan-get.js +40 -26
  22. package/dist/m365/planner/commands/plan/plan-list.js +24 -14
  23. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  24. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  25. package/dist/m365/planner/commands/roster/roster-add.js +47 -0
  26. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  27. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  28. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  29. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  30. package/dist/m365/planner/commands/roster/roster-remove.js +88 -0
  31. package/dist/m365/planner/commands/task/task-add.js +3 -0
  32. package/dist/m365/planner/commands/task/task-checklistitem-add.js +2 -1
  33. package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
  34. package/dist/m365/planner/commands.js +6 -0
  35. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  36. package/dist/m365/pp/commands/solution/solution-get.js +2 -1
  37. package/dist/m365/pp/commands/solution/solution-list.js +2 -1
  38. package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
  39. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
  40. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
  41. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  42. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  43. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +75 -0
  44. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
  45. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  46. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  47. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  48. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  49. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  50. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  51. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  52. package/dist/m365/purview/commands.js +9 -0
  53. package/dist/m365/spfx/commands/project/WebApiPermissionRequests.js +3 -0
  54. package/dist/m365/spfx/commands/project/project-permissions-grant.js +81 -0
  55. package/dist/m365/spfx/commands.js +3 -2
  56. package/dist/m365/spo/commands/app/app-add.js +2 -1
  57. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  58. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  59. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  60. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  61. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  62. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +2 -1
  63. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  64. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  65. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  66. package/dist/m365/spo/commands/file/file-sharinglink-list.js +9 -29
  67. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  68. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  69. package/dist/m365/spo/commands/group/group-list.js +2 -1
  70. package/dist/m365/spo/commands/hubsite/hubsite-get.js +1 -1
  71. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  72. package/dist/m365/spo/commands/listitem/listitem-list.js +2 -1
  73. package/dist/m365/spo/commands/navigation/navigation-node-add.js +17 -3
  74. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  75. package/dist/m365/spo/commands/navigation/navigation-node-list.js +4 -7
  76. package/dist/m365/spo/commands/navigation/navigation-node-set.js +118 -0
  77. package/dist/m365/spo/commands/page/page-column-get.js +2 -1
  78. package/dist/m365/spo/commands/page/page-column-list.js +2 -1
  79. package/dist/m365/spo/commands/page/page-section-get.js +2 -1
  80. package/dist/m365/spo/commands/page/page-section-list.js +2 -1
  81. package/dist/m365/spo/commands/site/site-apppermission-add.js +2 -14
  82. package/dist/m365/spo/commands/site/site-apppermission-get.js +2 -14
  83. package/dist/m365/spo/commands/site/site-apppermission-list.js +2 -14
  84. package/dist/m365/spo/commands/site/site-apppermission-remove.js +2 -14
  85. package/dist/m365/spo/commands/site/site-apppermission-set.js +2 -14
  86. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  87. package/dist/m365/spo/commands/spo-search.js +2 -1
  88. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  89. package/dist/m365/spo/commands/term/term-list.js +2 -1
  90. package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -2
  91. package/dist/m365/spo/commands/web/web-set.js +11 -4
  92. package/dist/m365/spo/commands.js +6 -0
  93. package/dist/m365/teams/commands/chat/chat-list.js +4 -4
  94. package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +5 -5
  95. package/dist/m365/teams/commands/meeting/meeting-get.js +5 -5
  96. package/dist/m365/teams/commands/meeting/meeting-list.js +5 -4
  97. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  98. package/dist/m365/teams/commands/user/user-app-list.js +2 -1
  99. package/dist/m365/todo/commands/task/task-get.js +2 -1
  100. package/dist/m365/todo/commands/task/task-list.js +2 -1
  101. package/dist/m365/yammer/commands/yammer-search.js +2 -1
  102. package/dist/utils/aadUser.js +38 -0
  103. package/dist/utils/accessToken.js +1 -1
  104. package/dist/utils/planner.js +16 -5
  105. package/dist/utils/spo.js +116 -0
  106. package/docs/docs/cmd/aad/app/app-list.md +3 -0
  107. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  108. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  109. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  110. package/docs/docs/cmd/context/option/option-list.md +63 -0
  111. package/docs/docs/cmd/flow/run/run-list.md +21 -0
  112. package/docs/docs/cmd/login.md +26 -0
  113. package/docs/docs/cmd/logout.md +4 -0
  114. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  115. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  116. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  117. package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
  118. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  119. package/docs/docs/cmd/planner/plan/plan-add.md +17 -6
  120. package/docs/docs/cmd/planner/plan/plan-get.md +21 -7
  121. package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
  122. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  123. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  124. package/docs/docs/cmd/planner/roster/roster-add.md +60 -0
  125. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  126. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  127. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  128. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  129. package/docs/docs/cmd/planner/roster/roster-remove.md +48 -0
  130. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  131. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  132. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  133. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  134. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  135. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  136. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  137. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  138. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  139. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  140. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  141. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  142. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  143. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  144. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  145. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  146. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  147. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  148. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  149. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  150. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  151. package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
  152. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  153. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  154. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  155. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  156. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +103 -0
  157. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  158. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  159. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  160. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  161. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  162. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  163. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  164. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  165. package/docs/docs/cmd/request.md +74 -0
  166. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +65 -0
  167. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  168. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  169. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  170. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  171. package/docs/docs/cmd/spo/list/list-contenttype-add.md +1 -1
  172. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +1 -1
  173. package/docs/docs/cmd/spo/list/list-contenttype-list.md +1 -1
  174. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +1 -1
  175. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +2 -2
  176. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +2 -2
  177. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +18 -3
  178. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  179. package/docs/docs/cmd/spo/navigation/navigation-node-list.md +30 -0
  180. package/docs/docs/cmd/spo/navigation/navigation-node-remove.md +1 -1
  181. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +59 -0
  182. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  183. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  184. package/docs/docs/cmd/spo/web/web-set.md +9 -0
  185. package/docs/docs/cmd/status.md +46 -0
  186. package/docs/docs/cmd/version.md +26 -0
  187. package/npm-shrinkwrap.json +911 -876
  188. package/package.json +12 -12
@@ -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
@@ -0,0 +1,60 @@
1
+ # planner roster add
2
+
3
+ Creates a new Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Remarks
16
+
17
+ !!! attention
18
+ The Roster will be automatically deleted when it doesn't contain a plan 24 hours after its creation. Membership information will be completely erased within 30 days of this deletion.
19
+
20
+ !!! attention
21
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
22
+
23
+ !!! important
24
+ To be able to create a new Roster, the Planner Roster creation tenant setting should be enabled. Use the [planner tenant settings list](../tenant/tenant-settings-list.md) command to check if this setting is enabled for your tenant.
25
+
26
+ ## Examples
27
+
28
+ Creates a new Microsoft Planner Roster
29
+
30
+ ```sh
31
+ m365 planner roster add
32
+ ```
33
+
34
+ ## Response
35
+
36
+ === "JSON"
37
+
38
+ ```json
39
+ {
40
+ "id": "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
41
+ "assignedSensitivityLabel": null
42
+ }
43
+ ```
44
+
45
+ === "Text"
46
+
47
+ ```text
48
+ assignedSensitivityLabel: null
49
+ id : e6fmvM_yi0OJgvmepE5uj5cAE6qX
50
+ ```
51
+
52
+ === "CSV"
53
+
54
+ ```csv
55
+ id,assignedSensitivityLabel
56
+ e6fmvM_yi0OJgvmepE5uj5cAE6qX,
57
+ ```
58
+
59
+ ## Additional information
60
+ Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -0,0 +1,73 @@
1
+ # planner roster get
2
+
3
+ Gets information about the specific Microsoft Planner Roster.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id <id>`
14
+ : ID of the Planner Roster.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! attention
21
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
22
+
23
+ ## Examples
24
+
25
+ Gets information about a specific Planner Roster.
26
+
27
+ ```sh
28
+ m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
29
+ ```
30
+
31
+ ## Response
32
+
33
+ === "JSON"
34
+
35
+ ```json
36
+ {
37
+ "id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
38
+ "assignedSensitivityLabel": null
39
+ }
40
+ ```
41
+
42
+ === "Text"
43
+
44
+ ```text
45
+ assignedSensitivityLabel: null
46
+ id : tYqYlNd6eECmsNhN_fcq85cAGAnd
47
+ ```
48
+
49
+ === "CSV"
50
+
51
+ ```csv
52
+ id,assignedSensitivityLabel
53
+ tYqYlNd6eECmsNhN_fcq85cAGAnd,
54
+ ```
55
+
56
+ === "Markdown"
57
+
58
+ ```md
59
+ # planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
60
+
61
+ Date: 1/30/2023
62
+
63
+ ## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
64
+
65
+ Property | Value
66
+ ---------|-------
67
+ id | tYqYlNd6eECmsNhN_fcq85cAGAnd
68
+ assignedSensitivityLabel | null
69
+ ```
70
+
71
+ ## Additional information
72
+
73
+ Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -0,0 +1,87 @@
1
+ # planner roster member add
2
+
3
+ Adds a user to a Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--rosterId <rosterId>`
14
+ : ID of the Planner Roster.
15
+
16
+ `--userId [userId]`
17
+ : User's Azure AD ID. Specify either `userId`, `userName` but not both.
18
+
19
+ `--userName [userName]`
20
+ : User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId`, `userName` but not both.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! attention
27
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
+
29
+ ## Examples
30
+
31
+ Adds a specific user by user name as member of the Planner Roster
32
+
33
+ ```sh
34
+ m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
35
+ ```
36
+
37
+ Adds a specific user by ID as member of the Planner Roster
38
+
39
+ ```sh
40
+ m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
41
+ ```
42
+
43
+ ## Response
44
+
45
+ === "JSON"
46
+
47
+ ```json
48
+ {
49
+ "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
50
+ "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
51
+ "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
52
+ "roles": []
53
+ }
54
+ ```
55
+
56
+ === "Text"
57
+
58
+ ```text
59
+ id : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
60
+ roles : []
61
+ tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
62
+ userId : 2056d2f6-3257-4253-8cfc-b73393e414e5
63
+ ```
64
+
65
+ === "CSV"
66
+
67
+ ```csv
68
+ id,userId,tenantId,roles
69
+ b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
70
+ ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # planner roster member add --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
76
+
77
+ Date: 6/2/2023
78
+
79
+ ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
80
+
81
+ Property | Value
82
+ ---------|-------
83
+ id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
84
+ userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
85
+ tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
86
+ roles | []
87
+ ```
@@ -0,0 +1,76 @@
1
+ # planner roster member list
2
+
3
+ Lists members of the specified Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--rosterId <rosterId>`
14
+ : ID of the Planner Roster.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! attention
21
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
22
+
23
+ ## Examples
24
+
25
+ Lists members of the specified Microsoft Planner Roster
26
+
27
+ ```sh
28
+ m365 planner roster member list --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd
29
+ ```
30
+
31
+ ## Response
32
+
33
+ === "JSON"
34
+
35
+ ```json
36
+ [
37
+ {
38
+ "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
39
+ "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
40
+ "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
41
+ "roles": []
42
+ }
43
+ ]
44
+ ```
45
+
46
+ === "Text"
47
+
48
+ ```text
49
+ id userId tenantId roles
50
+ ------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
51
+ b3a1be03-54a5-43d2-b4fb-6562fe9bec0b 2056d2f6-3257-4253-8cfc-b73393e414e5 5b7b813c-2339-48cd-8c51-bd4fcb269420 []
52
+ ```
53
+
54
+ === "CSV"
55
+
56
+ ```csv
57
+ id,userId,tenantId,roles
58
+ b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
59
+ ```
60
+
61
+ === "Markdown"
62
+
63
+ ```md
64
+ # planner roster member list --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
65
+
66
+ Date: 5/2/2023
67
+
68
+ ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
69
+
70
+ Property | Value
71
+ ---------|-------
72
+ id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
73
+ userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
74
+ tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
75
+ roles | []
76
+ ```
@@ -0,0 +1,51 @@
1
+ # planner roster member remove
2
+
3
+ Removes a member from a Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--rosterId <rosterId>`
14
+ : ID of the Planner Roster.
15
+
16
+ `--userId [userId]`
17
+ : User's Azure AD ID. Specify either `userId` or `userName` but not both.
18
+
19
+ `--userName [userName]`
20
+ : User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirmation.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ !!! attention
30
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
31
+
32
+ !!! attention
33
+ The Planner Roster will be deleted when it doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation. We will show an extra prompt when this happens. This prompt is also suppressed when specifying `--confirm`.
34
+
35
+ ## Examples
36
+
37
+ Remove a Roster member by its Azure AD ID
38
+
39
+ ```sh
40
+ m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
41
+ ```
42
+
43
+ Remove a Roster member by its UPN
44
+
45
+ ```sh
46
+ m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
47
+ ```
48
+
49
+ ## Response
50
+
51
+ The command won't return a response on success.
@@ -0,0 +1,48 @@
1
+ # planner roster remove
2
+
3
+ Removes a Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id <id>`
14
+ : ID of the Planner Roster.
15
+
16
+ `--confirm`
17
+ : Don't prompt for confirmation.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Remarks
22
+
23
+ !!! attention
24
+ Deleting a Planner Roster will also delete the plan within the Roster.
25
+
26
+ !!! attention
27
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
+
29
+ ## Examples
30
+
31
+ Removes a Planner Roster
32
+
33
+ ```sh
34
+ m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd
35
+ ```
36
+
37
+ Removes a Planner Roster without confirmation prompt
38
+
39
+ ```sh
40
+ m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd --confirm
41
+ ```
42
+
43
+ ## Response
44
+
45
+ The command won't return a response on success.
46
+
47
+ ## Additional information
48
+ Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -97,3 +97,46 @@ m365 pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340a
97
97
  msdyn_name,msdyn_aimodelid,createdon,modifiedon
98
98
  "Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
99
99
  ```
100
+
101
+ === "Markdown"
102
+
103
+ ```md
104
+ # pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "08ffffbe-ec1c-4e64-b64b-dd1db926c613"
105
+
106
+ Date: 6/2/2023
107
+
108
+ Property | Value
109
+ ---------|-------
110
+ overwritetime | 1900-01-01T00:00:00Z
111
+ msdyn\_aimodelid | 08ffffbe-ec1c-4e64-b64b-dd1db926c613
112
+ \_owningbusinessunit\_value | 6da087c1-1c4d-ed11-bba1-000d3a2caf7f
113
+ solutionid | fd140aae-4df4-11dd-bd17-0019b9312238
114
+ msdyn\_aimodelidunique | b0802b54-1dbe-4bb0-812a-8579549e9144
115
+ introducedversion | 1.0
116
+ \_owninguser\_value | 2311d2bd-1b41-e911-a9aa-000d3a2d57c3
117
+ msdyn\_name | Document Processing 11/29/2022, 12:58:43 PM
118
+ statecode | 0
119
+ statuscode | 0
120
+ ismanaged | false
121
+ \_ownerid\_value | 2311d2bd-1b41-e911-a9aa-000d3a2d57c3
122
+ componentstate | 0
123
+ modifiedon | 2019-09-20T13:34:04Z
124
+ \_msdyn\_templateid\_value | 10707e4e-1d56-e911-8194-000d3a6cd5a5
125
+ \_modifiedby\_value | 2311d2bd-1b41-e911-a9aa-000d3a2d57c3
126
+ versionnumber | 8076095
127
+ createdon | 2019-09-20T13:34:04Z
128
+ \_createdby\_value | 2311d2bd-1b41-e911-a9aa-000d3a2d57c3
129
+ \_msdyn\_activerunconfigurationid\_value | null
130
+ overriddencreatedon | null
131
+ \_msdyn\_retrainworkflowid\_value | null
132
+ msdyn\_modelcreationcontext | null
133
+ importsequencenumber | null
134
+ msdyn\_sharewithorganizationoncreate | null
135
+ \_msdyn\_scheduleinferenceworkflowid\_value | null
136
+ \_modifiedonbehalfby\_value | null
137
+ utcconversiontimezonecode | null
138
+ \_createdonbehalfby\_value | null
139
+ \_owningteam\_value | null
140
+ timezoneruleversionnumber | null
141
+ iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
142
+ ```
@@ -93,3 +93,46 @@ m365 pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340
93
93
  msdyn_name,msdyn_aimodelid,createdon,modifiedon
94
94
  "Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
95
95
  ```
96
+
97
+ === "Markdown"
98
+
99
+ ```md
100
+ # pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
101
+
102
+ Date: 9/1/2023
103
+
104
+ Property | Value
105
+ ---------|-------
106
+ statecode | 0
107
+ \_msdyn\_templateid\_value | 10707e4e-1d56-e911-8194-000d3a6cd5a5
108
+ msdyn\_modelcreationcontext | {}
109
+ createdon | 2022-11-29T11:58:45Z
110
+ \_ownerid\_value | 5fa787c1-1c4d-ed11-bba1-000d3a2caf7f
111
+ modifiedon | 2022-11-29T11:58:45Z
112
+ msdyn\_sharewithorganizationoncreate | false
113
+ msdyn\_aimodelidunique | b0328b67-47e2-4202-8189-e617ec9a88bd
114
+ solutionid | fd140aae-4df4-11dd-bd17-0019b9312238
115
+ ismanaged | false
116
+ versionnumber | 1458121
117
+ msdyn\_name | Document Processing 11/29/2022, 12:58:43 PM
118
+ introducedversion | 1.0
119
+ statuscode | 0
120
+ \_modifiedby\_value | 5fa787c1-1c4d-ed11-bba1-000d3a2caf7f
121
+ overwritetime | 1900-01-01T00:00:00Z
122
+ componentstate | 0
123
+ \_createdby\_value | 5fa787c1-1c4d-ed11-bba1-000d3a2caf7f
124
+ \_owningbusinessunit\_value | 6da087c1-1c4d-ed11-bba1-000d3a2caf7f
125
+ \_owninguser\_value | 5fa787c1-1c4d-ed11-bba1-000d3a2caf7f
126
+ msdyn\_aimodelid | 08ffffbe-ec1c-4e64-b64b-dd1db926c613
127
+ \_msdyn\_activerunconfigurationid\_value | null
128
+ overriddencreatedon | null
129
+ \_msdyn\_retrainworkflowid\_value | null
130
+ importsequencenumber | null
131
+ \_msdyn\_scheduleinferenceworkflowid\_value | null
132
+ \_modifiedonbehalfby\_value | null
133
+ utcconversiontimezonecode | null
134
+ \_createdonbehalfby\_value | null
135
+ \_owningteam\_value | null
136
+ timezoneruleversionnumber | null
137
+ iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
138
+ ```
@@ -75,3 +75,15 @@ m365 pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
75
75
  CardIdClone
76
76
  80cff342-ddf1-4633-aec1-6d3d131b29e0
77
77
  ```
78
+
79
+ === "Markdown"
80
+
81
+ ```md
82
+ # pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --newName "CLI 365 new Card"
83
+
84
+ Date: 9/1/2023
85
+
86
+ Property | Value
87
+ ---------|-------
88
+ CardIdClone | 90460614-6ede-4231-8467-ce99a6359f45
89
+ ```