@pnp/cli-microsoft365 4.3.0 → 4.4.0-beta.3913c30

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 (30) hide show
  1. package/dist/Utils.js +4 -0
  2. package/dist/cli/Cli.js +7 -9
  3. package/dist/m365/aad/commands/group/group-list.js +41 -0
  4. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  5. package/dist/m365/aad/commands.js +2 -0
  6. package/dist/m365/cli/commands/config/config-set.js +4 -1
  7. package/dist/m365/pa/cds-project-mutator.js +1 -1
  8. package/dist/m365/planner/AppliedCategories.js +3 -0
  9. package/dist/m365/planner/commands/task/task-set.js +357 -0
  10. package/dist/m365/planner/commands.js +2 -1
  11. package/dist/m365/spo/commands/group/group-user-add.js +64 -13
  12. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  13. package/dist/m365/spo/commands.js +1 -0
  14. package/dist/m365/teams/commands/app/app-list.js +9 -6
  15. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  16. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  17. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  18. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  19. package/dist/m365/teams/commands.js +3 -0
  20. package/dist/settingsNames.js +6 -1
  21. package/docs/docs/cmd/aad/group/group-list.md +21 -0
  22. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  23. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  24. package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
  25. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  26. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  27. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  28. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  29. package/npm-shrinkwrap.json +268 -369
  30. package/package.json +20 -19
@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const cli_1 = require("../../../../cli");
4
4
  const Command_1 = require("../../../../Command");
5
5
  const request_1 = require("../../../../request");
6
- const SpoCommand_1 = require("../../../base/SpoCommand");
7
6
  const AadUserGetCommand = require("../../../aad/commands/user/user-get");
7
+ const SpoCommand_1 = require("../../../base/SpoCommand");
8
8
  const commands_1 = require("../../commands");
