@pnp/cli-microsoft365 5.9.0-beta.0d30334 → 5.9.0-beta.1713b46

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 (27) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/m365/aad/commands/app/app-add.js +37 -13
  3. package/dist/m365/outlook/commands/mail/mail-send.js +1 -1
  4. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  5. package/dist/m365/pp/commands/Environment.js +3 -0
  6. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  7. package/dist/m365/pp/commands.js +1 -0
  8. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  9. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  10. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  11. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -9
  12. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  13. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  14. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  15. package/dist/m365/todo/commands/task/task-set.js +53 -1
  16. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  17. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  18. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  19. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  20. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  21. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  22. package/docs/docs/cmd/spo/list/list-webhook-get.md +15 -6
  23. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  24. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  25. package/docs/docs/cmd/spo/list/list-webhook-set.md +13 -11
  26. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  27. package/package.json +4 -1
@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
18
18
  const Cli_1 = require("../../../../cli/Cli");
19
19
  const request_1 = require("../../../../request");
20
20
  const formatting_1 = require("../../../../utils/formatting");
21
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
22
  const validation_1 = require("../../../../utils/validation");
22
23
  const SpoCommand_1 = require("../../../base/SpoCommand");
23
24
  const commands_1 = require("../../commands");
@@ -40,15 +41,19 @@ class SpoListWebhookRemoveCommand extends SpoCommand_1.default {
40
41
  return __awaiter(this, void 0, void 0, function* () {
41
42
  const removeWebhook = () => __awaiter(this, void 0, void 0, function* () {
42
43
  if (this.verbose) {
43
- const list = (args.options.listId ? args.options.listId : args.options.listTitle);
44
+ const list = (args.options.listId || args.options.listId || args.options.listUrl);
44
45
  logger.logToStderr(`Webhook ${args.options.id} is about to be removed from list ${list} located at site ${args.options.webUrl}...`);
45
46
  }
46
- let requestUrl = '';
47
+ let requestUrl = `${args.options.webUrl}/_api/web`;
47
48
  if (args.options.listId) {
48
- requestUrl = `${args.options.webUrl}/_api/web/lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
49
+ requestUrl += `/lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
49
50
  }
50
- else {
51
- requestUrl = `${args.options.webUrl}/_api/web/lists/GetByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
51
+ else if (args.options.listTitle) {
52
+ requestUrl += `/lists/GetByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
53
+ }
54
+ else if (args.options.listUrl) {
55
+ const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
56
+ requestUrl += `/GetList('${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
52
57
  }
53
58
  const requestOptions = {
54
59
  url: requestUrl,
@@ -74,7 +79,7 @@ class SpoListWebhookRemoveCommand extends SpoCommand_1.default {
74
79
  type: 'confirm',
75
80
  name: 'continue',
76
81
  default: false,
77
- message: `Are you sure you want to remove webhook ${args.options.id} from list ${args.options.listTitle || args.options.listId} located at site ${args.options.webUrl}?`
82
+ message: `Are you sure you want to remove webhook ${args.options.id} from list ${args.options.listTitle || args.options.listId || args.options.listUrl} located at site ${args.options.webUrl}?`
78
83
  });
79
84
  if (result.continue) {
80
85
  yield removeWebhook();
@@ -86,10 +91,11 @@ class SpoListWebhookRemoveCommand extends SpoCommand_1.default {
86
91
  _SpoListWebhookRemoveCommand_instances = new WeakSet(), _SpoListWebhookRemoveCommand_initTelemetry = function _SpoListWebhookRemoveCommand_initTelemetry() {
87
92
  this.telemetry.push((args) => {
88
93
  Object.assign(this.telemetryProperties, {
89
- listId: (!(!args.options.listId)).toString(),
90
- listTitle: (!(!args.options.listTitle)).toString(),
91
- id: (!(!args.options.id)).toString(),
92
- confirm: (!(!args.options.confirm)).toString()
94
+ listId: typeof args.options.listId !== 'undefined',
95
+ listTitle: typeof args.options.listTitle !== 'undefined',
96
+ listUrl: typeof args.options.listUrl !== 'undefined',
97
+ id: typeof args.options.id !== 'undefined',
98
+ confirm: !!args.options.confirm
93
99
  });
94
100
  });
95
101
  }, _SpoListWebhookRemoveCommand_initOptions = function _SpoListWebhookRemoveCommand_initOptions() {
@@ -99,6 +105,8 @@ _SpoListWebhookRemoveCommand_instances = new WeakSet(), _SpoListWebhookRemoveCom
99
105
  option: '-l, --listId [listId]'
100
106
  }, {
101
107
  option: '-t, --listTitle [listTitle]'
108
+ }, {
109
+ option: '--listUrl [listUrl]'
102
110
  }, {
103
111
  option: '-i, --id <id>'
104
112
  }, {
@@ -121,7 +129,7 @@ _SpoListWebhookRemoveCommand_instances = new WeakSet(), _SpoListWebhookRemoveCom
121
129
  return true;
122
130
  }));
123
131
  }, _SpoListWebhookRemoveCommand_initOptionSets = function _SpoListWebhookRemoveCommand_initOptionSets() {
124
- this.optionSets.push(['listId', 'listTitle']);
132
+ this.optionSets.push(['listId', 'listTitle', 'listUrl']);
125
133
  };
126
134
  module.exports = new SpoListWebhookRemoveCommand();
127
135
  //# sourceMappingURL=list-webhook-remove.js.map
@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
18
18
  const chalk = require("chalk");
19
19
  const request_1 = require("../../../../request");
20
20
  const formatting_1 = require("../../../../utils/formatting");
21
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
22
  const validation_1 = require("../../../../utils/validation");
22
23
  const SpoCommand_1 = require("../../../base/SpoCommand");
23
24
  const commands_1 = require("../../commands");
@@ -39,14 +40,18 @@ class SpoListWebhookSetCommand extends SpoCommand_1.default {
39
40
  commandAction(logger, args) {
40
41
  return __awaiter(this, void 0, void 0, function* () {
41
42
  if (this.verbose) {
42
- logger.logToStderr(`Updating webhook ${args.options.id} belonging to list ${args.options.listId ? args.options.listId : args.options.listTitle} located at site ${args.options.webUrl}...`);
43
+ logger.logToStderr(`Updating webhook ${args.options.id} belonging to list ${args.options.listId || args.options.listTitle || args.options.listUrl} located at site ${args.options.webUrl}...`);
43
44
  }
44
- let requestUrl = '';
45
+ let requestUrl = `${args.options.webUrl}/_api/web`;
45
46
  if (args.options.listId) {
46
- requestUrl = `${args.options.webUrl}/_api/web/lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
47
+ requestUrl += `/lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
47
48
  }
48
- else {
49
- requestUrl = `${args.options.webUrl}/_api/web/lists/GetByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
49
+ else if (args.options.listTitle) {
50
+ requestUrl += `/lists/GetByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
51
+ }
52
+ else if (args.options.listUrl) {
53
+ const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
54
+ requestUrl += `/GetList('${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}')/Subscriptions('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')`;
50
55
  }
51
56
  const requestBody = {};
52
57
  if (args.options.notificationUrl) {
@@ -77,10 +82,11 @@ class SpoListWebhookSetCommand extends SpoCommand_1.default {
77
82
  _SpoListWebhookSetCommand_instances = new WeakSet(), _SpoListWebhookSetCommand_initTelemetry = function _SpoListWebhookSetCommand_initTelemetry() {
78
83
  this.telemetry.push((args) => {
79
84
  Object.assign(this.telemetryProperties, {
80
- listId: (!(!args.options.listId)).toString(),
81
- listTitle: (!(!args.options.listTitle)).toString(),
82
- notificationUrl: (!(!args.options.notificationUrl)).toString(),
83
- expirationDateTime: (!(!args.options.expirationDateTime)).toString()
85
+ listId: typeof args.options.listId !== 'undefined',
86
+ listTitle: typeof args.options.listTitle !== 'undefined',
87
+ listUrl: typeof args.options.listUrl !== 'undefined',
88
+ notificationUrl: typeof args.options.notificationUrl !== 'undefined',
89
+ expirationDateTime: typeof args.options.expirationDateTime !== 'undefined'
84
90
  });
85
91
  });
86
92
  }, _SpoListWebhookSetCommand_initOptions = function _SpoListWebhookSetCommand_initOptions() {
@@ -90,6 +96,8 @@ _SpoListWebhookSetCommand_instances = new WeakSet(), _SpoListWebhookSetCommand_i
90
96
  option: '-l, --listId [listId]'
91
97
  }, {
92
98
  option: '-t, --listTitle [listTitle]'
99
+ }, {
100
+ option: '--listUrl [listUrl]'
93
101
  }, {
94
102
  option: '-i, --id <id>'
95
103
  }, {
@@ -125,7 +133,7 @@ _SpoListWebhookSetCommand_instances = new WeakSet(), _SpoListWebhookSetCommand_i
125
133
  return true;
126
134
  }));
127
135
  }, _SpoListWebhookSetCommand_initOptionSets = function _SpoListWebhookSetCommand_initOptionSets() {
128
- this.optionSets.push(['listId', 'listTitle']);
136
+ this.optionSets.push(['listId', 'listTitle', 'listUrl']);
129
137
  };
130
138
  module.exports = new SpoListWebhookSetCommand();
131
139
  //# sourceMappingURL=list-webhook-set.js.map
@@ -16,6 +16,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
16
16
  var _TodoTaskSetCommand_instances, _TodoTaskSetCommand_initTelemetry, _TodoTaskSetCommand_initOptions, _TodoTaskSetCommand_initValidators, _TodoTaskSetCommand_initOptionSets;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  const request_1 = require("../../../../request");
19
+ const validation_1 = require("../../../../utils/validation");
19
20
  const GraphCommand_1 = require("../../../base/GraphCommand");
20
21
  const commands_1 = require("../../commands");
21
22
  class TodoTaskSetCommand extends GraphCommand_1.default {
@@ -76,7 +77,14 @@ class TodoTaskSetCommand extends GraphCommand_1.default {
76
77
  return Promise.resolve(taskList.id);
77
78
  });
78
79
  }
80
+ getDateTimeTimeZone(dateTime) {
81
+ return {
82
+ dateTime: dateTime,
83
+ timeZone: 'Etc/GMT'
84
+ };
85
+ }
79
86
  mapRequestBody(options) {
87
+ var _a;
80
88
  const requestBody = {};
81
89
  if (options.status) {
82
90
  requestBody.status = options.status;
@@ -84,6 +92,21 @@ class TodoTaskSetCommand extends GraphCommand_1.default {
84
92
  if (options.title) {
85
93
  requestBody.title = options.title;
86
94
  }
95
+ if (options.importance) {
96
+ requestBody.importance = options.importance.toLowerCase();
97
+ }
98
+ if (options.bodyContentType || options.bodyContent) {
99
+ requestBody.body = {
100
+ content: options.bodyContent,
101
+ contentType: ((_a = options.bodyContentType) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || 'text'
102
+ };
103
+ }
104
+ if (options.dueDateTime) {
105
+ requestBody.dueDateTime = this.getDateTimeTimeZone(options.dueDateTime);
106
+ }
107
+ if (options.reminderDateTime) {
108
+ requestBody.reminderDateTime = this.getDateTimeTimeZone(options.reminderDateTime);
109
+ }
87
110
  return requestBody;
88
111
  }
89
112
  }
@@ -93,7 +116,12 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
93
116
  listId: typeof args.options.listId !== 'undefined',
94
117
  listName: typeof args.options.listName !== 'undefined',
95
118
  status: typeof args.options.status !== 'undefined',
96
- title: typeof args.options.title !== 'undefined'
119
+ title: typeof args.options.title !== 'undefined',
120
+ bodyContent: typeof args.options.bodyContent !== 'undefined',
121
+ bodyContentType: args.options.bodyContentType,
122
+ dueDateTime: typeof args.options.dueDateTime !== 'undefined',
123
+ importance: args.options.importance,
124
+ reminderDateTime: typeof args.options.reminderDateTime !== 'undefined'
97
125
  });
98
126
  });
99
127
  }, _TodoTaskSetCommand_initOptions = function _TodoTaskSetCommand_initOptions() {
@@ -108,6 +136,18 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
108
136
  option: '--listName [listName]'
109
137
  }, {
110
138
  option: '--listId [listId]'
139
+ }, {
140
+ option: '--bodyContent [bodyContent]'
141
+ }, {
142
+ option: '--bodyContentType [bodyContentType]',
143
+ autocomplete: ['text', 'html']
144
+ }, {
145
+ option: '--dueDateTime [dueDateTime]'
146
+ }, {
147
+ option: '--importance [importance]',
148
+ autocomplete: ['low', 'normal', 'high']
149
+ }, {
150
+ option: '--reminderDateTime [reminderDateTime]'
111
151
  });
112
152
  }, _TodoTaskSetCommand_initValidators = function _TodoTaskSetCommand_initValidators() {
113
153
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
@@ -119,6 +159,18 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
119
159
  args.options.status !== 'deferred') {
120
160
  return `${args.options.status} is not a valid value. Allowed values are notStarted|inProgress|completed|waitingOnOthers|deferred`;
121
161
  }
162
+ if (args.options.bodyContentType && ['text', 'html'].indexOf(args.options.bodyContentType.toLowerCase()) === -1) {
163
+ return `'${args.options.bodyContentType}' is not a valid value for the bodyContentType option. Allowed values are text|html`;
164
+ }
165
+ if (args.options.importance && ['low', 'normal', 'high'].indexOf(args.options.importance.toLowerCase()) === -1) {
166
+ return `'${args.options.importance}' is not a valid value for the importance option. Allowed values are low|normal|high`;
167
+ }
168
+ if (args.options.dueDateTime && !validation_1.validation.isValidISODateTime(args.options.dueDateTime)) {
169
+ return `'${args.options.dueDateTime}' is not a valid ISO date string`;
170
+ }
171
+ if (args.options.reminderDateTime && !validation_1.validation.isValidISODateTime(args.options.reminderDateTime)) {
172
+ return `'${args.options.reminderDateTime}' is not a valid ISO date string`;
173
+ }
122
174
  return true;
123
175
  }));
124
176
  }, _TodoTaskSetCommand_initOptionSets = function _TodoTaskSetCommand_initOptionSets() {
@@ -0,0 +1,38 @@
1
+ # pp environment get
2
+
3
+ Gets information about the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp environment get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --name <name>`
14
+ : The name of the environment to get information about
15
+
16
+ `-a, --asAdmin`
17
+ : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
18
+
19
+ ## Remarks
20
+
21
+ !!! attention
22
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
23
+ Register CLI for Microsoft 365 or Azure AD application as a management application for the Power Platform using
24
+ m365 pp managementapp add [options]
25
+
26
+ ## Examples
27
+
28
+ Get information about the Power Platform environment by name
29
+
30
+ ```sh
31
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
32
+ ```
33
+
34
+ Get information as admin about the Power Platform environment by name
35
+
36
+ ```sh
37
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
38
+ ```
@@ -26,10 +26,10 @@ Specify either `listTitle`, `listId` or `listUrl`.
26
26
  Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-n, --name [name]`
29
- The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
29
+ : The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-i, --id [id]`
32
- The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
32
+ : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
33
 
34
34
  `-s, --scope [scope]`
35
35
  : The scope of which to retrieve the Event Receivers.
@@ -23,10 +23,10 @@ m365 spo eventreceiver remove [options]
23
23
  : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `-n, --name [name]`
26
- The name. Specify either `name` or `id` but not both.
26
+ : The name. Specify either `name` or `id` but not both.
27
27
 
28
28
  `-i, --id [id]`
29
- The id. Specify either `name` or `id` but not both.
29
+ : The id. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-s, --scope [scope]`
32
32
  : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
@@ -11,13 +11,16 @@ m365 spo list roleinheritance break [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve information for. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve information for. Specify either id or title but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `-c, --clearExistingPermissions`
23
26
  : Flag if used clears all roles from the list
@@ -30,26 +33,26 @@ By default, when breaking permissions inheritance, the list will retain existing
30
33
 
31
34
  ## Examples
32
35
 
33
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Break inheritance of list by title in a specific site
34
37
 
35
38
  ```sh
36
39
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
37
40
  ```
38
41
 
39
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Break inheritance of list by id in a specific site
40
43
 
41
44
  ```sh
42
45
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
43
46
  ```
44
47
 
45
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
48
+ Break inheritance of list by title located in a specific site and clearing the existing permissions
46
49
 
47
50
  ```sh
48
51
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
49
52
  ```
50
53
 
51
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
54
+ Break inheritance of list by url in a specific site and clearing the existing permissions
52
55
 
53
56
  ```sh
54
- m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
57
+ m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl '/sites/project-x/lists/events' --clearExistingPermissions
55
58
  ```
@@ -11,26 +11,35 @@ m365 spo list roleinheritance reset [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either id or title but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
29
+ Restores role inheritance of a specific list by id in a specific site
27
30
 
28
31
  ```sh
29
32
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
30
33
  ```
31
34
 
32
- Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ Restores role inheritance of a specific list by title in a specific site
33
36
 
34
37
  ```sh
35
38
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
36
39
  ```
40
+
41
+ Restores role inheritance of a specific list by url in a specific site
42
+
43
+ ```sh
44
+ m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/events'
45
+ ```
@@ -11,46 +11,45 @@ m365 spo list webhook add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to add the webhook to is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list to which the webhook which should be added. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to which the webhook which should be added. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `-n, --notificationUrl <notificationUrl>`
23
- : The notification url
26
+ : The notification URL.
24
27
 
25
28
  `-e, --expirationDateTime [expirationDateTime]`
26
- : The expiration date. Will be set to max (6 months from today) if not provided
29
+ : The expiration date. Will be set to max (6 months from today) if not provided.
27
30
 
28
31
  `-c, --clientState [clientState]`
29
- : A client state information that will be passed through notifications
32
+ : A client state information that will be passed through notifications.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
33
36
  ## Examples
34
37
 
35
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
36
- _https://contoso-funcions.azurewebsites.net/webhook_ and the default expiration
37
- date
38
+ Add a web hook to the list retrieved by Title located in a specific site with a specific notification url and the default expiration date
38
39
 
39
40
  ```sh
40
41
  m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook
41
42
  ```
42
43
 
43
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
44
- _https://contoso-funcions.azurewebsites.net/webhook_ and an expiration date of _January 21st, 2019_
44
+ Add a web hook to the list retrieved by URL located in a specific site with a specific notification url and a specific expiration date
45
45
 
46
46
  ```sh
47
- m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime 2019-01-21
47
+ m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime 2019-01-21
48
48
  ```
49
49
 
50
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
51
- _https://contoso-funcions.azurewebsites.net/webhook_, a very specific expiration date of _6:15 PM on March 2nd, 2019_ and
52
- a client state
50
+ Add a web hook to the list retrieved by ID located in a specific site with a specific notification url, a specific expiration date and a client state
51
+
53
52
 
54
53
  ```sh
55
- m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime '2019-03-02T18:15' --clientState "Hello State!"
54
+ m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listId '3d6aefa0-f438-4789-b0cd-6e865f5d65b5' --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime '2019-03-02T18:15' --clientState "Hello State!"
56
55
  ```
@@ -11,16 +11,19 @@ m365 spo list webhook get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve the webhook info for is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list from which to retrieve the webhook. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list from which to retrieve the webhook. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `-i, --id [id]`
23
- : ID of the webhook to retrieve
26
+ : ID of the webhook.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -30,14 +33,20 @@ If the specified `id` doesn't refer to an existing webhook, you will get a `404
30
33
 
31
34
  ## Examples
32
35
 
33
- Return information about a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e85_ which belongs to a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Return information about a specific webhook which belongs to a list retrieved by ID in a specific site
34
37
 
35
38
  ```sh
36
39
  m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e85
37
40
  ```
38
41
 
39
- Return information about a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e85_ which belongs to a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Return information about a specific webhook which belongs to a list retrieved by Title in a specific site
40
43
 
41
44
  ```sh
42
45
  m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e85
43
46
  ```
47
+
48
+ Return information about a specific webhook which belongs to a list retrieved by URL in a specific site
49
+
50
+ ```sh
51
+ m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e85
52
+ ```
@@ -11,32 +11,41 @@ m365 spo list webhook list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve webhooks for is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve all webhooks for. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve all webhooks for. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
- : (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id` or `title` but not both
26
+ : (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
24
27
 
25
28
  `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id` or `title` but not both
29
+ : (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
30
33
  ## Examples
31
34
 
32
- List all webhooks for a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ List all webhooks for a list with a specific ID in a specific site
33
36
 
34
37
  ```sh
35
38
  m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
36
39
  ```
37
40
 
38
- List all webhooks for a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
41
+ List all webhooks for a list with a specific title in a specific site
39
42
 
40
43
  ```sh
41
44
  m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
42
45
  ```
46
+
47
+ List all webhooks for a list with a specific URL in a specific site
48
+
49
+ ```sh
50
+ m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Documents'
51
+ ```
@@ -11,19 +11,22 @@ m365 spo list webhook remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to remove the webhook from is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list from which the webhook should be removed. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listId`, `listTitle` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list from which the webhook should be removed. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `listId`, `listTitle` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl`.
21
24
 
22
25
  `-i, --id <id>`
23
- : ID of the webhook to remove
26
+ : ID of the webhook.
24
27
 
25
28
  `--confirm`
26
- : Don't prompt for confirming removing the webhook
29
+ : Don't prompt for confirmation.
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
@@ -33,20 +36,19 @@ If the specified id doesn't refer to an existing webhook, you will get a `404 -
33
36
 
34
37
  ## Examples
35
38
 
36
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/ninja_
39
+ Remove webhook with a specific ID from a list retrieved by ID in a specific site
37
40
 
38
41
  ```sh
39
42
  m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81
40
43
  ```
41
44
 
42
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_
43
-
45
+ Remove webhook with a specific ID from a list retrieved by Title in a specific site
44
46
  ```sh
45
47
  m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81
46
48
  ```
47
49
 
48
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_ without being asked for confirmation
50
+ Remove webhook with a specific ID from a list retrieved by URL in a specific site without being asked for confirmation
49
51
 
50
52
  ```sh
51
- m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --confirm
53
+ m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --confirm
52
54
  ```