@pnp/cli-microsoft365 6.11.0-beta.7edcad2 → 6.11.0-beta.cb74646

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 (163) hide show
  1. package/dist/Auth.js +2 -1
  2. package/dist/Command.js +1 -1
  3. package/dist/m365/cli/commands/config/config-list.js +29 -0
  4. package/dist/m365/cli/commands.js +1 -0
  5. package/dist/m365/pa/commands/app/app-permission-ensure.js +177 -0
  6. package/dist/m365/pa/commands/app/app-permission-remove.js +170 -0
  7. package/dist/m365/pa/commands.js +2 -0
  8. package/dist/m365/planner/commands/bucket/bucket-add.js +2 -2
  9. package/dist/m365/planner/commands/bucket/bucket-get.js +2 -2
  10. package/dist/m365/planner/commands/bucket/bucket-list.js +2 -2
  11. package/dist/m365/planner/commands/bucket/bucket-remove.js +2 -2
  12. package/dist/m365/planner/commands/bucket/bucket-set.js +2 -2
  13. package/dist/m365/planner/commands/plan/plan-get.js +1 -2
  14. package/dist/m365/planner/commands/plan/plan-list.js +4 -5
  15. package/dist/m365/planner/commands/plan/plan-set.js +2 -2
  16. package/dist/m365/planner/commands/task/task-add.js +17 -11
  17. package/dist/m365/planner/commands/task/task-get.js +35 -25
  18. package/dist/m365/planner/commands/task/task-list.js +26 -19
  19. package/dist/m365/planner/commands/task/task-remove.js +40 -35
  20. package/dist/m365/planner/commands/task/task-set.js +35 -23
  21. package/dist/m365/spfx/commands/project/DeployWorkflow.js +58 -0
  22. package/dist/m365/spfx/commands/project/project-doctor/{doctor-1.18.0-beta.1.js → doctor-1.18.0-beta.5.js} +1 -1
  23. package/dist/m365/spfx/commands/project/project-doctor.js +1 -1
  24. package/dist/m365/spfx/commands/project/project-externalize/rules/PnPJsRule.js +34 -23
  25. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +171 -0
  26. package/dist/m365/spfx/commands/project/project-github-workflow-model.js +3 -0
  27. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +1 -1
  28. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.18.0-beta.1.js → upgrade-1.18.0-beta.5.js} +26 -26
  29. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  30. package/dist/m365/spfx/commands/spfx-doctor.js +35 -51
  31. package/dist/m365/spfx/commands.js +1 -0
  32. package/dist/m365/spo/commands/app/SpoAppBaseCommand.js +26 -14
  33. package/dist/m365/spo/commands/app/app-add.js +9 -9
  34. package/dist/m365/spo/commands/file/file-add.js +13 -13
  35. package/dist/m365/spo/commands/file/file-checkin.js +1 -1
  36. package/dist/m365/spo/commands/file/file-checkout.js +1 -1
  37. package/dist/m365/spo/commands/file/file-copy.js +38 -4
  38. package/dist/m365/spo/commands/file/file-list.js +4 -4
  39. package/dist/m365/spo/commands/file/file-move.js +2 -2
  40. package/dist/m365/spo/commands/file/file-remove.js +6 -6
  41. package/dist/m365/spo/commands/file/file-rename.js +2 -2
  42. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +1 -1
  43. package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +1 -1
  44. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  45. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +1 -1
  46. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  47. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  48. package/dist/m365/spo/commands/file/file-version-clear.js +1 -1
  49. package/dist/m365/spo/commands/file/file-version-get.js +1 -1
  50. package/dist/m365/spo/commands/file/file-version-list.js +1 -1
  51. package/dist/m365/spo/commands/file/file-version-remove.js +1 -1
  52. package/dist/m365/spo/commands/file/file-version-restore.js +1 -1
  53. package/dist/m365/spo/commands/folder/folder-add.js +2 -4
  54. package/dist/m365/spo/commands/folder/folder-get.js +1 -1
  55. package/dist/m365/spo/commands/folder/folder-list.js +2 -2
  56. package/dist/m365/spo/commands/folder/folder-remove.js +7 -4
  57. package/dist/m365/spo/commands/folder/folder-rename.js +13 -17
  58. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  59. package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +1 -1
  60. package/dist/m365/spo/commands/folder/folder-roleassignment-add.js +1 -1
  61. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +1 -1
  62. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +1 -1
  63. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +1 -1
  64. package/dist/m365/spo/commands/group/group-list.js +0 -1
  65. package/dist/m365/spo/commands/navigation/navigation-node-set.js +2 -2
  66. package/dist/m365/spo/commands/orgassetslibrary/orgassetslibrary-add.js +32 -3
  67. package/dist/m365/spo/commands/page/Page.js +24 -32
  68. package/dist/m365/spo/commands/propertybag/propertybag-base.js +75 -54
  69. package/dist/m365/spo/commands/propertybag/propertybag-remove.js +41 -40
  70. package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-set.js +32 -32
  71. package/dist/m365/spo/commands/site/FlowsPolicy.js +10 -0
  72. package/dist/m365/spo/commands/site/site-add.js +113 -154
  73. package/dist/m365/spo/commands/site/site-apppermission-add.js +26 -27
  74. package/dist/m365/spo/commands/site/site-apppermission-remove.js +37 -37
  75. package/dist/m365/spo/commands/site/site-apppermission-set.js +15 -16
  76. package/dist/m365/spo/commands/site/site-ensure.js +19 -70
  77. package/dist/m365/spo/commands/site/site-hubsite-disconnect.js +24 -22
  78. package/dist/m365/spo/commands/site/site-list.js +28 -36
  79. package/dist/m365/spo/commands/site/site-remove.js +139 -171
  80. package/dist/m365/spo/commands/site/site-set.js +179 -178
  81. package/dist/m365/spo/commands/theme/theme-remove.js +26 -24
  82. package/dist/m365/spo/commands/theme/theme-set.js +0 -1
  83. package/dist/m365/spo/commands/user/user-remove.js +29 -27
  84. package/dist/m365/spo/commands/web/web-reindex.js +17 -20
  85. package/dist/m365/spo/commands/web/web-remove.js +23 -21
  86. package/dist/m365/spo/commands/web/web-roleassignment-add.js +45 -52
  87. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +58 -61
  88. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +20 -18
  89. package/dist/m365/spo/commands/web/web-roleinheritance-reset.js +21 -19
  90. package/dist/m365/yammer/commands/message/message-like-set.js +29 -28
  91. package/dist/m365/yammer/commands/message/message-list.js +9 -26
  92. package/dist/m365/yammer/commands/message/message-remove.js +20 -18
  93. package/dist/m365/yammer/commands/yammer-search.js +42 -56
  94. package/dist/utils/aadGroup.js +20 -0
  95. package/dist/utils/fsUtil.js +5 -0
  96. package/dist/utils/planner.js +6 -3
  97. package/dist/utils/spo.js +601 -1
  98. package/docs/docs/cmd/aad/user/user-set.mdx +1 -1
  99. package/docs/docs/cmd/cli/config/config-list.mdx +78 -0
  100. package/docs/docs/cmd/flow/flow-enable.mdx +2 -2
  101. package/docs/docs/cmd/login.mdx +6 -0
  102. package/docs/docs/cmd/pa/app/app-permission-ensure.mdx +85 -0
  103. package/docs/docs/cmd/pa/app/app-permission-remove.mdx +74 -0
  104. package/docs/docs/cmd/planner/task/task-add.mdx +22 -7
  105. package/docs/docs/cmd/planner/task/task-get.mdx +13 -4
  106. package/docs/docs/cmd/planner/task/task-list.mdx +22 -7
  107. package/docs/docs/cmd/planner/task/task-remove.mdx +25 -8
  108. package/docs/docs/cmd/planner/task/task-set.mdx +22 -7
  109. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +2 -2
  110. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +2 -2
  111. package/docs/docs/cmd/pp/dataverse/dataverse-table-remove.mdx +3 -3
  112. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +94 -0
  113. package/docs/docs/cmd/spo/file/file-add.mdx +1 -1
  114. package/docs/docs/cmd/spo/file/file-checkin.mdx +1 -1
  115. package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -9
  116. package/docs/docs/cmd/spo/file/file-checkout.mdx +1 -1
  117. package/docs/docs/cmd/spo/file/file-copy.mdx +20 -16
  118. package/docs/docs/cmd/spo/file/file-get.mdx +1 -1
  119. package/docs/docs/cmd/spo/file/file-list.mdx +2 -2
  120. package/docs/docs/cmd/spo/file/file-move.mdx +2 -2
  121. package/docs/docs/cmd/spo/file/file-remove.mdx +8 -8
  122. package/docs/docs/cmd/spo/file/file-rename.mdx +3 -3
  123. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +2 -2
  124. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +3 -3
  125. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
  126. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  127. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  128. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  129. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +1 -1
  130. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +1 -1
  131. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +1 -1
  132. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +1 -1
  133. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +1 -1
  134. package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +1 -1
  135. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +1 -1
  136. package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
  137. package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
  138. package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
  139. package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
  140. package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
  141. package/docs/docs/cmd/spo/folder/folder-add.mdx +76 -1
  142. package/docs/docs/cmd/spo/folder/folder-get.mdx +1 -1
  143. package/docs/docs/cmd/spo/folder/folder-list.mdx +1 -1
  144. package/docs/docs/cmd/spo/folder/folder-remove.mdx +1 -1
  145. package/docs/docs/cmd/spo/folder/folder-rename.mdx +5 -1
  146. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
  147. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
  148. package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +2 -2
  149. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +1 -1
  150. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +1 -1
  151. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +1 -1
  152. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +1 -1
  153. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +14 -1
  154. package/docs/docs/cmd/spo/site/site-ensure.mdx +1 -1
  155. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +1 -1
  156. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +1 -1
  157. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +1 -1
  158. package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +1 -1
  159. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +1 -1
  160. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +1 -1
  161. package/docs/docs/cmd/yammer/network/network-list.mdx +1 -1
  162. package/npm-shrinkwrap.json +698 -345
  163. package/package.json +15 -14
