@pnp/cli-microsoft365 5.4.0 → 5.5.0-beta.10c7ae2

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 (63) hide show
  1. package/dist/Auth.js +1 -1
  2. package/dist/Command.js +22 -0
  3. package/dist/m365/flow/commands/flow-export.js +3 -0
  4. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  5. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  6. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  7. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  8. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  9. package/dist/m365/planner/commands/plan/plan-get.js +58 -17
  10. package/dist/m365/planner/commands/plan/plan-remove.js +141 -0
  11. package/dist/m365/planner/commands/task/task-add.js +16 -16
  12. package/dist/m365/planner/commands/task/task-get.js +14 -9
  13. package/dist/m365/planner/commands/task/task-list.js +19 -11
  14. package/dist/m365/planner/commands/task/task-reference-add.js +1 -7
  15. package/dist/m365/planner/commands/task/task-reference-remove.js +11 -14
  16. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  17. package/dist/m365/planner/commands/task/task-set.js +17 -23
  18. package/dist/m365/planner/commands/tenant/tenant-settings-set.js +95 -0
  19. package/dist/m365/planner/commands.js +3 -1
  20. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  21. package/dist/m365/search/commands.js +1 -0
  22. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.15.0.js +23 -0
  23. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.0.js +6 -4
  26. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  27. package/dist/m365/spo/base-permissions.js +9 -0
  28. package/dist/m365/spo/commands/hubsite/hubsite-get.js +62 -12
  29. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  30. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  31. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  32. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  33. package/dist/m365/spo/commands.js +1 -0
  34. package/dist/m365/teams/commands/cache/cache-remove.js +155 -0
  35. package/dist/m365/teams/commands.js +1 -0
  36. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  37. package/dist/utils/accessToken.js +18 -0
  38. package/dist/utils/planner.js +9 -8
  39. package/dist/utils/validation.js +5 -1
  40. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  41. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  42. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  43. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  44. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  45. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  46. package/docs/docs/cmd/planner/plan/plan-get.md +14 -2
  47. package/docs/docs/cmd/planner/plan/plan-remove.md +48 -0
  48. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  49. package/docs/docs/cmd/planner/task/task-get.md +11 -8
  50. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  51. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  52. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +56 -0
  53. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  54. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +19 -8
  55. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  56. package/docs/docs/cmd/teams/cache/cache-remove.md +46 -0
  57. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +1 -1
  58. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +1 -1
  59. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +1 -1
  60. package/npm-shrinkwrap.json +2 -2
  61. package/package.json +3 -3
  62. package/dist/m365/planner/commands/plan/plan-details-get.js +0 -116
  63. package/docs/docs/cmd/planner/plan/plan-details-get.md +0 -45
@@ -6,8 +6,12 @@ exports.validation = {
6
6
  return guids.every(guid => this.isValidGuid(guid));
7
7
  },
8
8
  isValidGuid(guid) {
9
+ if (!guid) {
10
+ return false;
11
+ }
9
12
  const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
10
- return guidRegEx.test(guid);
13
+ // verify if the guid is a valid guid. @meid will be replaced in a later stage with the actual user id of the logged in user
14
+ return guidRegEx.test(guid) || guid.toLocaleLowerCase().trim() === "@meid";
11
15
  },
12
16
  isValidTeamsChannelId(guid) {
13
17
  const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
@@ -56,6 +56,18 @@ For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user na
56
56
  m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
57
57
  ```
58
58
 
59
+ Get information about the currently logged user using the Id token
60
+
61
+ ```sh
62
+ m365 aad user get --id "@meId"
63
+ ```
64
+
65
+ Get information about the currently logged in user using the UserName token
66
+
67
+ ```sh
68
+ m365 aad user get --userName "@meUserName"
69
+ ```
70
+
59
71
  ## More information
60
72
 
61
73
  - Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
14
14
  : Name of the bucket to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--orderHint [orderHint]`
29
32
  : 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).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
38
41
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
39
42
  ```
40
43
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
44
+ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
42
45
 
43
46
  ```sh
44
- m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
47
+ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
48
  ```
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
17
17
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
50
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
53
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
54
  ```
52
55
 
53
56
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
57
 
55
58
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
59
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
60
+ ```
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
11
11
  ## Options
12
12
 
13
13
  `--planId [planId]`
14
- : ID of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
14
+ : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
+
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
18
 
16
19
  `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
20
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
38
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
39
 
37
40
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
41
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
42
  ```
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
17
17
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--confirm`
32
35
  : Don't prompt for confirmation
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
59
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
60
 
