@pnp/cli-microsoft365 5.4.0-beta.d01ee78 → 5.4.0-beta.fdd7cb1

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 (100) hide show
  1. package/.devcontainer/Dockerfile +1 -1
  2. package/.eslintrc.js +1 -0
  3. package/dist/m365/aad/commands/o365group/o365group-conversation-post-list.js +4 -19
  4. package/dist/m365/aad/commands/o365group/o365group-get.js +3 -9
  5. package/dist/m365/base/PlannerCommand.js +10 -0
  6. package/dist/m365/flow/commands/flow-export.js +3 -3
  7. package/dist/m365/planner/commands/bucket/bucket-add.js +4 -16
  8. package/dist/m365/planner/commands/bucket/bucket-get.js +4 -18
  9. package/dist/m365/planner/commands/bucket/bucket-list.js +4 -17
  10. package/dist/m365/planner/commands/bucket/bucket-remove.js +4 -18
  11. package/dist/m365/planner/commands/bucket/bucket-set.js +4 -18
  12. package/dist/m365/planner/commands/plan/plan-add.js +4 -16
  13. package/dist/m365/planner/commands/plan/plan-details-get.js +4 -19
  14. package/dist/m365/planner/commands/plan/plan-get.js +4 -17
  15. package/dist/m365/planner/commands/plan/plan-list.js +4 -17
  16. package/dist/m365/planner/commands/task/task-add.js +4 -16
  17. package/dist/m365/planner/commands/task/task-checklistitem-add.js +89 -0
  18. package/dist/m365/planner/commands/task/task-get.js +40 -29
  19. package/dist/m365/planner/commands/task/task-list.js +4 -16
  20. package/dist/m365/planner/commands/task/task-remove.js +201 -0
  21. package/dist/m365/planner/commands/task/task-set.js +4 -16
  22. package/dist/m365/planner/commands/tenant/tenant-settings-list.js +33 -0
  23. package/dist/m365/planner/commands.js +5 -2
  24. package/dist/m365/spo/commands/contenttype/contenttype-add.js +1 -1
  25. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +1 -1
  26. package/dist/m365/spo/commands/contenttype/contenttype-get.js +1 -1
  27. package/dist/m365/spo/commands/eventreceiver/eventreceiver-get.js +3 -3
  28. package/dist/m365/spo/commands/eventreceiver/eventreceiver-list.js +102 -0
  29. package/dist/m365/spo/commands/field/field-add.js +1 -1
  30. package/dist/m365/spo/commands/field/field-get.js +5 -5
  31. package/dist/m365/spo/commands/field/field-list.js +3 -3
  32. package/dist/m365/spo/commands/field/field-remove.js +5 -5
  33. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +1 -1
  34. package/dist/m365/spo/commands/list/list-contenttype-add.js +3 -3
  35. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +2 -2
  36. package/dist/m365/spo/commands/list/list-contenttype-list.js +3 -3
  37. package/dist/m365/spo/commands/list/list-contenttype-remove.js +3 -3
  38. package/dist/m365/spo/commands/list/list-get.js +2 -2
  39. package/dist/m365/spo/commands/list/list-label-get.js +3 -3
  40. package/dist/m365/spo/commands/list/list-label-set.js +2 -2
  41. package/dist/m365/spo/commands/list/list-remove.js +2 -2
  42. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +2 -2
  43. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +2 -2
  44. package/dist/m365/spo/commands/list/list-sitescript-get.js +3 -3
  45. package/dist/m365/spo/commands/list/list-view-add.js +3 -3
  46. package/dist/m365/spo/commands/list/list-view-field-add.js +2 -2
  47. package/dist/m365/spo/commands/list/list-view-field-remove.js +2 -2
  48. package/dist/m365/spo/commands/list/list-view-field-set.js +2 -2
  49. package/dist/m365/spo/commands/list/list-view-get.js +4 -4
  50. package/dist/m365/spo/commands/list/list-view-list.js +3 -3
  51. package/dist/m365/spo/commands/list/list-view-remove.js +3 -3
  52. package/dist/m365/spo/commands/list/list-view-set.js +3 -3
  53. package/dist/m365/spo/commands/list/list-webhook-add.js +3 -3
  54. package/dist/m365/spo/commands/list/list-webhook-get.js +3 -3
  55. package/dist/m365/spo/commands/list/list-webhook-list.js +5 -5
  56. package/dist/m365/spo/commands/list/list-webhook-remove.js +4 -4
  57. package/dist/m365/spo/commands/list/list-webhook-set.js +3 -3
  58. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -2
  59. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +2 -2
  60. package/dist/m365/spo/commands/listitem/listitem-get.js +2 -2
  61. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +2 -2
  62. package/dist/m365/spo/commands/listitem/listitem-list.js +31 -11
  63. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +2 -2
  64. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +2 -2
  65. package/dist/m365/spo/commands/listitem/listitem-remove.js +2 -2
  66. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +2 -2
  67. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +2 -2
  68. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  69. package/dist/m365/spo/commands/roledefinition/roledefinition-remove.js +82 -0
  70. package/dist/m365/spo/commands/site/site-remove.js +23 -37
  71. package/dist/m365/spo/commands.js +2 -0
  72. package/dist/m365/teams/commands/app/app-list.js +6 -20
  73. package/dist/m365/teams/commands/channel/channel-get.js +6 -19
  74. package/dist/m365/teams/commands/channel/channel-list.js +6 -18
  75. package/dist/m365/teams/commands/channel/channel-member-add.js +7 -18
  76. package/dist/m365/teams/commands/channel/channel-member-list.js +6 -19
  77. package/dist/m365/teams/commands/channel/channel-member-remove.js +6 -19
  78. package/dist/m365/teams/commands/channel/channel-member-set.js +6 -19
  79. package/dist/m365/teams/commands/tab/tab-get.js +6 -19
  80. package/dist/m365/teams/commands/team/team-add.js +2 -7
  81. package/dist/m365/teams/commands/team/team-get.js +6 -19
  82. package/dist/utils/aadGroup.js +57 -0
  83. package/dist/utils/index.js +2 -0
  84. package/dist/utils/validation.js +12 -2
  85. package/docs/docs/cmd/file/file-list.md +4 -4
  86. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -4
  87. package/docs/docs/cmd/planner/plan/plan-details-get.md +2 -2
  88. package/docs/docs/cmd/planner/plan/plan-get.md +4 -4
  89. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +36 -0
  90. package/docs/docs/cmd/planner/task/task-get.md +3 -0
  91. package/docs/docs/cmd/planner/task/task-remove.md +78 -0
  92. package/docs/docs/cmd/planner/task/task-set.md +2 -2
  93. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +28 -0
  94. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.md +64 -0
  95. package/docs/docs/cmd/spo/file/file-checkout.md +1 -1
  96. package/docs/docs/cmd/spo/listitem/listitem-list.md +16 -10
  97. package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.md +36 -0
  98. package/package.json +12 -7
  99. package/dist/m365/planner/commands/task/task-details-get.js +0 -45
  100. package/docs/docs/cmd/planner/task/task-details-get.md +0 -24