@@ -0,0 +1,78 @@
1
+ import CLISettings from '/docs/_clisettings.mdx';
2
+ import Global from '/docs/cmd/_global.mdx';
3
+ import Tabs from '@theme/Tabs';
4
+ import TabItem from '@theme/TabItem';
5
+
6
+ # cli config list
7
+
8
+ List all self set CLI for Microsoft 365 configurations
9
+
10
+ ## Usage
11
+
12
+ ```sh
13
+ m365 cli config list [options]
14
+ ```
15
+
16
+ ## Options
17
+
18
+ <Global />
19
+
20
+ ## Available settings
21
+
22
+ Following is the list of configuration settings available in CLI for Microsoft 365.
23
+
24
+ <CLISettings />
25
+
26
+ ## Examples
27
+
28
+ List all self set configuration keys with their value
29
+
30
+ ```sh
31
+ m365 cli config list
32
+ ```
33
+
34
+ ## Response
35
+
36
+ <Tabs>
37
+ <TabItem value="JSON">
38
+
39
+ ```json
40
+ {
41
+ "errorOutput": "stdout"
42
+ }
43
+ ```
44
+
45
+ </TabItem>
46
+ <TabItem value="Text">
47
+
48
+ ```text
49
+ errorOutput: stdout
50
+ ```
51
+
52
+ </TabItem>
53
+ <TabItem value="CSV">
54
+
55
+ ```csv
56
+ errorOutput
57
+ stdout
58
+ ```
59
+
60
+ </TabItem>
61
+ <TabItem value="Markdown">
62
+
63
+ ```md
64
+ # cli config list
65
+
66
+ Date: 29/6/2023
67
+
68
+ Property | Value
69
+ ---------|-------
70
+ errorOutput | stdout
71
+ ```
72
+
73
+ </TabItem>
74
+ </Tabs>
75
+
76
+ ## More information
77
+
78
+ - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.mdx)
@@ -44,13 +44,13 @@ If the Power Automate flow with the name you specified doesn't exist, you will g
44
44
  Enables Power Automate flow owned by the currently signed-in user
