@pnp/cli-microsoft365 5.5.0-beta.5a6c547 → 5.5.0-beta.6fb46e0

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 (68) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/Command.js +22 -0
  3. package/dist/m365/base/PowerAppsCommand.js +10 -0
  4. package/dist/m365/flow/commands/flow-export.js +3 -0
  5. package/dist/m365/pa/commands/app/app-get.js +3 -5
  6. package/dist/m365/pa/commands/app/app-list.js +10 -9
  7. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  8. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  9. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  10. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  11. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  12. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  13. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  14. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  15. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  16. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  17. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  18. package/dist/m365/planner/commands/plan/plan-get.js +1 -1
  19. package/dist/m365/planner/commands/plan/plan-remove.js +141 -0
  20. package/dist/m365/planner/commands/task/task-add.js +16 -16
  21. package/dist/m365/planner/commands/task/task-get.js +14 -9
  22. package/dist/m365/planner/commands/task/task-list.js +19 -11
  23. package/dist/m365/planner/commands/task/task-reference-add.js +1 -7
  24. package/dist/m365/planner/commands/task/task-reference-remove.js +11 -14
  25. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  26. package/dist/m365/planner/commands/task/task-set.js +17 -23
  27. package/dist/m365/planner/commands.js +1 -0
  28. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  29. package/dist/m365/search/commands.js +1 -0
  30. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.15.0.js +23 -0
  31. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  32. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  33. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.0.js +6 -4
  34. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  35. package/dist/m365/spo/base-permissions.js +9 -0
  36. package/dist/m365/spo/commands/hubsite/hubsite-get.js +62 -12
  37. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  38. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  39. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  40. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  41. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  42. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  43. package/dist/m365/spo/commands.js +1 -0
  44. package/dist/m365/teams/commands/cache/cache-remove.js +155 -0
  45. package/dist/m365/teams/commands.js +1 -0
  46. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  47. package/dist/utils/accessToken.js +18 -0
  48. package/dist/utils/planner.js +9 -8
  49. package/dist/utils/validation.js +5 -1
  50. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  51. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  52. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  53. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  54. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  55. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  56. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  57. package/docs/docs/cmd/planner/plan/plan-remove.md +48 -0
  58. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  59. package/docs/docs/cmd/planner/task/task-get.md +11 -8
  60. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  61. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  62. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  63. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +19 -8
  64. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  65. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  66. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  67. package/docs/docs/cmd/teams/cache/cache-remove.md +46 -0
  68. package/package.json +1 -1