9
9
  class SpoGroupUserAddCommand extends SpoCommand_1.default {
10
10
  get name() {
@@ -17,15 +17,21 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
17
17
  return ['DisplayName', 'Email'];
18
18
  }
19
19
  commandAction(logger, args, cb) {
20
- this.getOnlyActiveUsers(args, logger)
20
+ let groupId = 0;
21
+ this
22
+ .getGroupId(args)
23
+ .then((_groupId) => {
24
+ groupId = _groupId;
25
+ return this.getOnlyActiveUsers(args, logger);
26
+ })
21
27
  .then((resolvedUsernameList) => {
22
28
  if (this.verbose) {
23
- logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId}...`);
29
+ logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
24
30
  }
25
31
  const data = {
26
32
  url: args.options.webUrl,
27
33
  peoplePickerInput: this.getFormattedUserList(resolvedUsernameList),
28
- roleValue: `group:${args.options.groupId}`
34
+ roleValue: `group:${groupId}`
29
35
  };
30
36
  const requestOptions = {
31
37
  url: `${args.options.webUrl}/_api/SP.Web.ShareObject`,
@@ -46,24 +52,51 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
46
52
  cb();
47
53
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
48
54
  }
55
+ getGroupId(args) {
56
+ if (args.options.groupId) {
57
+ return Promise.resolve(args.options.groupId);
58
+ }
59
+ const requestOptions = {
60
+ url: `${args.options.webUrl}/_api/web/sitegroups/GetByName('${encodeURIComponent(args.options.groupName)}')`,
61
+ headers: {
62
+ 'accept': 'application/json;odata=nometadata'
63
+ },
64
+ responseType: 'json'
65
+ };
66
+ return request_1.default
67
+ .get(requestOptions)
68
+ .then(response => {
69
+ const groupId = response.Id;
70
+ if (!groupId) {
71
+ return Promise.reject(`The specified group not exist in the SharePoint site`);
72
+ }
73
+ return Promise.resolve(groupId);
74
+ });
75
+ }
49
76
  getOnlyActiveUsers(args, logger) {
50
77
  if (this.verbose) {
51
78
  logger.logToStderr(`Removing Users which are not active from the original list`);
52
79
  }
53
- const activeUsernamelist = [];
54
- return Promise.all(args.options.userName.split(",").map(singleUsername => {
80
+ const activeUserNameList = [];
81
+ const userInfo = args.options.userName ? args.options.userName : args.options.email;
82
+ return Promise.all(userInfo.split(',').map(singleUserName => {
55
83
  const options = {
56
- userName: singleUsername.trim(),
57
84
  output: 'json',
58
85
  debug: args.options.debug,
59
86
  verbose: args.options.verbose
60
87
  };
88
+ if (args.options.userName) {
89
+ options.userName = singleUserName.trim();
90
+ }
91
+ else {
92
+ options.email = singleUserName.trim();
93
+ }
61
94
  return cli_1.Cli.executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
62
95
  .then((getUserGetOutput) => {
63
96
  if (this.debug) {
64
97
  logger.logToStderr(getUserGetOutput.stderr);
65
98
  }
66
- activeUsernamelist.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
99
+ activeUserNameList.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
67
100
  }, (err) => {
68
101
  if (this.debug) {
69
102
  logger.logToStderr(err.stderr);
@@ -71,7 +104,7 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
71
104
  });
72
105
  }))
73
106
  .then(() => {
74
- return Promise.resolve(activeUsernamelist);
107
+ return Promise.resolve(activeUserNameList);
75
108
  });
76
109
  }
77
110
  getFormattedUserList(activeUserList) {
@@ -86,10 +119,16 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
86
119
  option: '-u, --webUrl <webUrl>'
87
120
  },
88
121
  {
89
- option: '--groupId <groupId>'
122
+ option: '--groupId [groupId]'
123
+ },
124
+ {
125
+ option: '--groupName [groupName]'
126
+ },
127
+ {
128
+ option: '--userName [userName]'
90
129
  },
91
130
  {
92
- option: '--userName <userName>'
131
+ option: '--email [email]'
93
132
  }
94
133
  ];
95
134
  const parentOptions = super.options();
@@ -100,8 +139,20 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
100
139
  if (isValidSharePointUrl !== true) {
101
140
  return isValidSharePointUrl;
102
141
  }
103
- if (typeof args.options.groupId !== 'number') {
104
- return `Group Id : ${args.options.groupId} is not a number`;
142
+ if (!args.options.groupId && !args.options.groupName) {
143
+ return 'Specify either groupId or groupName';
144
+ }
145
+ if (args.options.groupId && args.options.groupName) {
146
+ return 'Specify either groupId or groupName but not both';
147
+ }
148
+ if (!args.options.userName && !args.options.email) {
149
+ return 'Specify either userName or email';
150
+ }
151
+ if (args.options.userName && args.options.email) {
152
+ return 'Specify either userName or email but not both';
153
+ }
154
+ if (args.options.groupId && isNaN(args.options.groupId)) {
155
+ return `Specified groupId ${args.options.groupId} is not a number`;
105
156
  }
106
157
  return true;
107
158
  }
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const SpoCommand_1 = require("../../../base/SpoCommand");
5
+ const commands_1 = require("../../commands");
6
+ class SpoSiteRecycleBinItemListCommand extends SpoCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SITE_RECYCLEBINITEM_LIST;
9
+ }
10
+ get description() {
11
+ return 'Lists items from recycle bin';
12
+ }
13
+ defaultProperties() {
14
+ return ['Id', 'Title', 'DirName'];
15
+ }
16
+ commandAction(logger, args, cb) {
17
+ if (this.verbose) {
18
+ logger.logToStderr(`Retrieving all items from recycle bin at ${args.options.siteUrl}...`);
19
+ }
20
+ const state = args.options.secondary ? '2' : '1';
21
+ let requestUrl = `${args.options.siteUrl}/_api/site/RecycleBin?$filter=(ItemState eq ${state})`;
22
+ if (typeof args.options.type !== 'undefined') {
23
+ const type = SpoSiteRecycleBinItemListCommand.recycleBinItemType.find(item => item.value === args.options.type);
24
+ if (typeof type !== 'undefined') {
25
+ requestUrl += ` and (ItemType eq ${type.id})`;
26
+ }
27
+ }
28
+ const requestOptions = {
29
+ url: requestUrl,
30
+ headers: {
31
+ 'accept': 'application/json;odata=nometadata'
32
+ },
33
+ responseType: 'json'
34
+ };
35
+ request_1.default
36
+ .get(requestOptions)
37
+ .then((response) => {
38
+ logger.log(response.value);
39
+ cb();
40
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
41
+ }
42
+ options() {
43
+ const options = [
44
+ {
45
+ option: '-u, --siteUrl <siteUrl>'
46
+ },
47
+ {
48
+ option: '-t, --type [type]',
49
+ autocomplete: SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value)
50
+ },
51
+ {
52
+ option: '-s, --secondary'
53
+ }
54
+ ];
55
+ const parentOptions = super.options();
56
+ return options.concat(parentOptions);
57
+ }
58
+ validate(args) {
59
+ const isValidSharePointUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.siteUrl);
60
+ if (isValidSharePointUrl !== true) {
61
+ return isValidSharePointUrl;
62
+ }
63
+ if (typeof args.options.type !== 'undefined' &&
64
+ !SpoSiteRecycleBinItemListCommand.recycleBinItemType.some(item => item.value === args.options.type)) {
65
+ return `${args.options.type} is not a valid value. Allowed values are ${SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value).join(', ')}`;
66
+ }
67
+ return true;
68
+ }
69
+ }
70
+ SpoSiteRecycleBinItemListCommand.recycleBinItemType = [
71
+ { id: 1, value: 'files' },
72
+ { id: 3, value: 'listItems' },
73
+ { id: 5, value: 'folders' }
74
+ ];
75
+ module.exports = new SpoSiteRecycleBinItemListCommand();
76
+ //# sourceMappingURL=site-recyclebinitem-list.js.map
@@ -183,6 +183,7 @@ exports.default = {
183
183
  SITE_GROUPIFY: `${prefix} site groupify`,
184
184
  SITE_LIST: `${prefix} site list`,
185
185
  SITE_INPLACERECORDSMANAGEMENT_SET: `${prefix} site inplacerecordsmanagement set`,
186
+ SITE_RECYCLEBINITEM_LIST: `${prefix} site recyclebinitem list`,
186
187
  SITE_REMOVE: `${prefix} site remove`,
187
188
  SITE_RENAME: `${prefix} site rename`,
188
189
  SITE_SET: `${prefix} site set`,
@@ -25,24 +25,27 @@ class TeamsAppListCommand extends GraphItemsListCommand_1.GraphItemsListCommand
25
25
  if (args.options.teamId) {
26
26
  return Promise.resolve(args.options.teamId);
27
27
  }
28
- const teamRequestOptions = {
29
- url: `${this.resource}/v1.0/me/joinedTeams?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
28
+ const requestOptions = {
29
+ url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
30
30
  headers: {
31
31
  accept: 'application/json;odata.metadata=none'
32
32
  },
33
33
  responseType: 'json'
34
34
  };
35
35
  return request_1.default
36
- .get(teamRequestOptions)
36
+ .get(requestOptions)
37
37
  .then(response => {
38
- const teamItem = response.value[0];
39
- if (!teamItem) {
38
+ const groupItem = response.value[0];
39
+ if (!groupItem) {
40
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
41
+ }
42
+ if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
40
43
  return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
41
44
  }
42
45
  if (response.value.length > 1) {
43
46
  return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
44
47
  }
45
- return Promise.resolve(teamItem.id);
48
+ return Promise.resolve(groupItem.id);
46
49
  });
47
50
  }
48
51
  getEndpointUrl(args) {
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
4
+ const commands_1 = require("../../commands");
5
+ class TeamsChatListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.CHAT_LIST;
8
+ }
9
+ get description() {
10
+ return 'Lists all chat conversations';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'topic', 'chatType'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ const filter = args.options.type !== undefined ? `?$filter=chatType eq '${args.options.type}'` : '';
17
+ const endpoint = `${this.resource}/v1.0/chats${filter}`;
18
+ this
19
+ .getAllItems(endpoint, logger, true)
20
+ .then(() => {
21
+ logger.log(this.items);
22
+ cb();
23
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
24
+ }
25
+ options() {
26
+ const options = [
27
+ {
28
+ option: '-t, --type [chatType]'
29
+ }
30
+ ];
31
+ const parentOptions = super.options();
32
+ return options.concat(parentOptions);
33
+ }
34
+ validate(args) {
35
+ const supportedTypes = ['oneOnOne', 'group', 'meeting'];
36
+ if (args.options.type !== undefined && supportedTypes.indexOf(args.options.type) === -1) {
37
+ return `${args.options.type} is not a valid chatType. Accepted values are ${supportedTypes.join(', ')}`;
38
+ }
39
+ return true;
40
+ }
41
+ }
42
+ module.exports = new TeamsChatListCommand();
43
+ //# sourceMappingURL=chat-list.js.map
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const Utils_1 = require("../../../../Utils");
4
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TeamsChatMemberListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
7
+ get name() {
8
+ return commands_1.default.CHAT_MEMBER_LIST;
9
+ }
10
+ get description() {
11
+ return 'Lists all members from a chat';
12
+ }
13
+ defaultProperties() {
14
+ return ['userId', 'displayName', 'email'];
15
+ }
16
+ commandAction(logger, args, cb) {
17
+ const endpoint = `${this.resource}/v1.0/chats/${args.options.chatId}/members`;
18
+ this
19
+ .getAllItems(endpoint, logger, true)
20
+ .then(() => {
21
+ logger.log(this.items);
22
+ cb();
23
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
24
+ }
25
+ options() {
26
+ const options = [
27
+ {
28
+ option: '-i, --chatId <chatId>'
29
+ }
30
+ ];
31
+ const parentOptions = super.options();
32
+ return options.concat(parentOptions);
33
+ }
34
+ validate(args) {
35
+ if (!Utils_1.default.isValidTeamsChatId(args.options.chatId)) {
36
+ return `${args.options.chatId} is not a valid Teams ChatId`;
37
+ }
38
+ return true;
39
+ }
40
+ }
41
+ module.exports = new TeamsChatMemberListCommand();
42
+ //# sourceMappingURL=chat-member-list.js.map
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const Utils_1 = require("../../../../Utils");
4
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TeamsChatMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
7
+ get name() {
8
+ return commands_1.default.CHAT_MESSAGE_LIST;
9
+ }
10
+ get description() {
11
+ return 'Lists all messages from a chat';
12
+ }
13
+ defaultProperties() {
14
+ return ['id', 'shortBody'];
15
+ }
16
+ commandAction(logger, args, cb) {
17
+ const endpoint = `${this.resource}/v1.0/chats/${args.options.chatId}/messages`;
18
+ this
19
+ .getAllItems(endpoint, logger, true)
20
+ .then(() => {
21
+ if (args.options.output !== 'json') {
22
+ this.items.forEach(i => {
23
+ // hoist the content to body for readability
24
+ i.body = i.body.content;
25
+ let shortBody;
26
+ const bodyToProcess = i.body;
27
+ if (bodyToProcess) {
28
+ let maxLength = 50;
29
+ let addedDots = '...';
30
+ if (bodyToProcess.length < maxLength) {
31
+ maxLength = bodyToProcess.length;
32
+ addedDots = '';
33
+ }
34
+ shortBody = bodyToProcess.replace(/\n/g, ' ').substring(0, maxLength) + addedDots;
35
+ }
36
+ i.shortBody = shortBody;
37
+ });
38
+ }
39
+ logger.log(this.items);
40
+ cb();
41
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
42
+ }
43
+ options() {
44
+ const options = [
45
+ {
46
+ option: '-i, --chatId <chatId>'
47
+ }
48
+ ];
49
+ const parentOptions = super.options();
50
+ return options.concat(parentOptions);
51
+ }
52
+ validate(args) {
53
+ if (!Utils_1.default.isValidTeamsChatId(args.options.chatId)) {
54
+ return `${args.options.chatId} is not a valid Teams chat ID`;
55
+ }
56
+ return true;
57
+ }
58
+ }
59
+ module.exports = new TeamsChatMessageListCommand();
60
+ //# sourceMappingURL=chat-message-list.js.map
@@ -30,24 +30,27 @@ class TeamsTabGetCommand extends GraphCommand_1.default {
30
30
  if (args.options.teamId) {
31
31
  return Promise.resolve(args.options.teamId);
32
32
  }
33
- const teamRequestOptions = {
34
- url: `${this.resource}/v1.0/me/joinedTeams?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
33
+ const requestOptions = {
34
+ url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
35
35
  headers: {
36
36
  accept: 'application/json;odata.metadata=none'
37
37
  },
38
38
  responseType: 'json'
39
39
  };
40
40
  return request_1.default
41
- .get(teamRequestOptions)
41
+ .get(requestOptions)
42
42
  .then(response => {
43
- const teamItem = response.value[0];
44
- if (!teamItem) {
43
+ const groupItem = response.value[0];
44
+ if (!groupItem) {
45
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
46
+ }
47
+ if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
45
48
  return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
46
49
  }
47
50
  if (response.value.length > 1) {
48
51
  return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
49
52
  }
50
- return Promise.resolve(teamItem.id);
53
+ return Promise.resolve(groupItem.id);
51
54
  });
52
55
  }
53
56
  getChannelId(args) {
@@ -13,6 +13,9 @@ exports.default = {
13
13
  CHANNEL_LIST: `${prefix} channel list`,
14
14
  CHANNEL_REMOVE: `${prefix} channel remove`,
15
15
  CHANNEL_SET: `${prefix} channel set`,
16
+ CHAT_LIST: `${prefix} chat list`,
17
+ CHAT_MEMBER_LIST: `${prefix} chat member list`,
18
+ CHAT_MESSAGE_LIST: `${prefix} chat message list`,
16
19
  CONVERSATIONMEMBER_ADD: `${prefix} conversationmember add`,
17
20
  CONVERSATIONMEMBER_LIST: `${prefix} conversationmember list`,
18
21
  FUNSETTINGS_LIST: `${prefix} funsettings list`,
@@ -5,7 +5,12 @@ const settingsNames = {
5
5
  errorOutput: 'errorOutput',
6
6
  output: 'output',
7
7
  printErrorsAsPlainText: 'printErrorsAsPlainText',
8
- showHelpOnFailure: 'showHelpOnFailure'
8
+ showHelpOnFailure: 'showHelpOnFailure',
9
+ csvHeader: 'csvHeader',
10
+ csvEscape: 'csvEscape',
11
+ csvQuote: 'csvQuote',
12
+ csvQuoted: 'csvQuoted',
13
+ csvQuotedEmpty: 'csvQuotedEmpty'
9
14
  };
10
15
  exports.settingsNames = settingsNames;
11
16
  //# sourceMappingURL=settingsNames.js.map
@@ -0,0 +1,21 @@
1
+ # aad group list
2
+
3
+ Lists Azure AD groups
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad group list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Lists all groups defined in Azure Active Directory.
18
+
19
+ ```sh
20
+ m365 aad group list
21
+ ```
@@ -0,0 +1,46 @@
1
+ # aad user hibp
2
+
3
+ Allows you to retrieve all accounts that have been pwned with the specified username
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user hibp [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --userName <userName>`
14
+ : The name of the user to retrieve information for.
15
+
16
+ `--apiKey, <apiKey>`
17
+ : Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
18
+
19
+ `--domain, [domain]`
20
+ : Limit the returned breaches only contain results with the domain specified.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
27
+
28
+ If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
29
+
30
+ ## Examples
31
+
32
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
33
+
34
+ ```sh
35
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
36
+ ```
37
+
38
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
39
+
40
+ ```sh
41
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
42
+ ```
43
+
44
+ ## More information
45
+
46
+ - Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)
@@ -0,0 +1,99 @@
1
+ # planner task set
2
+
3
+ Updates a Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task.
15
+
16
+ `-t, --title [title]`
17
+ : New title of the task.
18
+
19
+ `--bucketId [bucketId]`
20
+ : ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
21
+
22
+ `--bucketName [bucketName]`
23
+ : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
24
+
25
+ `--planId [planId]`
26
+ : ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
27
+
28
+ `--planName [planName]`
29
+ : Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
30
+
31
+ `--ownerGroupId [ownerGroupId]`
32
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
33
+
34
+ `--ownerGroupName [ownerGroupName]`
35
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
36
+
37
+ `--startDateTime [startDateTime]`
38
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
39
+
40
+ `--dueDateTime [dueDateTime]`
41
+ : The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
42
+
43
+ `--percentComplete [percentComplete]`
44
+ : Percentage of task completion. Number between 0 and 100.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
+
52
+ `--description [description]`
53
+ : Description of the task
54
+
55
+ `--orderHint [orderHint]`
56
+ : Hint used to order items of this type in a list view
57
+
58
+ `--assigneePriority [assigneePriority]`
59
+ : Hint used to order items of this type in a list view
60
+
61
+ `--appliedCategories [appliedCategories]`
62
+ : Comma-separated categories that should be added to the task
63
+
64
+ --8<-- "docs/cmd/_global.md"
65
+
66
+ ## Remarks
67
+
68
+ When you specify the value for `percentageComplete`, consider the following:
69
+
70
+ - when set to 0, the task is considered _Not started_
71
+ - when set between 1 and 99, the task is considered _In progress_
72
+ - when set to 100, the task is considered _Completed_
73
+
74
+ You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
75
+
76
+ ## Examples
77
+
78
+ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
79
+
80
+ ```sh
81
+ m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
82
+ ```
83
+
84
+ Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
85
+
86
+ ```sh
87
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
88
+ ```
89
+
90
+ Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
91
+
92
+ ```sh
93
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
94
+ ```
95
+
96
+ ## Additional information
97
+
98
+ - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
99
+ - Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)