@pnp/cli-microsoft365 5.0.0-beta.117f66f → 5.0.0-beta.156f91b

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 (77) hide show
  1. package/.devcontainer/devcontainer.json +9 -1
  2. package/.eslintrc.js +1 -0
  3. package/dist/Command.js +1 -1
  4. package/dist/Utils.js +7 -0
  5. package/dist/api.d.ts +11 -0
  6. package/dist/api.js +17 -0
  7. package/dist/cli/Cli.js +26 -13
  8. package/dist/m365/aad/commands/app/app-add.js +43 -7
  9. package/dist/m365/aad/commands/app/app-delete.js +126 -0
  10. package/dist/m365/aad/commands/group/group-list.js +49 -0
  11. package/dist/m365/aad/commands/o365group/{Group.js → GroupExtended.js} +1 -1
  12. package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
  13. package/dist/m365/aad/commands/user/user-get.js +33 -6
  14. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  15. package/dist/m365/aad/commands/user/user-list.js +7 -4
  16. package/dist/m365/aad/commands.js +3 -0
  17. package/dist/m365/cli/commands/config/config-set.js +4 -1
  18. package/dist/m365/flow/commands/flow-get.js +2 -2
  19. package/dist/m365/pa/cds-project-mutator.js +1 -1
  20. package/dist/m365/{aad/commands/o365group/GroupUser.js → planner/AppliedCategories.js} +1 -1
  21. package/dist/m365/planner/commands/task/task-add.js +288 -0
  22. package/dist/m365/planner/commands/task/task-details-get.js +39 -0
  23. package/dist/m365/planner/commands/task/task-get.js +50 -0
  24. package/dist/m365/planner/commands/task/task-list.js +37 -7
  25. package/dist/m365/planner/commands/task/task-set.js +357 -0
  26. package/dist/m365/planner/commands.js +5 -1
  27. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
  28. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.14.0-beta.4.js → upgrade-1.14.0-rc.2.js} +27 -25
  29. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  30. package/dist/m365/spo/commands/group/group-user-add.js +64 -13
  31. package/dist/m365/spo/commands/group/group-user-remove.js +100 -0
  32. package/dist/m365/spo/commands/site/site-ensure.js +1 -1
  33. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  34. package/dist/m365/spo/commands.js +2 -0
  35. package/dist/m365/teams/commands/app/app-list.js +9 -6
  36. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  37. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  38. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  39. package/dist/m365/teams/commands/message/message-get.js +1 -1
  40. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  41. package/dist/m365/teams/commands.js +3 -0
  42. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
  43. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
  44. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +39 -0
  45. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +38 -0
  46. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js +51 -0
  47. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +38 -0
  48. package/dist/m365/tenant/commands.js +6 -0
  49. package/dist/settingsNames.js +6 -1
  50. package/docs/docs/cmd/aad/app/app-delete.md +51 -0
  51. package/docs/docs/cmd/aad/group/group-list.md +30 -0
  52. package/docs/docs/cmd/aad/user/user-get.md +13 -4
  53. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  54. package/docs/docs/cmd/aad/user/user-list.md +9 -0
  55. package/docs/docs/cmd/planner/task/task-add.md +78 -0
  56. package/docs/docs/cmd/planner/task/task-details-get.md +24 -0
  57. package/docs/docs/cmd/planner/task/task-get.md +29 -0
  58. package/docs/docs/cmd/planner/task/task-list.md +5 -0
  59. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  60. package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +3 -3
  61. package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
  62. package/docs/docs/cmd/spo/group/group-user-remove.md +39 -0
  63. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  64. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  65. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  66. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  67. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  68. package/docs/docs/cmd/teams/message/message-get.md +0 -3
  69. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
  70. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
  71. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +24 -0
  72. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +34 -0
  73. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +28 -0
  74. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +34 -0
  75. package/npm-shrinkwrap.json +938 -1001
  76. package/package.json +31 -27
  77. package/dist/m365/base/AadCommand.js +0 -10
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const GraphCommand_1 = require("../../../base/GraphCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementMessageGetCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_GET;
9
+ }
10
+ get description() {
11
+ return 'Retrieves a specified service update message for the tenant';
12
+ }
13
+ commandAction(logger, args, cb) {
14
+ if (this.verbose) {
15
+ logger.logToStderr(`Retrieving service update message ${args.options.id}`);
16
+ }
17
+ const requestOptions = {
18
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/messages/${args.options.id}`,
19
+ headers: {
20
+ accept: 'application/json;odata.metadata=none'
21
+ },
22
+ responseType: 'json'
23
+ };
24
+ request_1.default
25
+ .get(requestOptions)
26
+ .then((res) => {
27
+ logger.log(res);
28
+ cb();
29
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
30
+ }
31
+ options() {
32
+ const options = [
33
+ {
34
+ option: '-i, --id <id>'
35
+ }
36
+ ];
37
+ const parentOptions = super.options();
38
+ return options.concat(parentOptions);
39
+ }
40
+ isValidId(id) {
41
+ return (/MC\d{6}/).test(id);
42
+ }
43
+ validate(args) {
44
+ if (!this.isValidId(args.options.id)) {
45
+ return `${args.options.id} is not a valid message ID`;
46
+ }
47
+ return true;
48
+ }
49
+ }
50
+ module.exports = new TenantServiceAnnouncementMessageGetCommand();
51
+ //# sourceMappingURL=serviceannouncement-message-get.js.map
@@ -0,0 +1,38 @@
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 TenantServiceAnnouncementMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_LIST;
8
+ }
9
+ get description() {
10
+ return 'Gets all service update messages for the tenant';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'title'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/messages`;
17
+ if (args.options.service) {
18
+ endpoint += `?$filter=services/any(c:c+eq+'${encodeURIComponent(args.options.service)}')`;
19
+ }
20
+ this
21
+ .getAllItems(endpoint, logger, true)
22
+ .then(() => {
23
+ logger.log(this.items);
24
+ cb();
25
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
26
+ }
27
+ options() {
28
+ const options = [
29
+ {
30
+ option: '-s, --service [service]'
31
+ }
32
+ ];
33
+ const parentOptions = super.options();
34
+ return options.concat(parentOptions);
35
+ }
36
+ }
37
+ module.exports = new TenantServiceAnnouncementMessageListCommand();
38
+ //# sourceMappingURL=serviceannouncement-message-list.js.map
@@ -10,9 +10,15 @@ exports.default = {
10
10
  REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
11
11
  REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
12
12
  REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
13
+ SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
13
14
  SERVICE_LIST: `${prefix} service list`,
14
15
  SERVICE_MESSAGE_LIST: `${prefix} service message list`,
15
16
  SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
17
+ SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
18
+ SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
19
+ SERVICEANNOUNCEMENT_HEALTHISSUE_LIST: `${prefix} serviceannouncement healthissue list`,
20
+ SERVICEANNOUNCEMENT_MESSAGE_GET: `${prefix} serviceannouncement message get`,
21
+ SERVICEANNOUNCEMENT_MESSAGE_LIST: `${prefix} serviceannouncement message list`,
16
22
  STATUS_LIST: `${prefix} status list`
17
23
  };
18
24
  //# sourceMappingURL=commands.js.map
@@ -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,51 @@
1
+ # aad app delete
2
+
3
+ Removes an Azure AD app registration
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad app delete [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
15
+
16
+ `--objectId [objectId]`
17
+ : Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
18
+
19
+ `--name [name]`
20
+ : Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
21
+
22
+ `--confirm`:
23
+ : Don't prompt for confirmation to delete the app
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ For best performance use the `objectId` option to reference the Azure AD application registration to delete. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
30
+
31
+ 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.
32
+
33
+ ## Examples
34
+
35
+ Delete the Azure AD application registration by its app (client) ID
36
+
37
+ ```sh
38
+ m365 aad app delete --appId d75be2e1-0204-4f95-857d-51a37cf40be8
39
+ ```
40
+
41
+ Delete the Azure AD application registration by its object ID
42
+
43
+ ```sh
44
+ m365 aad app delete --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
45
+ ```
46
+
47
+ Delete the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
48
+
49
+ ```sh
50
+ m365 aad app delete --name "My app" --confirm
51
+ ```
@@ -0,0 +1,30 @@
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
+ `-d, --deleted`
14
+ : Use to retrieve deleted groups
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Lists all groups defined in Azure Active Directory.
21
+
22
+ ```sh
23
+ m365 aad group list
24
+ ```
25
+
26
+ List all recently deleted groups in the tenant
27
+
28
+ ```sh
29
+ m365 aad group list --deleted
30
+ ```
@@ -11,10 +11,13 @@ m365 aad user get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : The ID of the user to retrieve information for. Specify `id` or `userName` but not both
14
+ : The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
15
15
 
16
16
  `-n, --userName [userName]`
17
- : The name of the user to retrieve information for. Specify `id` or `userName` but not both
17
+ : The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
+
19
+ `--email [email]`
20
+ : The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
21
 
19
22
  `-p, --properties [properties]`
20
23
  : Comma-separated list of properties to retrieve
@@ -23,9 +26,9 @@ m365 aad user get [options]
23
26
 
24
27
  ## Remarks
25
28
 
26
- You can retrieve information about a user, either by specifying that user's id or user name (`userPrincipalName`), but not both.
29
+ You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
27
30
 
28
- If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
31
+ If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
29
32
 
30
33
  ## Examples
31
34
 
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
41
44
  m365 aad user get --userName AarifS@contoso.onmicrosoft.com
42
45
  ```
43
46
 
47
+ Get information about the user with email _AarifS@contoso.onmicrosoft.com_
48
+
49
+ ```sh
50
+ m365 aad user get --email AarifS@contoso.onmicrosoft.com
51
+ ```
52
+
44
53
  For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
45
54
 
46
55
  ```sh
@@ -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)
@@ -13,6 +13,9 @@ m365 aad user list [options]
13
13
  `-p, --properties [properties]`
14
14
  : Comma-separated list of properties to retrieve
15
15
 
16
+ `-d, --deleted`
17
+ : Use to retrieve deleted users
18
+
16
19
  --8<-- "docs/cmd/_global.md"
17
20
 
18
21
  ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
31
34
  m365 aad user list
32
35
  ```
33
36
 
37
+ List all recently deleted users in the tenant
38
+
39
+ ```sh
40
+ m365 aad user list --deleted
41
+ ```
42
+
34
43
  List all users in the tenant. For each one return the display name and e-mail address
35
44
 
36
45
  ```sh
@@ -0,0 +1,78 @@
1
+ # planner task add
2
+
3
+ Adds a new Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : Title of the task to add.
15
+
16
+ `--planId [planId]`
17
+ : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
18
+
19
+ `--planName [planName]`
20
+ : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
21
+
22
+ `--ownerGroupId [ownerGroupId]`
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
24
+
25
+ `--ownerGroupName [ownerGroupName]`
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
27
+
28
+ `--bucketId [bucketId]`
29
+ : Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
+
31
+ `--bucketName [bucketName]`
32
+ : Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
+
34
+ `--startDateTime [startDateTime]`
35
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
36
+
37
+ `--dueDateTime [dueDateTime]`
38
+ : 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`
39
+
40
+ `--percentComplete [percentComplete]`
41
+ : Percentage of task completion. Number between 0 and 100.
42
+ - When set to 0, the task is considered _Not started_.
43
+ - When set between 1 and 99, the task is considered _In progress_.
44
+ - When set to 100, the task is considered _Completed_.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : The comma-separated UPNs of the assignees the task is assigned to. 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. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
57
+
58
+ --8<-- "docs/cmd/_global.md"
59
+
60
+ ## Examples
61
+
62
+ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
63
+
64
+ ```sh
65
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
66
+ ```
67
+
68
+ Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
69
+
70
+ ```sh
71
+ m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
72
+ ```
73
+
74
+ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
75
+
76
+ ```sh
77
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
78
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task details get
2
+
3
+ Retrieve the details of the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task details get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Retrieve the details of the specified planner task
21
+
22
+ ```sh
23
+ m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
+ ```
@@ -0,0 +1,29 @@
1
+ # planner task get
2
+
3
+ Retrieve the the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! attention
21
+ This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
22
+
23
+ ## Examples
24
+
25
+ Retrieve the the specified planner task
26
+
27
+ ```sh
28
+ m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
29
+ ```
@@ -30,6 +30,11 @@ m365 planner task list [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
+ ## Remarks
34
+
35
+ !!! attention
36
+ This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
37
+
33
38
  ## Examples
34
39
 
35
40
  List tasks for the currently logged in user
@@ -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)
@@ -30,14 +30,14 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain
30
30
 
31
31
  ## Examples
32
32
 
33
- Adds a new external connection with name and description of test
33
+ Adds a new external connection with name and description of test app
34
34
 
35
35
  ```sh
36
- m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
36
+ m365 search externalconnection add --id MyApp --name "Test" --description "Test"
37
37
  ```
38
38
 
39
39
  Adds a new external connection with a limited number of authorized apps
40
40
 
41
41
  ```sh
42
- m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
42
+ m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
43
43
  ```
@@ -13,24 +13,42 @@ m365 spo group user add [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the SharePoint group is available
15
15
 
16
- `--groupId <groupId>`
17
- : Id of the SharePoint Group to which user needs to be added
16
+ `--groupId [groupId]`
17
+ : Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
18
18
 
19
- `--userName <userName>`
20
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
19
+ `--groupName [groupName]`
20
+ : Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
21
+
22
+ `--userName [userName]`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
24
+
25
+ `--email [email]`
26
+ : User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
24
30
  ## Examples
25
31
 
26
- Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
32
+ Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
27
33
 
28
34
  ```sh
29
35
  m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
30
36
  ```
31
37
 
32
- Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
38
+ Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
33
39
 
34
40
  ```sh
35
41
  m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
36
42
  ```
43
+
44
+ Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
45
+
46
+ ```sh
47
+ m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
48
+ ```
49
+
50
+ Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
51
+
52
+ ```sh
53
+ m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
54
+ ```
@@ -0,0 +1,39 @@
1
+ # spo group user remove
2
+
3
+ Removes the specified user from a SharePoint group
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo group user remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the SharePoint group is available
15
+
16
+ `--groupId [groupId]`
17
+ : Id of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
18
+
19
+ `--groupName [groupName]`
20
+ : Name of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
21
+
22
+ `--userName <userName>`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com).
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Remove a user from SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
30
+
31
+ ```sh
32
+ m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
33
+ ```
34
+
35
+ Remove a user from SharePoint group with Name _Site A Visitors_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
36
+
37
+ ```sh
38
+ m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
39
+ ```