45
45
 
46
46
  ```sh
47
- m365 flow enable --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
47
+ m365 flow enable --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
48
48
  ```
49
49
 
50
50
  Enables Power Automate flow owned by another user
51
51
 
52
52
  ```sh
53
- m365 flow enable --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
53
+ m365 flow enable --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
54
54
  ```
55
55
 
56
56
  ## Response
@@ -157,6 +157,12 @@ Log in to Microsoft 365 using your own Azure AD application that's restricted on
157
157
  m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
158
158
  ```
159
159
 
160
+ Log in to Microsoft 365 using your own Azure AD application and a personal information exchange (.pfx) file
161
+
162
+ ```sh
163
+ m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
164
+ ```
165
+
160
166
  Log in to Microsoft 365 using the interactive browser authentication. Uses the identity of the current user.
161
167
 
162
168
  ```sh
@@ -0,0 +1,85 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # pa app permission ensure
4
+
5
+ Assigns/updates permissions to a Power Apps app
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 pa app permission ensure [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `--appName <appName>`
17
+ : The name (GUID) of the Microsoft Power App.
18
+
19
+ `--roleName <roleName>`
20
+ : Permission level given to the app. Valid values: `CanEdit`, `CanView`. Sharing with the entire tenant is only supported with `CanView` role.
21
+
22
+ `--userId [userId]`
23
+ : The Azure AD ID of the user. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
24
+
25
+ `--userName [userName]`
26
+ : The user principal name of the user. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
27
+
28
+ `--groupId [groupId]`
29
+ : The Azure AD ID of the group. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
30
+
31
+ `--groupName [groupName]`
32
+ : The name of the Azure AD group. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
33
+
34
+ `--tenant`
35
+ : Share the app with the entire tenant. When specifying this, only `CanView` role is supported. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
36
+
37
+ `--sendInvitationMail`
38
+ : When set, an invitation mail will be sent.
39
+
40
+ `--asAdmin`
41
+ : Run the command as admin for apps you don't own.
42
+
43
+ `-e, --environmentName [environmentName]`
44
+ : The name of the environment. Specify only a value when running the command as admin.
45
+ ```
46
+
47
+ <Global />
48
+
49
+ ## Remarks
50
+
51
+ :::note
52
+
53
+ When specifying a value for `groupId` or `groupName`, note that you can only grant permissions to security groups.
54
+
55
+ :::
56
+
57
+ ## Examples
58
+
59
+ Share a Power App app with another user with run-only permissions
60
+
61
+ ```sh
62
+ m365 pa app permission ensure --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --userName john.doe@contoso.com --roleName CanView --sendInvitationMail
63
+ ```
64
+
65
+ Add co-owner permissions for a security group to a Power Apps app
66
+
67
+ ```sh
68
+ m365 pa app permission ensure --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --groupName Developers --roleName CanEdit
69
+ ```
70
+
71
+ Add permissions as admin to a Power App app that you do not own
72
+
73
+ ```sh
74
+ m365 pa app permission ensure --environment Default-e535e809-c6a1-47b5-8951-d0898a64bf8a --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --userId 42a28ec6-972f-4fdd-b483-50ee4b237f91 --roleName CanEdit --asAdmin
75
+ ```
76
+
77
+ Share a Power Apps app with everyone in the tenant
78
+
79
+ ```sh
80
+ m365 pa app permission ensure --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --roleName CanView --tenant
81
+ ```
82
+
83
+ ## Response
84
+
85
+ The command won't return a response on success.
@@ -0,0 +1,74 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # pa app permission remove
4
+
5
+ Removes permissions to a Power Apps app
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 pa app permission remove [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `--appName <appName>`
17
+ : The name (GUID) of the Microsoft Power App.
18
+
19
+ `--userId [userId]`
20
+ : The Azure AD ID of the user. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
21
+
22
+ `--userName [userName]`
23
+ : The user principal name of the user. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
24
+
25
+ `--groupId [groupId]`
26
+ : The Azure AD ID of the group. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
27
+
28
+ `--groupName [groupName]`
29
+ : The name of the Azure AD group. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
30
+
31
+ `--tenant`
32
+ : When specifying this, tenant permissions (everyone in the tenant) will be removed. Specify either `userId`, `userName`, `groupId`, `groupName`, or `tenant`.
33
+
34
+ `--asAdmin`
35
+ : Run the command as admin for apps you don't own.
36
+
37
+ `-e, --environmentName [environmentName]`
38
+ : The name of the environment. Specify only a value when running the command as admin.
39
+
40
+ `--confirm`
41
+ : Don't prompt for confirmation.
42
+ ```
43
+
44
+ <Global />
45
+
46
+ ## Examples
47
+
48
+ Remove permissions of a specific user for a specific app
49
+
50
+ ```sh
51
+ m365 pa app permission remove --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --userName john.doe@contoso.com
52
+ ```
53
+
54
+ Remove permissions of a specific security group for a specific app
55
+
56
+ ```sh
57
+ m365 pa app permission remove --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --groupName Developers
58
+ ```
59
+
60
+ Removes permissions as administrator for an app which you do not own
61
+
62
+ ```sh
63
+ m365 pa app permission remove --environment Default-e535e809-c6a1-47b5-8951-d0898a64bf8a --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --userId 42a28ec6-972f-4fdd-b483-50ee4b237f91 --asAdmin
64
+ ```
65
+
66
+ Unshare a Power Apps app with the entire tenant
67
+
68
+ ```sh
69
+ m365 pa app permission remove --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --tenant
70
+ ```
71
+
72
+ ## Response
73
+
74
+ The command won't return a response on success.
@@ -19,10 +19,13 @@ m365 planner task add [options]
19
19
  : Title of the task to add.
20
20
 
21
21
  `--planId [planId]`
22
- : ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
22
+ : ID of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
23
23
 
24
24
  `--planTitle [planTitle]`
25
- : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
25
+ : Title of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
+
27
+ `--rosterId [rosterId]`
28
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
29
 
27
30
  `--ownerGroupId [ownerGroupId]`
28
31
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -89,38 +92,50 @@ When you specify an integer value for `priority`, consider the following:
89
92
 
90
93
  When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
91
94
 
95
+ :::caution
96
+
97
+ 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.
98
+
99
+ :::
100
+
92
101
  ## Examples
93
102
 
94
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
103
+ Adds a Microsoft Planner task with the name for plan with the specified ID and specified bucket with the ID.
95
104
 
96
105
  ```sh
97
106
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
98
107
  ```
99
108
 
100
- Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
109
+ Adds a Completed Microsoft Planner task with the name for plan with the specified title owned by specified group and the specified bucket with the ID.
101
110
 
102
111
  ```sh
103
112
  m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
104
113
  ```
105
114
 
106
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to several users and receive a due date for _2021-12-16_
115
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and bucket with the ID. The new task will be assigned to the specified users and receive a specified due date.
107
116
 
108
117
  ```sh
109
118
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
110
119
  ```
111
120
 
112
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to several users who will appear first with the asssignee priority _' !'_
121
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and bucket with the ID. The new task will be assigned to the specified users who will appear first with the asssignee priority _' !'_
113
122
 
114
123
  ```sh
115
124
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --asssigneePriority ' !'
116
125
  ```
117
126
 
118
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will receive the categories _category1,category3_ and get a preview with the type _noPreview_
127
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and the bucket with the ID. The new task will receive the specified categories and get a specified preview with the type.
119
128
 
120
129
  ```sh
121
130
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"
122
131
  ```
123
132
 
133
+ Adds a Microsoft Planner task with the specified name for the plan with the specified rosterId and bucket with the ID.
134
+
135
+ ```sh
136
+ m365 planner task add --title "My Planner Task" --rosterId "DjL5xiKO10qut8LQgztpKskABWna" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
137
+ ```
138
+
124
139
  ## Response
125
140
 
126
141
  ### Standard response
@@ -28,10 +28,13 @@ m365 planner task get [options]
28
28
  : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
29
29
 
30
30
  `--planId [planId]`
31
- : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
31
+ : ID of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
32
32
 
33
33
  `--planTitle [planTitle]`
34
- : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
34
+ : Title of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
+
36
+ `--rosterId [rosterId]`
37
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
38
 
36
39
  `--ownerGroupId [ownerGroupId]`
37
40
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -44,18 +47,24 @@ m365 planner task get [options]
44
47
 
45
48
  ## Examples
46
49
 
47
- Retrieve the specified planner task by id
50
+ Returns the Microsoft Planner task by id.
48
51
 
49
52
  ```sh
50
53
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
51
54
  ```
52
55
 
53
- Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_.
56
+ Retrieve the Microsoft Planner task by title from the specified bucket. Based on the specified plan with the title owned by the specified group.
54
57
 
55
58
  ```sh
56
59
  m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
57
60
  ```
58
61
 
62
+ Returns the Microsoft Planner task by rosterId from the specified bucket.
63
+
64
+ ```sh
65
+ m365 planner task get --title "New Task" --bucketName "To do" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
66
+ ```
67
+
59
68
  ## Response
60
69
 
61
70
  <Tabs>
@@ -22,10 +22,13 @@ m365 planner task list [options]
22
22
  : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
23
23
 
24
24
  `--planId [planId]`
25
- : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
25
+ : ID of a plan to list the tasks of. To retrieve all tasks from a plan, Specify either `planId`, `planTitle`, or `rosterId` but not multiple. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
26
26
 
27
27
  `--planTitle [planTitle]`
28
- : Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
28
+ : Title of a plan to list the tasks of. To retrieve all tasks from a plan, Specify either `planId`, `planTitle`, or `rosterId` but not multiple. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
29
+
30
+ `--rosterId [rosterId]`
31
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
29
32
 
30
33
  `--ownerGroupId [ownerGroupId]`
31
34
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -44,6 +47,12 @@ This command uses API that is currently in preview to enrich the results with th
44
47
 
45
48
  :::
46
49
 
50
+ :::caution
51
+
52
+ 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.
53
+
54
+ :::
55
+
47
56
  ## Examples
48
57
 
49
58
  List tasks for the currently logged in user
@@ -52,36 +61,42 @@ List tasks for the currently logged in user
52
61
  m365 planner task list
53
62
  ```
54
63
 
55
- List the Microsoft Planner tasks in the plan _iVPMIgdku0uFlou-KLNg6MkAE1O2_
64
+ List the Microsoft Planner tasks in the plan by id.
56
65
 
57
66
  ```sh
58
67
  m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
59
68
  ```
60
69
 
61
- List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
70
+ List the Microsoft Planner tasks in the specified plan by title from the specified group by name.
62
71
 
63
72
  ```sh
64
73
  m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
65
74
  ```
66
75
 
67
- List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
76
+ List the Microsoft Planner tasks in the bucket by id.
68
77
 
69
78
  ```sh
70
79
  m365 planner task list --bucketId "FtzysDykv0-9s9toWiZhdskAD67z"
71
80
  ```
72
81
 
73
- List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _iVPMIgdku0uFlou-KLNg6MkAE1O2_
82
+ List the Microsoft Planner tasks in the bucket by name belonging to plan by id.
74
83
 
75
84
  ```sh
76
85
  m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"
77
86
  ```
78
87
 
79
- List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
88
+ List the Microsoft Planner tasks in the bucket by name belonging to plan by title in the specified group.
80
89
 
81
90
  ```sh
82
91
  m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
83
92
  ```
84
93
 
94
+ List the Microsoft Planner tasks by rosterId from the specified bucket.
95
+
96
+ ```sh
97
+ m365 planner task list --bucketName "My Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
98
+ ```
99
+
85
100
  ## Response
86
101
 
87
102
  <Tabs>
@@ -26,10 +26,13 @@ m365 planner task remove [options]
26
26
  : Name of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
27
27
 
28
28
  `--planId [planId]`
29
- : ID of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
29
+ : ID of the plan to which the task to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
30
30
 
31
31
  `--planTitle [planTitle]`
32
- : Title of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
32
+ : Title of the plan to which the task to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
33
+
34
+ `--rosterId [rosterId]`
35
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
33
36
 
34
37
  `--ownerGroupId [ownerGroupId]`
35
38
  : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -43,44 +46,58 @@ m365 planner task remove [options]
43
46
 
44
47
  <Global />
45
48
 
49
+ ## Remarks
50
+
51
+ :::caution
52
+
53
+ 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.
54
+
55
+ :::
56
+
46
57
  ## Examples
47
58
 
48
- Removes the Microsoft Planner task by ID
59
+ Removes the Microsoft Planner task by ID.
49
60
 
50
61
  ```sh
51
62
  m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
52
63
  ```
53
64
 
54
- Removes the Microsoft Planner task by ID without confirmation
65
+ Removes the Microsoft Planner task by ID without confirmation.
55
66
 
56
67
  ```sh
57
68
  m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
58
69
  ```
59
70
 
60
- Removes the Microsoft Planner task with title _My Task_ in the bucket with ID _vncYUXCRBke28qMLB-d4xJcACtNz_
71
+ Removes the Microsoft Planner task with the specified title in the bucket by ID.
61
72
 
62
73
  ```sh
63
74
  m365 planner task remove --title "My Task" --bucketId "vncYUXCRBke28qMLB-d4xJcACtNz"
64
75
  ```
65
76
 
66
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
77
+ Removes the Microsoft Planner task with the specified title the bucket by name in the Plan with the specified ID.
67
78
 
68
79
  ```sh
69
80
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
70
81
  ```
71
82
 
72
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
83
+ Removes the Microsoft Planner task with the specified title in the bucket with name in the Plan owned by group with the specified name.
73
84
 
74
85
  ```sh
75
86
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
76
87
  ```
77
88
 
78
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
89
+ Removes the Microsoft Planner task with the specified title in the bucket with name in the Plan owned by group with the specified ID.
79
90
 
80
91
  ```sh
81
92
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
82
93
  ```
83
94
 
95
+ Removes the Microsoft Planner task by rosterId from the specified bucket.
96
+
97
+ ```sh
98
+ m365 planner task remove --title "My Task" --bucketName "My Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
99
+ ```
100
+
84
101
  ## Response
85
102
 
86
103
  The command won't return a response on success.
@@ -28,10 +28,13 @@ m365 planner task set [options]
28
28
  : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
29
29
 
30
30
  `--planId [planId]`
31
- : ID of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
31
+ : ID of the plan to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
32
32
 
33
33
  `--planTitle [planTitle]`
34
- : Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
34
+ : Title of the plan to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
+
36
+ `--rosterId [rosterId]`
37
+ : ID of the Planner Roster to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
38
 
36
39
  `--ownerGroupId [ownerGroupId]`
37
40
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -91,24 +94,36 @@ You can add up to 6 categories to the task. An example to add _category1_ and _c
91
94
 
92
95
  When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
93
96
 
97
+ :::caution
98
+
99
+ 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.
100
+
101
+ :::
102
+
94
103
  ## Examples
95
104
 
96
- Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
105
+ Updates a Microsoft Planner task name of the specified task by ID
97
106
 
98
107
  ```sh
99
108
  m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
100
109
  ```
101
110
 
102
- Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_
111
+ Moves a Microsoft Planner task with the specified ID to the bucket by name. Based on the plan with the specified rosterId.
112
+
113
+ ```sh
114
+ m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --bucketName "My Planner Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
115
+ ```
116
+
117
+ Moves a Microsoft Planner task with the specified ID to the bucket by name. Based on the plan with the specified title owned by the specified group by name.
103
118
 
104
119
  ```sh
105
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
120
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
106
121
  ```
107
122
 
108
- Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
123
+ Marks a Microsoft Planner task with the specified ID as 50% complete and assigned to categories 1 and 3.
109
124
 
110
125
  ```sh
111
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
126
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
112
127
  ```
113
128
 
114
129
  ## Response
@@ -32,13 +32,13 @@ m365 pp dataverse table get [options]
32
32
  List a table for the given environment
33
33
 
34
34
  ```sh
35
- m365 pp dataverse table get -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
35
+ m365 pp dataverse table get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
36
36
  ```
37
37
 
38
38
  List a table for the given environment as Admin
39
39
 
40
40
  ```sh
41
- m365 pp dataverse table get -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
41
+ m365 pp dataverse table get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
42
42
  ```
43
43
 
44
44
  ## Response
@@ -29,13 +29,13 @@ m365 pp dataverse table list [options]
29
29
  List all tables for the given environment
30
30
 
31
31
  ```sh
32
- m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
32
+ m365 pp dataverse table list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
33
33
  ```
34
34
 
35
35
  List all tables for the given environment as Admin
36
36
 
37
37
  ```sh
38
- m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
38
+ m365 pp dataverse table list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
39
39
  ```
40
40
 
41
41
  ## Response
@@ -33,19 +33,19 @@ m365 pp dataverse table remove [options]
33
33
  Removes a dataverse table in a given environment
34
34
 
35
35
  ```sh
36
- m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
36
+ m365 pp dataverse table remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
37
37
  ```
38
38
 
39
39
  Removes a dataverse table in a given environment as Admin
40
40
 
41
41
  ```sh
42
- m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
42
+ m365 pp dataverse table remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
43
43
  ```
44
44
 
45
45
  Removes a dataverse table in a given environment without prompting for confirmation
46
46
 
47
47
  ```sh
48
- m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --confirm
48
+ m365 pp dataverse table remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --confirm
49
49
  ```
50
50
 
51
51
  ## Response