@@ -4,6 +4,7 @@ const utils_1 = require("../../../../utils");
4
4
  const GraphCommand_1 = require("../../../base/GraphCommand");
5
5
  const commands_1 = require("../../commands");
6
6
  const request_1 = require("../../../../request");
7
+ const aadGroup_1 = require("../../../../utils/aadGroup");
7
8
  class TeamsChannelMemberSetCommand extends GraphCommand_1.default {
8
9
  constructor() {
9
10
  super(...arguments);
@@ -62,27 +63,13 @@ class TeamsChannelMemberSetCommand extends GraphCommand_1.default {
62
63
  if (args.options.teamId) {
63
64
  return Promise.resolve(args.options.teamId);
64
65
  }
65
- const requestOptions = {
66
- url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
67
- headers: {
68
- accept: 'application/json;odata.metadata=none'
69
- },
70
- responseType: 'json'
71
- };
72
- return request_1.default
73
- .get(requestOptions)
74
- .then(response => {
75
- const groupItem = response.value[0];
76
- if (!groupItem) {
66
+ return aadGroup_1.aadGroup
67
+ .getGroupByDisplayName(args.options.teamName)
68
+ .then(group => {
69
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
77
70
  return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
78
71
  }
79
- if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
80
- return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
81
- }
82
- if (response.value.length > 1) {
83
- return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
84
- }
85
- return Promise.resolve(groupItem.id);
72
+ return group.id;
86
73
  });
87
74
  }
88
75
  getChannelId(args) {
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTabGetCommand extends GraphCommand_1.default {
@@ -30,27 +31,13 @@ class TeamsTabGetCommand extends GraphCommand_1.default {
30
31
  if (args.options.teamId) {
31
32
  return Promise.resolve(args.options.teamId);
32
33
  }
33
- const requestOptions = {
34
- url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
35
- headers: {
36
- accept: 'application/json;odata.metadata=none'
37
- },
38
- responseType: 'json'
39
- };
40
- return request_1.default
41
- .get(requestOptions)
42
- .then(response => {
43
- const groupItem = response.value[0];
44
- if (!groupItem) {
34
+ return aadGroup_1.aadGroup
35
+ .getGroupByDisplayName(args.options.teamName)
36
+ .then(group => {
37
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
45
38
  return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
46
39
  }
47
- if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
48
- return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
49
- }
50
- if (response.value.length > 1) {
51
- return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
52
- }
53
- return Promise.resolve(groupItem.id);
40
+ return group.id;
54
41
  });
55
42
  }
56
43
  getChannelId(args) {
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
+ const aadGroup_1 = require("../../../../utils/aadGroup");
4
5
  const GraphCommand_1 = require("../../../base/GraphCommand");
5
6
  const commands_1 = require("../../commands");
6
7
  var TeamsAsyncOperationStatus;
@@ -94,13 +95,7 @@ class TeamsTeamAddCommand extends GraphCommand_1.default {
94
95
  if (teamsAsyncOperation.status !== TeamsAsyncOperationStatus.Succeeded) {
95
96
  return Promise.resolve(teamsAsyncOperation);
96
97
  }
97
- return request_1.default.get({
98
- url: `${this.resource}/v1.0/groups/${teamsAsyncOperation.targetResourceId}`,
99
- headers: {
100
- accept: 'application/json;odata.metadata=minimal'
101
- },
102
- responseType: 'json'
103
- });
98
+ return aadGroup_1.aadGroup.getGroupById(teamsAsyncOperation.targetResourceId);
104
99
  })
105
100
  .then((output) => {
106
101
  logger.log(output);
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTeamGetCommand extends GraphCommand_1.default {
@@ -21,27 +22,13 @@ class TeamsTeamGetCommand extends GraphCommand_1.default {
21
22
  if (args.options.id) {
22
23
  return Promise.resolve(args.options.id);
23
24
  }
24
- const requestOptions = {
25
- url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.name)}'&$select=id,resourceProvisioningOptions`,
26
- headers: {
27
- accept: 'application/json;odata.metadata=none'
28
- },
29
- responseType: 'json'
30
- };
31
- return request_1.default
32
- .get(requestOptions)
33
- .then(response => {
34
- const groupItem = response.value[0];
35
- if (!groupItem) {
36
- return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
37
- }
38
- if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
25
+ return aadGroup_1.aadGroup
26
+ .getGroupByDisplayName(args.options.name)
27
+ .then(group => {
28
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
39
29
  return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
40
30
  }
41
- if (response.value.length >= 2) {
42
- return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.name} found: ${response.value.map(x => x.id)}`);
43
- }
44
- return Promise.resolve(groupItem.id);
31
+ return group.id;
45
32
  });
46
33
  }
47
34
  commandAction(logger, args, cb) {
@@ -0,0 +1,57 @@
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
+ exports.aadGroup = void 0;
13
+ const request_1 = require("../request");
14
+ const odata_1 = require("./odata");
15
+ const graphResource = 'https://graph.microsoft.com';
16
+ exports.aadGroup = {
17
+ /**
18
+ * Retrieve a single group.
19
+ * @param id Group ID.
20
+ */
21
+ getGroupById(id) {
22
+ const requestOptions = {
23
+ url: `${graphResource}/v1.0/groups/${id}`,
24
+ headers: {
25
+ accept: 'application/json;odata.metadata=none'
26
+ },
27
+ responseType: 'json'
28
+ };
29
+ return request_1.default.get(requestOptions);
30
+ },
31
+ /**
32
+ * Get a list of groups by display name.
33
+ * @param displayName Group display name.
34
+ */
35
+ getGroupsByDisplayName(displayName) {
36
+ return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(displayName)}'`);
37
+ },
38
+ /**
39
+ * Get a single group by its display name.
40
+ * @param displayName Group display name.
41
+ * @throws Error when group was not found.
42
+ * @throws Error when multiple groups with the same name were found.
43
+ */
44
+ getGroupByDisplayName(displayName) {
45
+ return __awaiter(this, void 0, void 0, function* () {
46
+ const groups = yield this.getGroupsByDisplayName(displayName);
47
+ if (!groups.length) {
48
+ throw Error(`The specified group '${displayName}' does not exist.`);
49
+ }
50
+ if (groups.length > 1) {
51
+ throw Error(`Multiple groups with name '${displayName}' found: ${groups.map(x => x.id).join(',')}.`);
52
+ }
53
+ return groups[0];
54
+ });
55
+ }
56
+ };
57
+ //# sourceMappingURL=aadGroup.js.map
@@ -14,12 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./aadGroup"), exports);
17
18
  __exportStar(require("./accessToken"), exports);
18
19
  __exportStar(require("./formatting"), exports);
19
20
  __exportStar(require("./fsUtil"), exports);
20
21
  __exportStar(require("./md"), exports);
21
22
  __exportStar(require("./odata"), exports);
22
23
  __exportStar(require("./packageManager"), exports);
24
+ __exportStar(require("./planner"), exports);
23
25
  __exportStar(require("./sinonUtil"), exports);
24
26
  __exportStar(require("./spfx"), exports);
25
27
  __exportStar(require("./spo"), exports);
@@ -37,22 +37,32 @@ exports.validation = {
37
37
  return dateTimeRegEx.test(date) ? true : dateOnlyRegEx.test(date);
38
38
  },
39
39
  isValidISODateTime(dateTime) {
40
- const withMilliSecsPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])\.[0-9]{3}Z$/);
41
- if (withMilliSecsPattern.test(dateTime)) {
40
+ // Format: 2000-01-01T00:00:00.0000000Z
41
+ const withMilliSecsLongPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])\.[0-9]{7}Z$/);
42
+ if (withMilliSecsLongPattern.test(dateTime)) {
42
43
  return true;
43
44
  }
45
+ // Format: 2000-01-01T00:00:00.000Z
46
+ const withMilliSecsShortPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])\.[0-9]{3}Z$/);
47
+ if (withMilliSecsShortPattern.test(dateTime)) {
48
+ return true;
49
+ }
50
+ // Format: 2000-01-01T00:00:00Z
44
51
  const withSecsPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])Z$/);