@@ -0,0 +1,155 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const util = require("util");
13
+ const cli_1 = require("../../../../cli");
14
+ const GraphCommand_1 = require("../../../base/GraphCommand");
15
+ const commands_1 = require("../../commands");
16
+ class TeamsCacheRemoveCommand extends GraphCommand_1.default {
17
+ constructor() {
18
+ super(...arguments);
19
+ this.exec = util.promisify(require('child_process').exec);
20
+ }
21
+ get name() {
22
+ return commands_1.default.CACHE_REMOVE;
23
+ }
24
+ get description() {
25
+ return 'Removes the Microsoft Teams client cache';
26
+ }
27
+ getTelemetryProperties(args) {
28
+ const telemetryProps = super.getTelemetryProperties(args);
29
+ telemetryProps.confirm = (!(!args.options.confirm)).toString();
30
+ return telemetryProps;
31
+ }
32
+ commandAction(logger, args, cb) {
33
+ if (args.options.confirm) {
34
+ this.clearTeamsCache(logger, cb);
35
+ }
36
+ else {
37
+ logger.logToStderr('This command will execute the following steps.');
38
+ logger.logToStderr('- Stop the Microsoft Teams client.');
39
+ logger.logToStderr('- Clear the Microsoft Teams cached files.');
40
+ cli_1.Cli.prompt({
41
+ type: 'confirm',
42
+ name: 'continue',
43
+ default: false,
44
+ message: `Are you sure you want to clear your Microsoft Teams cache?`
45
+ }, (result) => {
46
+ if (!result.continue) {
47
+ cb();
48
+ }
49
+ else {
50
+ this.clearTeamsCache(logger, cb);
51
+ }
52
+ });
53
+ }
54
+ }
55
+ clearTeamsCache(logger, cb) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ try {
58
+ yield this.killRunningProcess(logger);
59
+ yield this.removeCacheFiles(logger);
60
+ }
61
+ catch (e) {
62
+ cb(e.message);
63
+ return;
64
+ }
65
+ logger.logToStderr('Teams cache cleared!');
66
+ cb();
67
+ });
68
+ }
69
+ killRunningProcess(logger) {
70
+ return __awaiter(this, void 0, void 0, function* () {
71
+ if (this.verbose) {
72
+ logger.logToStderr('Stop Teams client');
73
+ }
74
+ const platform = process.platform;
75
+ let cmd = '';
76
+ switch (platform) {
77
+ case 'win32':
78
+ cmd = 'taskkill /IM "Teams.exe" /F';
79
+ break;
80
+ case 'darwin':
81
+ cmd = `ps ax | grep MacOS/Teams -m 1 | grep -v grep | awk '{ print $1 }'`;
82
+ break;
83
+ }
84
+ if (this.debug) {
85
+ logger.logToStderr(cmd);
86
+ }
87
+ try {
88
+ const cmdOutput = yield this.exec(cmd);
89
+ if (cmdOutput.stdout !== '' && platform === 'darwin') {
90
+ process.kill(cmdOutput.stdout);
91
+ }
92
+ if (this.verbose) {
93
+ logger.logToStderr('Teams client closed');
94
+ }
95
+ }
96
+ catch (e) {
97
+ const errorMessage = e.message;
98
+ if (errorMessage.includes('ERROR: The process "Teams.exe" not found.')) {
99
+ if (this.verbose) {
100
+ logger.logToStderr('Teams client isn\'t running');
101
+ }
102
+ }
103
+ else {
104
+ throw new Error(errorMessage);
105
+ }
106
+ }
107
+ });
108
+ }
109
+ removeCacheFiles(logger) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ if (this.verbose) {
112
+ logger.logToStderr('Clear Teams cached files');
113
+ }
114
+ const platform = process.platform;
115
+ let cmd = '';
116
+ switch (platform) {
117
+ case 'win32':
118
+ cmd = 'cd %userprofile% && rmdir /s /q AppData\\Roaming\\Microsoft\\Teams';
119
+ break;
120
+ case 'darwin':
121
+ cmd = 'rm -r ~/Library/Application\\ Support/Microsoft/Teams';
122
+ break;
123
+ }
124
+ if (this.debug) {
125
+ logger.logToStderr(cmd);
126
+ }
127
+ try {
128
+ yield this.exec(cmd);
129
+ }
130
+ catch (e) {
131
+ throw new Error(e.message);
132
+ }
133
+ });
134
+ }
135
+ options() {
136
+ const options = [
137
+ {
138
+ option: '--confirm'
139
+ }
140
+ ];
141
+ const parentOptions = super.options();
142
+ return options.concat(parentOptions);
143
+ }
144
+ validate() {
145
+ if (process.env.CLIMICROSOFT365_ENV === 'docker') {
146
+ return 'Because you\'re running CLI for Microsoft 365 in a Docker container, we can\'t clear the cache on your host. Instead run this command on your host using "npx ..."';
147
+ }
148
+ if (process.platform !== 'win32' && process.platform !== 'darwin') {
149
+ return `${process.platform} platform is unsupported for this command`;
150
+ }
151
+ return true;
152
+ }
153
+ }
154
+ module.exports = new TeamsCacheRemoveCommand();
155
+ //# sourceMappingURL=cache-remove.js.map
@@ -8,6 +8,7 @@ exports.default = {
8
8
  APP_REMOVE: `${prefix} app remove`,
9
9
  APP_UNINSTALL: `${prefix} app uninstall`,
10
10
  APP_UPDATE: `${prefix} app update`,
11
+ CACHE_REMOVE: `${prefix} cache remove`,
11
12
  CHANNEL_ADD: `${prefix} channel add`,
12
13
  CHANNEL_GET: `${prefix} channel get`,
13
14
  CHANNEL_LIST: `${prefix} channel list`,
@@ -34,15 +34,7 @@ class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
34
34
  },
35
35
  responseType: 'json'
36
36
  };
37
- return request_1.default
38
- .get(requestOptions)
39
- .then(response => {
40
- const serviceHealth = response;
41
- if (!serviceHealth) {
42
- return Promise.reject(`Error fetching service health`);
43
- }
44
- return Promise.resolve(serviceHealth);
45
- });
37
+ return request_1.default.get(requestOptions);
46
38
  }