58
61
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
62
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
63
  ```
@@ -17,16 +17,19 @@ m365 planner bucket set [options]
17
17
  : Name of the bucket. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--newName [newName]`
32
35
  : New name of the bucket.
@@ -47,11 +50,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
47
50
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
53
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
51
54
  ```
52
55
 
53
56
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
54
57
 
55
58
  ```sh
56
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
59
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
60
  ```
@@ -8,6 +8,12 @@ Retrieve information about the specified plan
8
8
  m365 planner plan get [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 planner plan details get [options]
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-i, --id [id]`
@@ -16,11 +22,17 @@ m365 planner plan get [options]
16
22
  `-t, --title [title]`
17
23
  : Title of the plan. Specify either `id` or `title` but not both.
18
24
 
25
+ `--planId [planId]`
26
+ : (deprecated. Use `id` instead) ID of the plan. Specify either `planId` or `planTitle` but not both.
27
+
28
+ `---planTitle [planTitle]`
29
+ : (deprecated. Use `title` instead) Title of the plan. Specify either `planId` or `planTitle` but not both.
30
+
19
31
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
32
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
21
33
 
22
34
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
35
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
24
36
 
25
37
  --8<-- "docs/cmd/_global.md"
26
38
 
@@ -0,0 +1,48 @@
1
+ # planner plan remove
2
+
3
+ Removes the Microsoft Planner plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner plan remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `i, --id [id]`
14
+ : ID of the plan to remove. Specify either `id` or `title` but not both.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the plan to remove. Specify either `id` or `title` but not both.
18
+
19
+ `--ownerGroupId [ownerGroupId]`
20
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
21
+
22
+ `--ownerGroupName [ownerGroupName]`
23
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the Microsoft Planner plan by ID
33
+
34
+ ```sh
35
+ m365 planner plan remove --id gndWOTSK60GfPQfiDDj43JgACDCb
36
+ ```
37
+
38
+ Removes the Microsoft Planner plan with title _My Plan_ in group with specific ID
39
+
40
+ ```sh
41
+ m365 planner plan remove --title "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000
42
+ ```
43
+
44
+ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My Planner Group_ without confirmation prompt
45
+
46
+ ```sh
47
+ m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
48
+ ```
@@ -14,22 +14,25 @@ m365 planner task add [options]
14
14
  : Title of the task to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--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.
32
+ : ID of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
33
 
31
34
  `--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.
35
+ : Name of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
36
 
34
37
  `--startDateTime [startDateTime]`
35
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`
@@ -89,10 +92,10 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
89
92
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
90
93
  ```
91
94
 
92
- 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_
95
+ Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
93
96
 
94
97
  ```sh
95
- m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
98
+ m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
96
99
  ```
97
100
 
98
101
  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_
@@ -20,22 +20,25 @@ m365 planner task get [options]
20
20
  : (deprecated. Use `id` instead) ID of the task.
21
21
 
22
22
  `--bucketId [bucketId]`
23
- : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
23
+ : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
24
24
 
25
25
  `--bucketName [bucketName]`
26
- : Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
26
+ : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
27
27
 
28
28
  `--planId [planId]`
29
- : Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
29
+ : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
+
31
+ `--planTitle [planTitle]`
32
+ : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
33
 
31
34
  `--planName [planName]`
32
- : Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
35
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
33
36
 
34
37
  `--ownerGroupId [ownerGroupId]`
35
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
38
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
39
 
37
40
  `--ownerGroupName [ownerGroupName]`
38
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
41
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
39
42
 
40
43
  --8<-- "docs/cmd/_global.md"
41
44
 
@@ -47,8 +50,8 @@ Retrieve the specified planner task by id
47
50
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
48
51
  ```
49
52
 
50
- Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_ based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
53
+ Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_.
51
54
 
52
55
  ```sh
53
- m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
56
+ m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
54
57
  ```
@@ -17,16 +17,19 @@ m365 planner task list [options]
17
17
  : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
20
+ : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -52,7 +55,7 @@ m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
52
55
  List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
53
56
 
54
57
  ```sh
55
- m365 planner task list --planName "My Plan" --ownerGroupName "My Group"
58
+ m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
56
59
  ```
57
60
 
58
61
  List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
@@ -70,5 +73,5 @@ m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6M
70
73
  List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
71
74
 
72
75
  ```sh
73
- m365 planner task list --bucketName "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
76
+ m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
74
77
  ```
@@ -23,16 +23,19 @@ m365 planner task set [options]
23
23
  : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
24
24
 
25
25
  `--planId [planId]`
26
- : ID of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
26
+ : ID of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
27
+
28
+ `--planTitle [planTitle]`
29
+ : Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
27
30
 
