@pnp/cli-microsoft365 5.0.0-beta.2e2ba7d → 5.0.0-beta.4aa3f65

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 (89) hide show
  1. package/.devcontainer/devcontainer.json +9 -1
  2. package/.eslintrc.js +1 -0
  3. package/README.md +1 -1
  4. package/dist/Utils.js +7 -0
  5. package/dist/api.d.ts +11 -0
  6. package/dist/api.js +17 -0
  7. package/dist/appInsights.js +2 -1
  8. package/dist/cli/Cli.js +38 -6
  9. package/dist/m365/aad/commands/app/app-add.js +43 -7
  10. package/dist/m365/aad/commands/group/group-list.js +41 -0
  11. package/dist/m365/aad/commands/o365group/{Group.js → GroupExtended.js} +1 -1
  12. package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
  13. package/dist/m365/aad/commands/user/user-get.js +33 -6
  14. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  15. package/dist/m365/aad/commands/user/user-list.js +7 -4
  16. package/dist/m365/aad/commands/user/user-password-validate.js +42 -0
  17. package/dist/m365/aad/commands.js +3 -0
  18. package/dist/m365/app/commands/permission/permission-list.js +266 -0
  19. package/dist/m365/app/commands.js +7 -0
  20. package/dist/m365/base/AppCommand.js +76 -0
  21. package/dist/m365/cli/commands/config/config-set.js +4 -1
  22. package/dist/m365/flow/commands/flow-get.js +2 -2
  23. package/dist/m365/pa/cds-project-mutator.js +1 -1
  24. package/dist/m365/pa/commands/app/app-list.js +28 -1
  25. package/dist/m365/{aad/commands/o365group/GroupUser.js → planner/AppliedCategories.js} +1 -1
  26. package/dist/m365/planner/commands/task/task-add.js +288 -0
  27. package/dist/m365/planner/commands/task/task-details-get.js +39 -0
  28. package/dist/m365/planner/commands/task/task-get.js +37 -0
  29. package/dist/m365/planner/commands/task/task-list.js +37 -7
  30. package/dist/m365/planner/commands/task/task-set.js +357 -0
  31. package/dist/m365/planner/commands.js +5 -1
  32. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
  33. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.14.0-beta.4.js → upgrade-1.14.0-rc.2.js} +27 -25
  34. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  35. package/dist/m365/spo/commands/group/group-user-add.js +64 -13
  36. package/dist/m365/spo/commands/group/group-user-remove.js +100 -0
  37. package/dist/m365/spo/commands/site/site-ensure.js +1 -1
  38. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  39. package/dist/m365/spo/commands.js +2 -0
  40. package/dist/m365/teams/commands/app/app-list.js +9 -6
  41. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  42. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  43. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  44. package/dist/m365/teams/commands/message/message-get.js +1 -1
  45. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  46. package/dist/m365/teams/commands.js +3 -0
  47. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
  48. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
  49. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +39 -0
  50. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +38 -0
  51. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js +51 -0
  52. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +38 -0
  53. package/dist/m365/tenant/commands.js +6 -0
  54. package/dist/request.js +9 -4
  55. package/dist/settingsNames.js +6 -1
  56. package/docs/docs/cmd/_global.md +2 -2
  57. package/docs/docs/cmd/aad/group/group-list.md +21 -0
  58. package/docs/docs/cmd/aad/user/user-get.md +13 -4
  59. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  60. package/docs/docs/cmd/aad/user/user-list.md +9 -0
  61. package/docs/docs/cmd/aad/user/user-password-validate.md +29 -0
  62. package/docs/docs/cmd/app/permission/permission-list.md +36 -0
  63. package/docs/docs/cmd/pa/app/app-list.md +17 -1
  64. package/docs/docs/cmd/planner/task/task-add.md +78 -0
  65. package/docs/docs/cmd/planner/task/task-details-get.md +24 -0
  66. package/docs/docs/cmd/planner/task/task-get.md +24 -0
  67. package/docs/docs/cmd/planner/task/task-list.md +5 -0
  68. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  69. package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +3 -3
  70. package/docs/docs/cmd/spfx/project/project-externalize.md +1 -1
  71. package/docs/docs/cmd/spfx/project/project-rename.md +1 -1
  72. package/docs/docs/cmd/spfx/spfx-doctor.md +1 -1
  73. package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
  74. package/docs/docs/cmd/spo/group/group-user-remove.md +39 -0
  75. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  76. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  77. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  78. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  79. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  80. package/docs/docs/cmd/teams/message/message-get.md +0 -3
  81. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
  82. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
  83. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +24 -0
  84. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +34 -0
  85. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +28 -0
  86. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +34 -0
  87. package/npm-shrinkwrap.json +1298 -1501
  88. package/package.json +34 -27
  89. package/dist/m365/base/AadCommand.js +0 -10
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const GraphCommand_1 = require("../../../base/GraphCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementMessageGetCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_GET;
9
+ }
10
+ get description() {
11
+ return 'Retrieves a specified service update message for the tenant';
12
+ }
13
+ commandAction(logger, args, cb) {
14
+ if (this.verbose) {
15
+ logger.logToStderr(`Retrieving service update message ${args.options.id}`);
16
+ }
17
+ const requestOptions = {
18
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/messages/${args.options.id}`,
19
+ headers: {
20
+ accept: 'application/json;odata.metadata=none'
21
+ },
22
+ responseType: 'json'
23
+ };
24
+ request_1.default
25
+ .get(requestOptions)
26
+ .then((res) => {
27
+ logger.log(res);
28
+ cb();
29
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
30
+ }
31
+ options() {
32
+ const options = [
33
+ {
34
+ option: '-i, --id <id>'
35
+ }
36
+ ];
37
+ const parentOptions = super.options();
38
+ return options.concat(parentOptions);
39
+ }
40
+ isValidId(id) {
41
+ return (/MC\d{6}/).test(id);
42
+ }
43
+ validate(args) {
44
+ if (!this.isValidId(args.options.id)) {
45
+ return `${args.options.id} is not a valid message ID`;
46
+ }
47
+ return true;
48
+ }
49
+ }
50
+ module.exports = new TenantServiceAnnouncementMessageGetCommand();
51
+ //# sourceMappingURL=serviceannouncement-message-get.js.map
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
4
+ const commands_1 = require("../../commands");
5
+ class TenantServiceAnnouncementMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_LIST;
8
+ }
9
+ get description() {
10
+ return 'Gets all service update messages for the tenant';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'title'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/messages`;
17
+ if (args.options.service) {
18
+ endpoint += `?$filter=services/any(c:c+eq+'${encodeURIComponent(args.options.service)}')`;
19
+ }
20
+ this
21
+ .getAllItems(endpoint, logger, true)
22
+ .then(() => {
23
+ logger.log(this.items);
24
+ cb();
25
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
26
+ }
27
+ options() {
28
+ const options = [
29
+ {
30
+ option: '-s, --service [service]'
31
+ }
32
+ ];
33
+ const parentOptions = super.options();
34
+ return options.concat(parentOptions);
35
+ }
36
+ }
37
+ module.exports = new TenantServiceAnnouncementMessageListCommand();
38
+ //# sourceMappingURL=serviceannouncement-message-list.js.map
@@ -10,9 +10,15 @@ exports.default = {
10
10
  REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
11
11
  REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
12
12
  REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
13
+ SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
13
14
  SERVICE_LIST: `${prefix} service list`,
14
15
  SERVICE_MESSAGE_LIST: `${prefix} service message list`,
15
16
  SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
17
+ SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
18
+ SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
19
+ SERVICEANNOUNCEMENT_HEALTHISSUE_LIST: `${prefix} serviceannouncement healthissue list`,
20
+ SERVICEANNOUNCEMENT_MESSAGE_GET: `${prefix} serviceannouncement message get`,
21
+ SERVICEANNOUNCEMENT_MESSAGE_LIST: `${prefix} serviceannouncement message list`,
16
22
  STATUS_LIST: `${prefix} status list`
17
23
  };
18
24
  //# sourceMappingURL=commands.js.map
package/dist/request.js CHANGED
@@ -16,7 +16,9 @@ class Request {
16
16
  decompress: true,
17
17
  responseType: 'text',
18
18
  /* c8 ignore next */
19
- transformResponse: [data => data]
19
+ transformResponse: [data => data],
20
+ maxBodyLength: Infinity,
21
+ maxContentLength: Infinity
20
22
  });
21
23
  // since we're stubbing requests, request interceptor is never called in
22
24
  // tests, so let's exclude it from coverage
@@ -64,7 +66,7 @@ class Request {
64
66
  });