47
39
  options() {
48
40
  const options = [
@@ -57,6 +57,24 @@ exports.accessToken = {
57
57
  catch (_a) {
58
58
  }
59
59
  return userName;
60
+ },
61
+ getUserIdFromAccessToken(accessToken) {
62
+ let userId = '';
63
+ if (!accessToken || accessToken.length === 0) {
64
+ return userId;
65
+ }
66
+ const chunks = accessToken.split('.');
67
+ if (chunks.length !== 3) {
68
+ return userId;
69
+ }
70
+ const tokenString = Buffer.from(chunks[1], 'base64').toString();
71
+ try {
72
+ const token = JSON.parse(tokenString);
73
+ userId = token.oid;
74
+ }
75
+ catch (_a) {
76
+ }
77
+ return userId;
60
78
  }
61
79
  };
62
80
  //# sourceMappingURL=accessToken.js.map
@@ -24,10 +24,11 @@ exports.planner = {
24
24
  /**
25
25
  * Get Planner plan by ID.
26
26
  * @param id Planner ID.
27
+ * @param metadata OData metadata level. Default is none
27
28
  */
28
- getPlanById(id) {
29
+ getPlanById(id, metadata = 'none') {
29
30
  return __awaiter(this, void 0, void 0, function* () {
30
- const requestOptions = getRequestOptions(`${graphResource}/v1.0/planner/plans/${id}`, 'none');
31
+ const requestOptions = getRequestOptions(`${graphResource}/v1.0/planner/plans/${id}`, metadata);
31
32
  try {
32
33
  return yield request_1.default.get(requestOptions);
33
34
  }
@@ -44,19 +45,19 @@ exports.planner = {
44
45
  return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
45
46
  },
46
47
  /**
47
- * Get Planner plan by name in a specific group.
48
- * @param name Name of the Planner plan. Case insensitive.
48
+ * Get Planner plan by title in a specific group.
49
+ * @param title Title of the Planner plan. Case insensitive.
49
50
  * @param groupId Owner group ID .
50
51
  */
51
- getPlanByName(name, groupId) {
52
+ getPlanByTitle(title, groupId) {
52
53
  return __awaiter(this, void 0, void 0, function* () {
53
54
  const plans = yield this.getPlansByGroupId(groupId);
54
- const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
55
+ const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
55
56
  if (!filteredPlans.length) {
56
- throw Error(`The specified plan '${name}' does not exist.`);
57
+ throw Error(`The specified plan '${title}' does not exist.`);
57
58
  }
58
59
  if (filteredPlans.length > 1) {
59
- throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
60
+ throw Error(`Multiple plans with title '${title}' found: ${filteredPlans.map(x => x.id)}.`);
60
61
  }
61
62
  return filteredPlans[0];
62
63
  });
@@ -6,8 +6,12 @@ exports.validation = {
6
6
  return guids.every(guid => this.isValidGuid(guid));
7
7
  },
8
8
  isValidGuid(guid) {
9
+ if (!guid) {
10
+ return false;
11
+ }
9
12
  const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
10
- return guidRegEx.test(guid);
13
+ // verify if the guid is a valid guid. @meid will be replaced in a later stage with the actual user id of the logged in user
14
+ return guidRegEx.test(guid) || guid.toLocaleLowerCase().trim() === "@meid";
11
15
  },
12
16
  isValidTeamsChannelId(guid) {
13
17
  const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
@@ -56,6 +56,18 @@ For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user na
56
56
  m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
57
57
  ```
58
58
 
59
+ Get information about the currently logged user using the Id token
60
+
61
+ ```sh
62
+ m365 aad user get --id "@meId"
63
+ ```
64
+
65
+ Get information about the currently logged in user using the UserName token
66
+
67
+ ```sh
68
+ m365 aad user get --userName "@meUserName"
69
+ ```
70
+
59
71
  ## More information
60
72
 
61
73
  - Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
14
14
  : Name of the bucket to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--orderHint [orderHint]`
29
32
  : 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).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
38
41
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
39
42
  ```
40
43
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
44
+ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
42
45
 
43
46
  ```sh
44
- m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
47
+ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
48
  ```
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
17
17
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
50
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
53
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
54
  ```
52
55
 
53
56
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
57
 
55
58
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
59
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
60
+ ```
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
11
11
  ## Options
12
12
 
13
13
  `--planId [planId]`
14
- : ID of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
14
+ : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
+
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
18
 
16
19
  `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
20
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
38
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
39
 
37
40
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
41
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
42
  ```
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
17
17
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--confirm`
32
35
  : Don't prompt for confirmation
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
59
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
60
 
58
61
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
62
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
63
  ```
@@ -17,16 +17,19 @@ m365 planner bucket set [options]
17
17
  : Name of the bucket. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--newName [newName]`
32
35
  : New name of the bucket.
@@ -47,11 +50,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
47
50
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
53
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
51
54
  ```
52
55
 
53
56
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
54
57
 
55
58
  ```sh
56
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
59
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
60
  ```
@@ -19,18 +19,34 @@ m365 planner plan add [options]
19
19
  `--ownerGroupName [ownerGroupName]`
20
20
  : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
21
21
 
22
+ `--shareWithUserIds [shareWithUserIds]`
23
+ : The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
24
+
25
+ `--shareWithUserNames [shareWithUserNames]`
26
+ : The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
27
+
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
33
+
24
34
  ## Examples
25
35
 
26
36
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
27
37
 
28
38
  ```sh
29
- m365 planner plan add --title "My Planner Plan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
39
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
30
40
  ```
31
41
 
32
42
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
33
43
 
34
44
  ```sh
35
- m365 planner plan add --title "My Planner Plan" --ownerGroupName "My Planner Group"
45
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
46
+ ```
47
+
48
+ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
49
+
50
+ ```sh
51
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
36
52
  ```
@@ -0,0 +1,48 @@
1
+ # planner plan remove
2
+
3
+ Removes the Microsoft Planner plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner plan remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `i, --id [id]`
14
+ : ID of the plan to remove. Specify either `id` or `title` but not both.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the plan to remove. Specify either `id` or `title` but not both.
18
+
19
+ `--ownerGroupId [ownerGroupId]`
20
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
21
+
22
+ `--ownerGroupName [ownerGroupName]`
23
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the Microsoft Planner plan by ID
33
+
34
+ ```sh
35
+ m365 planner plan remove --id gndWOTSK60GfPQfiDDj43JgACDCb
36
+ ```
37
+
38
+ Removes the Microsoft Planner plan with title _My Plan_ in group with specific ID
39
+
40
+ ```sh
41
+ m365 planner plan remove --title "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000
42
+ ```
43
+
44
+ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My Planner Group_ without confirmation prompt
45
+
46
+ ```sh
47
+ m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
48
+ ```
@@ -14,22 +14,25 @@ m365 planner task add [options]
14
14
  : Title of the task to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--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.
32
+ : ID of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
33
 
31
34
  `--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.
35
+ : Name of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
36
 
34
37
  `--startDateTime [startDateTime]`
35
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`
@@ -89,10 +92,10 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
89
92
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
90
93
  ```
91
94
 
92
- 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_
95
+ 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_
93
96
 
94
97
  ```sh
95
- m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
98
+ m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
96
99
  ```
97
100
 
98
101
  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_
@@ -20,22 +20,25 @@ m365 planner task get [options]
20
20
  : (deprecated. Use `id` instead) ID of the task.
21
21
 
22
22
  `--bucketId [bucketId]`
23
- : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
23
+ : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
24
24
 
25
25
  `--bucketName [bucketName]`
26
- : Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
26
+ : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
27
27
 
28
28
  `--planId [planId]`
29
- : Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
29
+ : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
+
31
+ `--planTitle [planTitle]`
32
+ : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
33
 
31
34
  `--planName [planName]`
32
- : Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
35
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
33
36
 
34
37
  `--ownerGroupId [ownerGroupId]`
35
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
38
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
39
 
37
40
  `--ownerGroupName [ownerGroupName]`
38
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
41
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
39
42
 
40
43
  --8<-- "docs/cmd/_global.md"
41
44
 
@@ -47,8 +50,8 @@ Retrieve the specified planner task by id
47
50
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
48
51
  ```
49
52
 
50
- Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_ based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
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_.
51
54
 
52
55
  ```sh
53
- m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
56
+ m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
54
57
  ```