28
31
  `--planName [planName]`
29
- : Name of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
32
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
30
33
 
31
34
  `--ownerGroupId [ownerGroupId]`
32
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
35
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
33
36
 
34
37
  `--ownerGroupName [ownerGroupName]`
35
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
38
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
39
 
37
40
  `--startDateTime [startDateTime]`
38
41
  : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
@@ -91,10 +94,10 @@ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the
91
94
  m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
92
95
  ```
93
96
 
94
- 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_
97
+ Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_
95
98
 
96
99
  ```sh
97
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
100
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
98
101
  ```
99
102
 
100
103
  Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
@@ -0,0 +1,56 @@
1
+ # planner tenant settings set
2
+
3
+ Sets Microsoft Planner configuration of the tenant
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner tenant settings set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--isPlannerAllowed [isPlannerAllowed]`
14
+ : Configure whether Planner should be enabled on the tenant.
15
+
16
+ `--allowCalendarSharing [allowCalendarSharing]`
17
+ : Configure whether Outlook calendar sync is enabled.
18
+
19
+ `--allowTenantMoveWithDataLoss [allowTenantMoveWithDataLoss]`
20
+ : Configure whether a tenant move into a new region is authorized.
21
+
22
+ `--allowTenantMoveWithDataMigration [allowTenantMoveWithDataMigration]`
23
+ : Configure whether a tenant move with data migration is authorized.
24
+
25
+ `--allowRosterCreation [allowRosterCreation]`
26
+ : Configure whether Planner roster creation is allowed.
27
+
28
+ `--allowPlannerMobilePushNotifications [allowPlannerMobilePushNotifications]`
29
+ : Configure whether push notifications are enabled in the mobile app.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Remarks
34
+
35
+ !!! important
36
+ To use this command you must be a global administrator.
37
+
38
+ ## Examples
39
+
40
+ Disable Microsoft Planner in the tenant
41
+
42
+ ```sh
43
+ m365 planner tenant settings set --isPlannerAllowed false
44
+ ```
45
+
46
+ Disable Outlook calendar sync and mobile push notifications
47
+
48
+ ```sh
49
+ m365 planner tenant settings set --allowCalendarSharing false --allowPlannerMobilePushNotifications false
50
+ ```
51
+
52
+ Enable Microsoft Planner but disallow roster plans to be created
53
+
54
+ ```sh
55
+ m365 planner tenant settings set --isPlannerAllowed true --allowRosterCreation false
56
+ ```
@@ -0,0 +1,33 @@
1
+ # search externalconnection get
2
+
3
+ Allow the administrator to get a specific external connection for use in Microsoft Search.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 search externalconnection get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id [id]`
14
+ : ID of the External Connection to get. Specify either `id` or `name`
15
+
16
+ `-n, --name [name]`
17
+ : Name of the External Connection to get. Specify either `id` or `name`
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Get the External Connection by its id
24
+
25
+ ```sh
26
+ m365 search externalconnection get --id "MyApp"
27
+ ```
28
+
29
+ Get the External Connection by its name
30
+
31
+ ```sh
32
+ m365 search externalconnection get --name "Test"
33
+ ```
@@ -10,17 +10,16 @@ m365 spo hubsite get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : Hub site ID
13
+ `-i, --id [id]`
14
+ : ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
15
15
 
16
- --8<-- "docs/cmd/_global.md"
17
-
18
- ## Remarks
16
+ `-t, --title [title]`
17
+ : Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
19
18
 
20
- !!! attention
21
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
19
+ `-u, --url [url]`
20
+ : URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
22
21
 
23
- If the specified `id` doesn't refer to an existing hub site, you will get a `ResourceNotFoundException` error.
22
+ --8<-- "docs/cmd/_global.md"
24
23
 
25
24
  ## Examples
26
25
 
@@ -30,6 +29,18 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
30
29
  m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
31
30
  ```
32
31
 
32
+ Get information about the hub site with Title _My Hub Site_
33
+
34
+ ```sh
35
+ m365 spo hubsite get --title 'My Hub Site'
36
+ ```
37
+
38
+ Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
39
+
40
+ ```sh
41
+ m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
42
+ ```
43
+
33
44
  ## More information
34
45
 
35
46
  - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)
@@ -0,0 +1,27 @@
1
+ # spo roledefinition get
2
+
3
+ Gets specified role definition from web by id
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo roledefinition get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site for which to retrieve the role definition
15
+
16
+ `-i, --id <id>`
17
+ : The Id of the role definition to retrieve.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
24
+
25
+ ```sh
26
+ m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
27
+ ```