65
67
  // since we're stubbing requests, response interceptor is never called in
66
68
  // tests, so let's exclude it from coverage
67
- /* c8 ignore next 22 */
69
+ /* c8 ignore next 26 */
68
70
  this.req.interceptors.response.use((response) => {
69
71
  if (this._logger) {
70
72
  this._logger.logToStderr('Response:');
@@ -73,19 +75,22 @@ class Request {
73
75
  response.headers['content-type'].indexOf('json') > -1) {
74
76
  properties.push('data');
75
77
  }
76
- this._logger.logToStderr(JSON.stringify(Utils_1.default.filterObject(response, properties), null, 2));
78
+ this._logger.logToStderr(JSON.stringify(Object.assign({ url: response.config.url }, Utils_1.default.filterObject(response, properties)), null, 2));
77
79
  }
78
80
  return response;
79
81
  }, (error) => {
80
82
  if (this._logger) {
81
83
  const properties = ['status', 'statusText', 'headers'];
82
84
  this._logger.logToStderr('Request error:');
83
- this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({}, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
85
+ this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({ url: error.config.url }, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
84
86
  }
85
87
  throw error;
86
88
  });
87
89
  }
88
90
  }
91
+ get logger() {
92
+ return this._logger;
93
+ }
89
94
  set logger(logger) {
90
95
  this._logger = logger;
91
96
  }
