@pnp/cli-microsoft365 5.2.0 → 5.3.0-beta.2a76d05

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 (112) hide show
  1. package/.eslintrc.js +1 -0
  2. package/dist/Auth.js +5 -0
  3. package/dist/m365/aad/commands/app/app-add.js +91 -35
  4. package/dist/m365/aad/commands/app/app-role-list.js +1 -1
  5. package/dist/m365/aad/commands/app/app-set.js +91 -0
  6. package/dist/m365/aad/commands/approleassignment/approleassignment-list.js +55 -22
  7. package/dist/m365/aad/commands/group/group-list.js +1 -1
  8. package/dist/m365/aad/commands/groupsetting/groupsetting-list.js +1 -1
  9. package/dist/m365/aad/commands/groupsettingtemplate/groupsettingtemplate-get.js +1 -1
  10. package/dist/m365/aad/commands/groupsettingtemplate/groupsettingtemplate-list.js +1 -1
  11. package/dist/m365/aad/commands/o365group/o365group-conversation-list.js +1 -1
  12. package/dist/m365/aad/commands/o365group/o365group-conversation-post-list.js +1 -1
  13. package/dist/m365/aad/commands/o365group/o365group-list.js +1 -1
  14. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-clear.js +3 -3
  15. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-list.js +1 -1
  16. package/dist/m365/aad/commands/o365group/o365group-user-list.js +2 -2
  17. package/dist/m365/aad/commands/o365group/o365group-user-set.js +2 -2
  18. package/dist/m365/aad/commands/user/user-list.js +1 -1
  19. package/dist/m365/aad/commands/user/user-signin-list.js +1 -1
  20. package/dist/m365/aad/commands.js +1 -1
  21. package/dist/m365/app/commands/app-open.js +64 -0
  22. package/dist/m365/app/commands.js +1 -0
  23. package/dist/m365/base/PowerBICommand.js +10 -0
  24. package/dist/m365/file/commands/file-list.js +1 -1
  25. package/dist/m365/outlook/commands/message/message-list.js +1 -1
  26. package/dist/m365/outlook/commands/room/room-list.js +1 -1
  27. package/dist/m365/outlook/commands/roomlist/roomlist-list.js +1 -1
  28. package/dist/m365/planner/commands/bucket/bucket-add.js +8 -16
  29. package/dist/m365/planner/commands/bucket/bucket-get.js +186 -0
  30. package/dist/m365/planner/commands/bucket/bucket-list.js +10 -19
  31. package/dist/m365/planner/commands/bucket/bucket-remove.js +202 -0
  32. package/dist/m365/planner/commands/bucket/bucket-set.js +9 -21
  33. package/dist/m365/planner/commands/plan/plan-add.js +6 -1
  34. package/dist/m365/planner/commands/plan/plan-details-get.js +12 -15
  35. package/dist/m365/planner/commands/plan/plan-get.js +13 -18
  36. package/dist/m365/planner/commands/plan/plan-list.js +10 -13
  37. package/dist/m365/planner/commands/task/task-add.js +8 -16
  38. package/dist/m365/planner/commands/task/task-details-get.js +6 -0
  39. package/dist/m365/planner/commands/task/task-get.js +138 -7
  40. package/dist/m365/planner/commands/task/task-list.js +15 -24
  41. package/dist/m365/planner/commands/task/task-reference-add.js +75 -0
  42. package/dist/m365/planner/commands/task/task-reference-list.js +45 -0
  43. package/dist/m365/planner/commands/task/task-set.js +9 -18
  44. package/dist/m365/planner/commands.js +5 -1
  45. package/dist/m365/pp/commands/gateway/gateway-list.js +36 -0
  46. package/dist/m365/pp/commands/managementapp/managementapp-list.js +1 -1
  47. package/dist/m365/pp/commands.js +1 -0
  48. package/dist/m365/search/commands/externalconnection/externalconnection-list.js +26 -0
  49. package/dist/m365/search/commands.js +2 -1
  50. package/dist/m365/spo/commands/eventreceiver/eventreceiver-get.js +119 -0
  51. package/dist/m365/spo/commands/field/field-list.js +84 -0
  52. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +84 -0
  53. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +76 -0
  54. package/dist/m365/spo/commands/list/list-view-add.js +113 -0
  55. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +83 -0
  56. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +79 -0
  57. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +49 -0
  58. package/dist/m365/spo/commands.js +8 -0
  59. package/dist/m365/teams/commands/app/app-list.js +1 -1
  60. package/dist/m365/teams/commands/channel/channel-list.js +1 -1
  61. package/dist/m365/teams/commands/channel/channel-member-add.js +4 -1
  62. package/dist/m365/teams/commands/channel/channel-member-list.js +1 -1
  63. package/dist/m365/teams/commands/channel/channel-member-remove.js +3 -0
  64. package/dist/m365/teams/commands/channel/channel-member-set.js +3 -0
  65. package/dist/m365/teams/commands/chat/chat-get.js +8 -8
  66. package/dist/m365/teams/commands/chat/chat-list.js +1 -1
  67. package/dist/m365/teams/commands/chat/chat-member-list.js +1 -1
  68. package/dist/m365/teams/commands/chat/chat-message-list.js +1 -1
  69. package/dist/m365/teams/commands/chat/chat-message-send.js +6 -6
  70. package/dist/m365/teams/commands/chat/chatUtil.js +4 -4
  71. package/dist/m365/teams/commands/message/message-list.js +1 -1
  72. package/dist/m365/teams/commands/message/message-reply-list.js +1 -1
  73. package/dist/m365/teams/commands/tab/tab-list.js +1 -1
  74. package/dist/m365/teams/commands/team/team-list.js +1 -1
  75. package/dist/m365/teams/commands/user/user-app-list.js +1 -1
  76. package/dist/m365/teams/commands/user/user-list.js +2 -2
  77. package/dist/m365/tenant/commands/security/security-alerts-list.js +71 -0
  78. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +1 -1
  79. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +1 -1
  80. package/dist/m365/tenant/commands.js +1 -0
  81. package/dist/m365/todo/commands/list/list-list.js +1 -1
  82. package/dist/m365/todo/commands/task/task-list.js +1 -1
  83. package/dist/utils/accessToken.js +18 -0
  84. package/dist/utils/formatting.js +11 -2
  85. package/dist/utils/odata.js +2 -2
  86. package/dist/utils/planner.js +65 -0
  87. package/docs/docs/cmd/aad/app/app-add.md +15 -0
  88. package/docs/docs/cmd/aad/app/app-set.md +17 -0
  89. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +1 -1
  90. package/docs/docs/cmd/app/app-open.md +45 -0
  91. package/docs/docs/cmd/planner/bucket/bucket-get.md +57 -0
  92. package/docs/docs/cmd/planner/bucket/bucket-remove.md +60 -0
  93. package/docs/docs/cmd/planner/task/task-get.md +30 -3
  94. package/docs/docs/cmd/planner/task/task-reference-add.md +45 -0
  95. package/docs/docs/cmd/planner/task/task-reference-list.md +24 -0
  96. package/docs/docs/cmd/pp/gateway/gateway-list.md +21 -0
  97. package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +21 -0
  98. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +70 -0
  99. package/docs/docs/cmd/spo/field/field-list.md +51 -0
  100. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +55 -0
  101. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +36 -0
  102. package/docs/docs/cmd/spo/list/list-view-add.md +67 -0
  103. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +58 -0
  104. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +39 -0
  105. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +24 -0
  106. package/docs/docs/cmd/spo/userprofile/userprofile-get.md +1 -1
  107. package/docs/docs/cmd/teams/channel/channel-member-list.md +4 -4
  108. package/docs/docs/cmd/teams/channel/channel-member-remove.md +2 -2
  109. package/docs/docs/cmd/teams/channel/channel-member-set.md +2 -2
  110. package/docs/docs/cmd/tenant/security/security-alerts-list.md +30 -0
  111. package/npm-shrinkwrap.json +1517 -1284
  112. package/package.json +26 -25