45
52
  if (withSecsPattern.test(dateTime)) {
46
53
  return true;
47
54
  }
55
+ // Format: 2000-01-01T00:00Z
48
56
  const withMinutesPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9])Z$/);
49
57
  if (withMinutesPattern.test(dateTime)) {
50
58
  return true;
51
59
  }
60
+ // Format: 2000-01-01T00Z
52
61
  const withHoursPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3])Z$/);
53
62
  if (withHoursPattern.test(dateTime)) {
54
63
  return true;
55
64
  }
65
+ // Format: 2000-01-01
56
66
  const withoutTimePattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))$/);
57
67
  if (withoutTimePattern.test(dateTime)) {
58
68
  return true;
@@ -27,20 +27,20 @@ This command is an improved version of the `spo file list` command. The main dif
27
27
 
28
28
  ## Examples
29
29
 
30
- Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
30
+ Return all files from the folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
31
31
 
32
32
  ```sh
33
- m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
33
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents'
34
34
  ```
35
35
 
36
36
  Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
37
37
 
38
38
  ```sh
39
- m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
39
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --recursive
40
40
  ```
41
41
 
42
42
  Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
43
43
 
44
44
  ```sh
45
- m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
45
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents/Important'
46
46
  ```
@@ -17,16 +17,16 @@ 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. Use when referring to bucket using `name`. Specify either `planId` or `planName` but not both.
20
+ : ID of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`.
21
21
 
22
22
  `--planName [planName]`
23
- : Name of the plan to update the bucket of. Use when referring to bucket using `name`. Specify either `planId` or `planName` but not both.
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`.
24
24
 
25
25
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Use when referring to plan using `planName`. Specify `ownerGroupId` or `ownerGroupName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
27
27
 
28
28
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Use when referring to plan using `planName`. Specify `ownerGroupId` or `ownerGroupName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
30
30
 
31
31
  `--newName [newName]`
32
32
  : New name of the bucket.
@@ -17,10 +17,10 @@ m365 planner plan details get [options]
17
17
  : Title of the plan. Specify either `planId` or `planTitle` but not both.
18
18
 
19
19
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
20
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
21
 
22
22
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
23
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -10,17 +10,17 @@ m365 planner plan get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i,--id [id]`
13
+ `-i, --id [id]`
14
14
  : ID of the plan. Specify either `id` or `title` but not both.
15
15
 
16
- `-t,--title [title]`
16
+ `-t, --title [title]`
17
17
  : Title of the plan. Specify either `id` or `title` but not both.
18
18
 
19
19
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
20
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
21
21
 
22
22
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
23
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -0,0 +1,36 @@
1
+ # planner task checklistitem add
2
+
3
+ Adds a new checklist item to a Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task checklistitem add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task.
15
+
16
+ `-t, --title <title>`
17
+ : Title of the checklist item.
18
+
19
+ `--isChecked`
20
+ : Mark the checklist item as checked.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Examples
25
+
26
+ Adds an unchecked checklist item with title _My checklist item_ to a Microsoft Planner task with ID _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
27
+
28
+ ```sh
29
+ m365 planner task checklistitem add --taskId 2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2 --title "My checklist item"
30
+ ```
31
+
32
+ Adds a checked checklist item with title _My checklist item_ to a Microsoft Planner task with ID _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
33
+
34
+ ```sh
35
+ m365 planner task checklistitem add --taskId 2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2 --title "My checklist item" --isChecked
36
+ ```
@@ -16,6 +16,9 @@ m365 planner task get [options]
16
16
  `-t, --title [title]`
17
17
  : Title of the task. Specify either `id` or `title` but not both.
18
18
 
19
+ `--taskId [taskId]`
20
+ : (deprecated. Use `id` instead) ID of the task.
21
+
19
22
  `--bucketId [bucketId]`
20
23
  : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
21
24
 
@@ -0,0 +1,78 @@
1
+ # planner task remove
2
+
3
+ Removes the Microsoft Planner task from a plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id [id]`
14
+ : ID of the task to remove. Specify either `id` or `title` but not both.
15
+
16
+ `--title [title]`
17
+ : Title of the task to remove. Specify either `id` or `title` but not both.
18
+
19
+ `--bucketId [bucketId]`
20
+ : ID of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
21
+
22
+ `--bucketName [bucketName]`
23
+ : Name of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
24
+
25
+ `--planId [planId]`
26
+ : ID of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
27
+
28
+ `--planTitle [planTitle]`
29
+ : Title of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
30
+
31
+ `--ownerGroupId [ownerGroupId]`
32
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
33
+
34
+ `--ownerGroupName [ownerGroupName]`
35
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
+
37
+ `--confirm`
38
+ : Don't prompt for confirmation
39
+
40
+ --8<-- "docs/cmd/_global.md"
41
+
42
+ ## Examples
43
+
44
+ Removes the Microsoft Planner task by ID
45
+
46
+ ```sh
47
+ m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
48
+ ```
49
+
50
+ Removes the Microsoft Planner task by ID without confirmation
51
+
52
+ ```sh
53
+ m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
54
+ ```
55
+
56
+ Removes the Microsoft Planner task with title _My Task_ in the bucket with ID _vncYUXCRBke28qMLB-d4xJcACtNz_
57
+
58
+ ```sh
59
+ m365 planner task remove --title "My Task" --bucketId "vncYUXCRBke28qMLB-d4xJcACtNz"
60
+ ```
61
+
62
+ Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
63
+
64
+ ```sh
65
+ m365 planner task remove --title "My Task" --bucketName "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
66
+ ```
67
+
68
+ 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_
69
+
70
+ ```sh
71
+ m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
72
+ ```
73
+
74
+ 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_
75
+
76
+ ```sh
77
+ m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
78
+ ```
@@ -17,10 +17,10 @@ m365 planner task set [options]
17
17
  : New title of the task.
18
18
 
19
19
  `--bucketId [bucketId]`
20
- : ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
20
+ : ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` when using `title`.
21
21
 
22
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.
23
+ : 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`.
24
24
 
25
25
  `--planId [planId]`
26
26
  : ID of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
@@ -0,0 +1,28 @@
1
+ # planner tenant settings list
2
+
3
+ Lists the Microsoft Planner configuration of the tenant
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner tenant settings list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Remarks
16
+
17
+ !!! important
18
+ To use this command you must be a global administrator.
19
+
20
+ After executing the command `planner tenant settings set`, it can take some time for all changes to propagate across the tenant. Because of this, executing this command right away can return some unexpected results.
21
+
22
+ ## Examples
23
+
24
+ Lists the Microsoft Planner settings of the tenant
25
+
26
+ ```sh
27
+ m365 planner tenant settings list
28
+ ```
@@ -0,0 +1,64 @@
1
+ # spo eventreceiver list
2
+
3
+ Retrieves event receivers for the specified web, site or list.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo eventreceiver list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the web for which to retrieve the event receivers.
15
+
16
+ `--listTitle [listTitle]`
17
+ : The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
18
+ Specify either `listTitle`, `listId` or `listUrl`.
19
+
20
+ `--listId [listId]`
21
+ : The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
22
+ Specify either `listTitle`, `listId` or `listUrl`.
23
+
24
+ `--listUrl [listUrl]`
25
+ : The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
26
+ Specify either `listTitle`, `listId` or `listUrl`.
27
+
28
+ `-s, --scope [scope]`
29
+ : The scope of which to retrieve the Event Receivers.
30
+ Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
31
+
32
+ --8<-- "docs/cmd/_global.md"
33
+
34
+ ## Examples
35
+
36
+ Retrieves event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
37
+
38
+ ```sh
39
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
40
+ ```
41
+
42
+ Retrieves event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_.
43
+
44
+ ```sh
45
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site
46
+ ```
47
+
48
+ Retrieves event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
49
+
50
+ ```sh
51
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
52
+ ```
53
+
54
+ Retrieves event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
55
+
56
+ ```sh
57
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
58
+ ```
59
+
60
+ Retrieves event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
61
+
62
+ ```sh
63
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
64
+ ```
@@ -32,5 +32,5 @@ m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x -
32
32
  Checks out file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
33
33
 
34
34
  ```sh
35
- m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
35
+ m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
36
36
  ```
@@ -13,11 +13,17 @@ m365 spo listitem list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site from which the item should be retrieved
15
15
 
16
- `-i, --id [id]`
17
- : ID of the list to retrieve items from. Specify `id` or `title` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
18
18
 
19
- `-t, --title [title]`
20
- : Title of the list from which to retrieve the item. Specify `id` or `title` but not both
19
+ `--id [id]`
20
+ : (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
21
+
22
+ `-t, --listTitle [listTitle]`
23
+ : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
24
+
25
+ `--title [title]`
26
+ : (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
21
27
 
22
28
  `-q, --camlQuery [camlQuery]`
23
29
  : CAML query to use to query the list of items with
@@ -45,35 +51,35 @@ m365 spo listitem list [options]
45
51
  Get all items from a list named Demo List
46
52
 
47
53
  ```sh
48
- m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
54
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
49
55
  ```
50
56
 
51
57
  From a list named _Demo List_ get all items with title _Demo list item_ using a CAML query
52
58
 
53
59
  ```sh
54
- m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query></View>"
60
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query></View>"
55
61
  ```
56
62
 
57
63
  Get all items from a list with ID _935c13a0-cc53-4103-8b48-c1d0828eaa7f_
58
64
 
59
65
  ```sh
60
- m365 spo listitem list --id 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x
66
+ m365 spo listitem list --listId 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x
61
67
  ```
62
68
 
63
69
  Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_ and _Modified_ fields
64
70
 
65
71
  ```sh
66
- m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
72
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
67
73
  ```
68
74
 
69
75
  From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
70
76
 
71
77
  ```sh
72
- m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
78
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
73
79
  ```
74
80
 
75
81
  From a list named _Demo List_ get the second batch of 10 items
76
82
 
77
83
  ```sh
78
- m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
84
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
79
85
  ```