@@ -5,7 +5,12 @@ const settingsNames = {
5
5
  errorOutput: 'errorOutput',
6
6
  output: 'output',
7
7
  printErrorsAsPlainText: 'printErrorsAsPlainText',
8
- showHelpOnFailure: 'showHelpOnFailure'
8
+ showHelpOnFailure: 'showHelpOnFailure',
9
+ csvHeader: 'csvHeader',
10
+ csvEscape: 'csvEscape',
11
+ csvQuote: 'csvQuote',
12
+ csvQuoted: 'csvQuoted',
13
+ csvQuotedEmpty: 'csvQuotedEmpty'
9
14
  };
10
15
  exports.settingsNames = settingsNames;
11
16
  //# sourceMappingURL=settingsNames.js.map
@@ -5,10 +5,10 @@
5
5
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
6
6
 
7
7
  `-o, --output [output]`
8
- : Output type. `json,text`. Default `text`
8
+ : Output type. `json,text,csv`. Default `json`
9
9
 
10
10
  `--verbose`
11
11
  : Runs command with verbose logging
12
12
 
13
13
  `--debug`
14
- : Runs command with debug logging
14
+ : Runs command with debug logging
@@ -0,0 +1,21 @@
1
+ # aad group list
2
+
3
+ Lists Azure AD groups
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad group list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Lists all groups defined in Azure Active Directory.
18
+
19
+ ```sh
20
+ m365 aad group list
21
+ ```
@@ -11,10 +11,13 @@ m365 aad user get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : The ID of the user to retrieve information for. Specify `id` or `userName` but not both
14
+ : The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
15
15
 
16
16
  `-n, --userName [userName]`
17
- : The name of the user to retrieve information for. Specify `id` or `userName` but not both
17
+ : The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
+
19
+ `--email [email]`
20
+ : The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
21
 
19
22
  `-p, --properties [properties]`
20
23
  : Comma-separated list of properties to retrieve
@@ -23,9 +26,9 @@ m365 aad user get [options]
23
26
 
24
27
  ## Remarks
25
28
 
26
- You can retrieve information about a user, either by specifying that user's id or user name (`userPrincipalName`), but not both.
29
+ You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
27
30
 
28
- If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
31
+ If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
29
32
 
30
33
  ## Examples