@@ -45,7 +45,7 @@ class TodoTaskListCommand extends GraphCommand_1.default {
45
45
  .getTodoListId(args)
46
46
  .then((listId) => {
47
47
  const endpoint = `${this.resource}/v1.0/me/todo/lists/${listId}/tasks`;
48
- return utils_1.odata.getAllItems(endpoint, logger);
48
+ return utils_1.odata.getAllItems(endpoint);
49
49
  })
50
50
  .then((items) => {
51
51
  if (args.options.output === 'json') {
@@ -2,6 +2,24 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.accessToken = void 0;
4
4
  exports.accessToken = {
5
+ isAppOnlyAccessToken(accessToken) {
6
+ let isAppOnlyAccessToken = false;
7
+ if (!accessToken || accessToken.length === 0) {
8
+ return isAppOnlyAccessToken;
9
+ }
10
+ const chunks = accessToken.split('.');
11
+ if (chunks.length !== 3) {
12
+ return isAppOnlyAccessToken;
13
+ }
14
+ const tokenString = Buffer.from(chunks[1], 'base64').toString();
15
+ try {
16
+ const token = JSON.parse(tokenString);
17
+ isAppOnlyAccessToken = token.idtyp === 'app';
18
+ }
19
+ catch (_a) {
20
+ }
21
+ return isAppOnlyAccessToken;
22
+ },
5
23
  getTenantIdFromAccessToken(accessToken) {
6
24
  let tenantId = '';
7
25
  if (!accessToken || accessToken.length === 0) {
@@ -30,8 +30,9 @@ exports.formatting = {
30
30
  return JSON.parse(s.replace(/^\uFEFF/, ''));
31
31
  },
32
32
  filterObject(obj, propertiesToInclude) {
33
- return Object.keys(obj)
34
- .filter(key => propertiesToInclude.includes(key))
33
+ const objKeys = Object.keys(obj);
34
+ return propertiesToInclude
35
+ .filter(prop => objKeys.includes(prop))
35
36
  .reduce((filtered, key) => {
36
37
  filtered[key] = obj[key];
37
38
  return filtered;
@@ -64,6 +65,14 @@ exports.formatting = {
64
65
  },
65
66
  splitAndTrim(s) {
66
67
  return s.split(',').map(c => c.trim());
68
+ },
69
+ openTypesEncoder(value) {
70
+ return value
71
+ .replace(/\%/g, '%25')
72
+ .replace(/\./g, '%2E')
73
+ .replace(/:/g, '%3A')
74
+ .replace(/@/g, '%40')
75
+ .replace(/#/g, '%23');
67
76
  }
68
77
  };
69
78
  //# sourceMappingURL=formatting.js.map
@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.odata = void 0;
13
13
  const request_1 = require("../request");
14
14
  exports.odata = {
15
- getAllItems(url, logger, metadata) {
15
+ getAllItems(url, metadata) {
16
16
  var _a;
17
17
  return __awaiter(this, void 0, void 0, function* () {
18
18
  let items = [];
@@ -27,7 +27,7 @@ exports.odata = {
27
27
  items = res.value;
28
28
  const nextLink = (_a = res['@odata.nextLink']) !== null && _a !== void 0 ? _a : res.nextLink;
29
29
  if (nextLink) {
30
- const nextPageItems = yield exports.odata.getAllItems(nextLink, logger, metadata);
30
+ const nextPageItems = yield exports.odata.getAllItems(nextLink, metadata);
31
31
  items = items.concat(nextPageItems);
32
32
  }
33
33
  return items;
@@ -0,0 +1,65 @@
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.planner = void 0;
13
+ const request_1 = require("../request");
14
+ const odata_1 = require("./odata");
15
+ const graphResource = 'https://graph.microsoft.com';
16
+ const getRequestOptions = (url, metadata) => ({
17
+ url: url,
18
+ headers: {
19
+ accept: `application/json;odata.metadata=${metadata}`
20
+ },
21
+ responseType: 'json'
22
+ });
23
+ exports.planner = {
24
+ /**
25
+ * Get Planner plan by ID.
26
+ * @param id Planner ID.
27
+ */
28
+ getPlanById(id) {
29
+ return __awaiter(this, void 0, void 0, function* () {
30
+ const requestOptions = getRequestOptions(`${graphResource}/v1.0/planner/plans/${id}`, 'none');
31
+ try {
32
+ return yield request_1.default.get(requestOptions);
33
+ }
34
+ catch (ex) {
35
+ throw Error(`Planner plan with id '${id}' was not found.`);
36
+ }
37
+ });
38
+ },
39
+ /**
40
+ * Get all Planner plans for a specific group.
41
+ * @param groupId Group ID.
42
+ */
43
+ getPlansByGroupId(groupId) {
44
+ return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
45
+ },
46
+ /**
47
+ * Get Planner plan by name in a specific group.
48
+ * @param name Name of the Planner plan. Case insensitive.
49
+ * @param groupId Owner group ID .
50
+ */
51
+ getPlanByName(name, groupId) {
52
+ return __awaiter(this, void 0, void 0, function* () {
53
+ const plans = yield this.getPlansByGroupId(groupId);
54
+ const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
55
+ if (!filteredPlans.length) {
56
+ throw Error(`The specified plan '${name}' does not exist.`);
57
+ }
58
+ if (filteredPlans.length > 1) {
59
+ throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
60
+ }
61
+ return filteredPlans[0];
62
+ });
63
+ }
64
+ };
65
+ //# sourceMappingURL=planner.js.map
@@ -49,6 +49,15 @@ m365 aad app add [options]
49
49
  `--scopeAdminConsentDescription [scopeAdminConsentDescription]`
50
50
  : Scope admin consent description
51
51
 
52
+ `--certificateFile [certificateFile]`
53
+ : Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
54
+
55
+ `--certificateBase64Encoded [certificateBase64Encoded]`
56
+ : Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
57
+
58
+ `--certificateDisplayName [certificateDisplayName]`
59
+ : Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
60
+
52
61
  `--manifest [manifest]`
53
62
  : Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
54
63
 
@@ -152,3 +161,9 @@ Create new Azure AD app registration with the specified name. Store information
152
161
  ```sh
153
162
  m365 aad app add --name 'My AAD app' --save
154
163
  ```
164
+
165
+ Create new Azure AD app registration with a certificate
166
+
167
+ ```sh
168
+ m365 aad app add --name 'My AAD app' --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
169
+ ```
@@ -31,6 +31,15 @@ m365 aad app set [options]
31
31
  `--redirectUrisToRemove [redirectUrisToRemove]`
32
32
  : Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
33
33
 
34
+ `--certificateFile [certificateFile]`
35
+ : Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
36
+
37
+ `--certificateBase64Encoded [certificateBase64Encoded]`
38
+ : Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
39
+
40
+ `--certificateDisplayName [certificateDisplayName]`
41
+ : Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
42
+
34
43
  --8<-- "docs/cmd/_global.md"
35
44
 
36
45
  ## Remarks
@@ -39,6 +48,8 @@ For best performance use the `objectId` option to reference the Azure AD applica
39
48
 
40
49
  If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
41
50
 
51
+ When a certificate is specified it will be added to the list of certificates of the app without changing existing certificates.
52
+
42
53
  ## Examples
43
54
 
44
55
  Update the app URI of the Azure AD application registration specified by its object ID
@@ -70,3 +81,9 @@ Replace one redirect URI with another for SPA authentication
70
81
  ```sh
71
82
  m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
72
83
  ```
84
+
85
+ Add a certificate to the app
86
+
87
+ ```sh
88
+ m365 aad app set --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
89
+ ```
@@ -1,4 +1,4 @@
1
- # aad approleassignment add
1
+ # aad approleassignment remove
2
2
 
3
3
  Deletes an app role assignment for the specified Azure AD Application Registration
4
4
 
@@ -0,0 +1,45 @@
1
+ # aad app open
2
+
3
+ Returns deep link of the current AD app to open the Azure portal on the Azure AD app registration management page.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 app open [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Optional Application (client) ID of the Azure AD application registration to open. Uses the app from the `.m365rc.json` file corresponding to the `appId`. If multiple apps are available, this will evade the prompt to choose an app. If the `appId` is not available in the list of apps, an error is thrown.
15
+
16
+ `--preview`
17
+ : Use to open the url of the Azure AD preview portal.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Remarks
22
+
23
+ If config setting `autoOpenLinksInBrowser` is configured to true, the command will automatically open the link to the Azure Portal in the browser.
24
+
25
+ Gets the app from the `.m365rc.json` file in the current directory. If the `--appId` option is not used and multiple apps are available, it will prompt the user to choose one.
26
+
27
+ ## Examples
28
+
29
+ Prints the URL to the Azure AD application registration management page on the Azure Portal.
30
+
31
+ ```sh
32
+ m365 app open
33
+ ```
34
+
35
+ Prints the url of the Azure AD application registration management page on the preview Azure Portal.
36
+
37
+ ```sh
38
+ m365 app open --preview
39
+ ```
40
+
41
+ Prints the URL to the Azure AD application registration management page on the Azure Portal, evading a possible choice prompt in the case of multiple saved apps in the `.m365rc.json` file.
42
+
43
+ ```sh
44
+ m365 app open --appId d75be2e1-0204-4f95-857d-51a37cf40be8
45
+ ```
@@ -0,0 +1,57 @@
1
+ # planner bucket get
2
+
3
+ Gets the Microsoft Planner bucket in a plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner bucket get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id [id]`
14
+ : ID of the bucket to retrieve details. Specify either `id` or `name` but not both.
15
+
16
+ `-name, --name [name]`
17
+ : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
+
19
+ `--planId [planId]`
20
+ : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
21
+
22
+ `--planName [planName]`
23
+ : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
24
+
25
+ `--ownerGroupId [ownerGroupId]`
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
27
+
28
+ `--ownerGroupName [ownerGroupName]`
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Examples
34
+
35
+ Gets the specified Microsoft Planner bucket
36
+
37
+ ```sh
38
+ m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
39
+ ```
40
+
41
+ Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
42
+
43
+ ```sh
44
+ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
45
+ ```
46
+
47
+ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
+
49
+ ```sh
50
+ m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
51
+ ```
52
+
53
+ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
+
55
+ ```sh
56
+ m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
+ ```
@@ -0,0 +1,60 @@
1
+ # planner bucket remove
2
+
3
+ Removes the Microsoft Planner bucket from a plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner bucket remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id [id]`
14
+ : ID of the bucket to remove. Specify either `id` or `name` but not both.
15
+
16
+ `--name [name]`
17
+ : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
+
19
+ `--planId [planId]`
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
21
+
22
+ `--planName [planName]`
23
+ : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
24
+
25
+ `--ownerGroupId [ownerGroupId]`
26
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
27
+
28
+ `--ownerGroupName [ownerGroupName]`
29
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
30
+
31
+ `--confirm`
32
+ : Don't prompt for confirmation
33
+
34
+ --8<-- "docs/cmd/_global.md"
35
+
36
+ ## Examples
37
+
38
+ Removes the Microsoft Planner bucket by ID
39
+
40
+ ```sh
41
+ m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz"
42
+ ```
43
+
44
+ Removes the Microsoft Planner bucket by ID without confirmation
45
+
46
+ ```sh
47
+ m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz" --confirm
48
+ ```
49
+
50
+ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
51
+
52
+ ```sh
53
+ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
54
+ ```
55
+
56
+ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
+
58
+ ```sh
59
+ m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
60
+ ```
@@ -10,8 +10,29 @@ m365 planner task get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : ID of the task to retrieve details from
13
+ `-i, --id [id]`
14
+ : ID of the task. Specify either `id` or `title` but not both. When you specify the task ID, you no longer need to provide the information for `bucket`, `plan`, and `ownerGroup`.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the task. Specify either `id` or `title` but not both.
18
+
19
+ `--bucketId [bucketId]`
20
+ : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
21
+
22
+ `--bucketName [bucketName]`
23
+ : Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
24
+
25
+ `--planId [planId]`
26
+ : Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
27
+
28
+ `--planName [planName]`
29
+ : Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
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`.
15
36
 
16
37
  --8<-- "docs/cmd/_global.md"
17
38
 
@@ -22,8 +43,14 @@ m365 planner task get [options]
22
43
 
23
44
  ## Examples
24
45
 
25
- Retrieve the the specified planner task
46
+ Retrieve the the specified planner task by id.
26
47
 
27
48
  ```sh
28
49
  m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
29
50
  ```
51
+
52
+ Retrieve the 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
+
54
+ ```sh
55
+ m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
56
+ ```
@@ -0,0 +1,45 @@
1
+ # planner task reference add
2
+
3
+ Adds a new reference to a Planner task.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task reference add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task.
15
+
16
+ `-u, --url <url>`
17
+ : URL location of the reference.
18
+
19
+ `--alias [alias]`
20
+ : A name alias to describe the reference.
21
+
22
+ `--type [type]`
23
+ : Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Add a new reference with the url _https://www.microsoft.com_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
30
+
31
+ ```sh
32
+ m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com"
33
+ ```
34
+
35
+ Add a new reference with the url _https://www.microsoft.com_ and with the alias _Parker_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
36
+
37
+ ```sh
38
+ m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --alias "Parker"
39
+ ```
40
+
41
+ Add a new reference with the url _https://www.microsoft.com_ and with the type Excel to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
42
+
43
+ ```sh
44
+ m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
45
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task reference list
2
+
3
+ Retrieve the references associated to a Planner task.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task reference list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task to retrieve references from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Retrieve the references of the specified planner task
21
+
22
+ ```sh
23
+ m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
24
+ ```
@@ -0,0 +1,21 @@
1
+ # pp gateway list
2
+
3
+ Returns a list of gateways for which the user is an admin
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp gateway list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ List gateways for which the user is an admin
18
+
19
+ ```sh
20
+ m365 pp gateway list
21
+ ```
@@ -0,0 +1,21 @@
1
+ # search externalconnection list
2
+
3
+ Lists external connections defined in Microsoft Search
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 search externalconnection list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ List external connections defined in Microsoft Search
18
+
19
+ ```sh
20
+ m365 search externalconnection list
21
+ ```
@@ -0,0 +1,70 @@
1
+ # spo eventreceiver get
2
+
3
+ Retrieves specific event receiver for the specified web, site or list by event receiver name or id.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo eventreceiver get [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
+ `-n, --name [name]`
29
+ The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
+
31
+ `-i, --id [id]`
32
+ The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
+
34
+ `-s, --scope [scope]`
35
+ : The scope of which to retrieve the Event Receivers.
36
+ Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
37
+
38
+ --8<-- "docs/cmd/_global.md"
39
+
40
+ ## Examples
41
+
42
+ Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
43
+
44
+ ```sh
45
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
46
+ ```
47
+
48
+ Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
49
+
50
+ ```sh
51
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
52
+ ```
53
+
54
+ Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
55
+
56
+ ```sh
57
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
58
+ ```
59
+
60
+ Retrieve event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
61
+
62
+ ```sh
63
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
64
+ ```
65
+
66
+ Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
67
+
68
+ ```sh
69
+ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
70
+ ```
@@ -0,0 +1,51 @@
1
+ # spo field list
2
+
3
+ Retrieves columns for the specified list or site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo field list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site where fields are located
15
+
16
+ `-t, --listTitle [listTitle]`
17
+ : Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
18
+
19
+ `-i --listId [listId]`
20
+ : ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
30
+
31
+ ```sh
32
+ m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
33
+ ```
34
+
35
+ Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
36
+
37
+ ```sh
38
+ m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
39
+ ```
40
+
41
+ Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
42
+
43
+ ```sh
44
+ m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
45
+ ```
46
+
47
+ Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
48
+
49
+ ```sh
50
+ m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
51
+ ```