31
34
 
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
41
44
  m365 aad user get --userName AarifS@contoso.onmicrosoft.com
42
45
  ```
43
46
 
47
+ Get information about the user with email _AarifS@contoso.onmicrosoft.com_
48
+
49
+ ```sh
50
+ m365 aad user get --email AarifS@contoso.onmicrosoft.com
51
+ ```
52
+
44
53
  For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
45
54
 
46
55
  ```sh
@@ -0,0 +1,46 @@
1
+ # aad user hibp
2
+
3
+ Allows you to retrieve all accounts that have been pwned with the specified username
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user hibp [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --userName <userName>`
14
+ : The name of the user to retrieve information for.
15
+
16
+ `--apiKey, <apiKey>`
17
+ : Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
18
+
19
+ `--domain, [domain]`
20
+ : Limit the returned breaches only contain results with the domain specified.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
27
+
28
+ If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
29
+
30
+ ## Examples
31
+
32
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
33
+
34
+ ```sh
35
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
36
+ ```
37
+
38
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
39
+
40
+ ```sh
41
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
42
+ ```
43
+
44
+ ## More information
45
+
46
+ - Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)
@@ -13,6 +13,9 @@ m365 aad user list [options]
13
13
  `-p, --properties [properties]`
14
14
  : Comma-separated list of properties to retrieve
15
15
 
16
+ `-d, --deleted`
17
+ : Use to retrieve deleted users
18
+
16
19
  --8<-- "docs/cmd/_global.md"
17
20
 
18
21
  ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
31
34
  m365 aad user list
32
35
  ```
33
36
 
37
+ List all recently deleted users in the tenant
38
+
39
+ ```sh
40
+ m365 aad user list --deleted
41
+ ```
42
+
34
43
  List all users in the tenant. For each one return the display name and e-mail address
35
44
 
36
45
  ```sh
@@ -0,0 +1,29 @@
1
+ # aad user password validate
2
+
3
+ Check a user's password against the organization's password validation policy
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user password validate [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-p, --password <password>`
14
+ : The password to be validated.
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
+ Validate password _cli365P@ssW0rd_ against the organization's password validation policy
26
+
27
+ ```sh
28
+ m365 aad user password validate --password "cli365P@ssW0rd"
29
+ ```
@@ -0,0 +1,36 @@
1
+ # app permission list
2
+
3
+ Lists API permissions for the current AAD app
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 app permission list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ Use this command to quickly look up API permissions for the Azure AD application registration registered in the .m365rc.json file in your current project (folder).
21
+
22
+ If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
23
+
24
+ ## Examples
25
+
26
+ Retrieve API permissions for your current Azure AD app
27
+
28
+ ```sh
29
+ m365 app permission list
30
+ ```
31
+
32
+ Retrieve API permissions for the Azure AD app with client ID _e23d235c-fcdf-45d1-ac5f-24ab2ee0695d_ specified in the _.m365rc.json_ file
33
+
34
+ ```sh
35
+ m365 app permission list --appId e23d235c-fcdf-45d1-ac5f-24ab2ee0695d
36
+ ```
@@ -10,6 +10,12 @@ pa app list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-e, --environment [environment]`
14
+ : The name of the environment for which to retrieve available apps
15
+
16
+ `--asAdmin`
17
+ : Set, to list all Power Apps as admin. Otherwise will return only your own apps
18
+
13
19
  --8<-- "docs/cmd/_global.md"
14
20
 
15
21
  ## Remarks
@@ -17,10 +23,20 @@ pa app list [options]
17
23
  !!! attention
18
24
  This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
19
25
 
26
+ If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
27
+
28
+ By default, the `app list` command returns only your apps. To list all apps, use the `asAdmin` option and make sure to specify the `environment` option. You cannot specify only one of the options, when specifying the `environment` option the `asAdmin` option has to be present as well.
29
+
20
30
  ## Examples
21
31
 
22
- List all apps
32
+ List all your apps
23
33
 
24
34
  ```sh
25
35
  m365 pa app list
26
36
  ```
37
+
38
+ List all apps in a given environment
39
+
40
+ ```sh
41
+ m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
42
+ ```
@@ -0,0 +1,78 @@
1
+ # planner task add
2
+
3
+ Adds a new Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : Title of the task to add.
15
+
16
+ `--planId [planId]`
17
+ : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
18
+
19
+ `--planName [planName]`
20
+ : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
21
+
22
+ `--ownerGroupId [ownerGroupId]`
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
24
+
25
+ `--ownerGroupName [ownerGroupName]`
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
27
+
28
+ `--bucketId [bucketId]`
29
+ : Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
+
31
+ `--bucketName [bucketName]`
32
+ : Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
+
34
+ `--startDateTime [startDateTime]`
35
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
36
+
37
+ `--dueDateTime [dueDateTime]`
38
+ : The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
39
+
40
+ `--percentComplete [percentComplete]`
41
+ : Percentage of task completion. Number between 0 and 100.
42
+ - When set to 0, the task is considered _Not started_.
43
+ - When set between 1 and 99, the task is considered _In progress_.
44
+ - When set to 100, the task is considered _Completed_.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
+
52
+ `--description [description]`
53
+ : Description of the task
54
+
55
+ `--orderHint [orderHint]`
56
+ : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
57
+
58
+ --8<-- "docs/cmd/_global.md"
59
+
60
+ ## Examples
61
+
62
+ 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_
63
+
64
+ ```sh
65
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
66
+ ```
67
+
68
+ Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
69
+
70
+ ```sh
71
+ m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
72
+ ```
73
+
74
+ 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 the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
75
+
76
+ ```sh
77
+ 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"
78
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task details get
2
+
3
+ Retrieve the details of the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task details get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Retrieve the details of the specified planner task
21
+
22
+ ```sh
23
+ m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task get
2
+
3
+ Retrieve the the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Retrieve the the specified planner task
21
+
22
+ ```sh
23
+ m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
+ ```
@@ -30,6 +30,11 @@ m365 planner task list [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
+ ## Remarks
34
+
35
+ !!! attention
36
+ This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
37
+
33
38
  ## Examples
34
39
 
35
40
  List tasks for the currently logged in user
@@ -0,0 +1,99 @@
1
+ # planner task set
2
+
3
+ Updates a Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task.
15
+
16
+ `-t, --title [title]`
17
+ : New title of the task.
18
+
19
+ `--bucketId [bucketId]`
20
+ : ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
21
+
22
+ `--bucketName [bucketName]`
23
+ : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
24
+
25
+ `--planId [planId]`
26
+ : ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
27
+
28
+ `--planName [planName]`
29
+ : Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
30
+
31
+ `--ownerGroupId [ownerGroupId]`
32
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
33
+
34
+ `--ownerGroupName [ownerGroupName]`
35
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
36
+
37
+ `--startDateTime [startDateTime]`
38
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
39
+
40
+ `--dueDateTime [dueDateTime]`
41
+ : The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
42
+
43
+ `--percentComplete [percentComplete]`
44
+ : Percentage of task completion. Number between 0 and 100.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
+
52
+ `--description [description]`
53
+ : Description of the task
54
+
55
+ `--orderHint [orderHint]`
56
+ : Hint used to order items of this type in a list view
57
+
58
+ `--assigneePriority [assigneePriority]`
59
+ : Hint used to order items of this type in a list view
60
+
61
+ `--appliedCategories [appliedCategories]`
62
+ : Comma-separated categories that should be added to the task
63
+
64
+ --8<-- "docs/cmd/_global.md"
65
+
66
+ ## Remarks
67
+
68
+ When you specify the value for `percentageComplete`, consider the following:
69
+
70
+ - when set to 0, the task is considered _Not started_
71
+ - when set between 1 and 99, the task is considered _In progress_
72
+ - when set to 100, the task is considered _Completed_
73
+
74
+ You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
75
+
76
+ ## Examples
77
+
78
+ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
79
+
80
+ ```sh
81
+ m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
82
+ ```
83
+
84
+ Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
85
+
86
+ ```sh
87
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
88
+ ```
89
+
90
+ Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
91
+
92
+ ```sh
93
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
94
+ ```
95
+
96
+ ## Additional information
97
+
98
+ - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
99
+ - Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)