@pnp/cli-microsoft365 6.0.0-beta.c32757e → 6.0.0-beta.d4d33ed

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 (98) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/aad/commands/app/app-remove.js +0 -4
  3. package/dist/m365/aad/commands/app/app-role-remove.js +0 -4
  4. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  5. package/dist/m365/aad/commands.js +0 -2
  6. package/dist/m365/base/PowerAppsCommand.js +10 -0
  7. package/dist/m365/pa/commands/app/app-get.js +3 -5
  8. package/dist/m365/pa/commands/app/app-list.js +10 -9
  9. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  10. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  11. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  12. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  13. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  14. package/dist/m365/planner/commands/bucket/bucket-add.js +11 -11
  15. package/dist/m365/planner/commands/bucket/bucket-get.js +13 -13
  16. package/dist/m365/planner/commands/bucket/bucket-list.js +11 -11
  17. package/dist/m365/planner/commands/bucket/bucket-remove.js +13 -13
  18. package/dist/m365/planner/commands/bucket/bucket-set.js +13 -13
  19. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  20. package/dist/m365/planner/commands/plan/plan-get.js +1 -5
  21. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  22. package/dist/m365/planner/commands/task/task-add.js +11 -11
  23. package/dist/m365/planner/commands/task/task-get.js +10 -20
  24. package/dist/m365/planner/commands/task/task-list.js +13 -13
  25. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  26. package/dist/m365/planner/commands/task/task-set.js +11 -11
  27. package/dist/m365/planner/commands.js +0 -2
  28. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  29. package/dist/m365/search/commands.js +1 -0
  30. package/dist/m365/spo/base-permissions.js +9 -0
  31. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  32. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  33. package/dist/m365/spo/commands/field/field-get.js +14 -5
  34. package/dist/m365/spo/commands/field/field-remove.js +19 -10
  35. package/dist/m365/spo/commands/field/field-set.js +16 -9
  36. package/dist/m365/spo/commands/group/group-add.js +96 -0
  37. package/dist/m365/spo/commands/group/group-set.js +167 -0
  38. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  39. package/dist/m365/spo/commands/list/list-list.js +1 -10
  40. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  41. package/dist/m365/spo/commands/listitem/listitem-list.js +9 -26
  42. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  43. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  44. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  45. package/dist/m365/spo/commands/site/site-list.js +47 -16
  46. package/dist/m365/spo/commands/site/site-set.js +322 -162
  47. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  48. package/dist/m365/spo/commands.js +3 -3
  49. package/dist/m365/teams/commands/tab/tab-get.js +2 -2
  50. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  51. package/dist/m365/teams/commands/team/team-clone.js +33 -7
  52. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  53. package/dist/m365/teams/commands/team/team-set.js +25 -5
  54. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  55. package/dist/utils/planner.js +6 -6
  56. package/docs/docs/cmd/aad/app/app-remove.md +0 -6
  57. package/docs/docs/cmd/aad/app/app-role-remove.md +0 -6
  58. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  59. package/docs/docs/cmd/planner/bucket/bucket-add.md +7 -7
  60. package/docs/docs/cmd/planner/bucket/bucket-get.md +8 -8
  61. package/docs/docs/cmd/planner/bucket/bucket-list.md +6 -6
  62. package/docs/docs/cmd/planner/bucket/bucket-remove.md +6 -6
  63. package/docs/docs/cmd/planner/bucket/bucket-set.md +7 -7
  64. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  65. package/docs/docs/cmd/planner/plan/plan-get.md +0 -6
  66. package/docs/docs/cmd/planner/task/task-add.md +9 -9
  67. package/docs/docs/cmd/planner/task/task-get.md +15 -9
  68. package/docs/docs/cmd/planner/task/task-list.md +7 -7
  69. package/docs/docs/cmd/planner/task/task-set.md +7 -7
  70. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  71. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  72. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  73. package/docs/docs/cmd/spo/field/field-get.md +6 -3
  74. package/docs/docs/cmd/spo/field/field-remove.md +9 -6
  75. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  76. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  77. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  78. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  79. package/docs/docs/cmd/spo/list/list-list.md +0 -3
  80. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  81. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -6
  82. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  83. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  84. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  85. package/docs/docs/cmd/teams/tab/tab-get.md +2 -2
  86. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  87. package/docs/docs/cmd/teams/team/team-clone.md +11 -5
  88. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  89. package/docs/docs/cmd/teams/team/team-set.md +10 -4
  90. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  91. package/npm-shrinkwrap.json +173 -158
  92. package/package.json +13 -13
  93. package/dist/m365/spo/commands/site/site-classic-add.js +0 -333
  94. package/dist/m365/spo/commands/site/site-classic-list.js +0 -98
  95. package/dist/m365/spo/commands/site/site-classic-set.js +0 -358
  96. package/docs/docs/cmd/spo/site/site-classic-add.md +0 -93
  97. package/docs/docs/cmd/spo/site/site-classic-list.md +0 -65
  98. package/docs/docs/cmd/spo/site/site-classic-set.md +0 -99
@@ -17,16 +17,16 @@ 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
21
 
22
- `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
24
24
 
25
25
  `--ownerGroupId [ownerGroupId]`
26
- : 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`.
27
27
 
28
28
  `--ownerGroupName [ownerGroupName]`
29
- : 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`.
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
@@ -47,11 +47,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
47
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
48
 
49
49
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
50
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
51
  ```
52
52
 
53
53
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
54
 
55
55
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
56
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
+ ```
@@ -11,16 +11,16 @@ 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
15
 
16
- `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
18
18
 
19
19
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
20
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
21
 
22
22
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -35,5 +35,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
35
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
36
 
37
37
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
38
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
39
  ```
@@ -17,16 +17,16 @@ 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
21
 
22
- `--planName [planName]`
23
- : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
24
24
 
25
25
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
27
 
28
28
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
30
 
31
31
  `--confirm`
32
32
  : Don't prompt for confirmation
@@ -56,5 +56,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
56
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
57
 
58
58
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
59
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
60
  ```
@@ -17,16 +17,16 @@ 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
21
 
22
- `--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`.
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`.
24
24
 
25
25
  `--ownerGroupId [ownerGroupId]`
26
- : 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`.
27
27
 
28
28
  `--ownerGroupName [ownerGroupName]`
29
- : 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`.
30
30
 
31
31
  `--newName [newName]`
32
32
  : New name of the bucket.
@@ -47,11 +47,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
47
47
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
48
48
 
49
49
  ```sh
50
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
50
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
51
51
  ```
52
52
 
53
53
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
54
54
 
55
55
  ```sh
56
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
56
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
57
  ```
@@ -19,18 +19,34 @@ m365 planner plan add [options]
19
19
  `--ownerGroupName [ownerGroupName]`
20
20
  : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
21
21
 
22
+ `--shareWithUserIds [shareWithUserIds]`
23
+ : The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
24
+
25
+ `--shareWithUserNames [shareWithUserNames]`
26
+ : The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
27
+
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
33
+
24
34
  ## Examples
25
35
 
26
36
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
27
37
 
28
38
  ```sh
29
- m365 planner plan add --title "My Planner Plan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
39
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
30
40
  ```
31
41
 
32
42
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
33
43
 
34
44
  ```sh
35
- m365 planner plan add --title "My Planner Plan" --ownerGroupName "My Planner Group"
45
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
46
+ ```
47
+
48
+ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
49
+
50
+ ```sh
51
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
36
52
  ```
@@ -8,12 +8,6 @@ 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
-
17
11
  ## Options
18
12
 
19
13
  `-i, --id [id]`
@@ -14,22 +14,22 @@ 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
18
 
19
- `--planName [planName]`
20
- : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
21
21
 
22
22
  `--ownerGroupId [ownerGroupId]`
23
- : 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`.
24
24
 
25
25
  `--ownerGroupName [ownerGroupName]`
26
- : 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`.
27
27
 
28
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.
29
+ : 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
30
 
31
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.
32
+ : 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
33
 
34
34
  `--startDateTime [startDateTime]`
35
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`
@@ -89,10 +89,10 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
89
89
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
90
90
  ```
91
91
 
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_
92
+ 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
93
 
94
94
  ```sh
95
- m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
95
+ m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
96
96
  ```
97
97
 
98
98
  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_
@@ -8,6 +8,12 @@ Retrieve the specified planner task
8
8
  m365 planner task get [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 planner task details get [options]
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-i, --id [id]`
@@ -20,22 +26,22 @@ m365 planner task get [options]
20
26
  : (deprecated. Use `id` instead) ID of the task.
21
27
 
22
28
  `--bucketId [bucketId]`
23
- : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
29
+ : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
24
30
 
25
31
  `--bucketName [bucketName]`
26
- : Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
32
+ : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
27
33
 
28
34
  `--planId [planId]`
29
- : Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
35
+ : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
36
 
31
- `--planName [planName]`
32
- : Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
37
+ `--planTitle [planTitle]`
38
+ : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
33
39
 
34
40
  `--ownerGroupId [ownerGroupId]`
35
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
41
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
42
 
37
43
  `--ownerGroupName [ownerGroupName]`
38
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
44
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
39
45
 
40
46
  --8<-- "docs/cmd/_global.md"
41
47
 
@@ -47,8 +53,8 @@ Retrieve the specified planner task by id
47
53
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
48
54
  ```
49
55
 
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_
56
+ 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
57
 
52
58
  ```sh
53
- m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
59
+ m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
54
60
  ```
@@ -17,16 +17,16 @@ 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
21
 
22
- `--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.
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.
24
24
 
25
25
  `--ownerGroupId [ownerGroupId]`
26
- : 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`.
27
27
 
28
28
  `--ownerGroupName [ownerGroupName]`
29
- : 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`.
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
@@ -52,7 +52,7 @@ m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
52
52
  List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
53
53
 
54
54
  ```sh
55
- m365 planner task list --planName "My Plan" --ownerGroupName "My Group"
55
+ m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
56
56
  ```
57
57
 
58
58
  List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
@@ -70,5 +70,5 @@ m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6M
70
70
  List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
71
71
 
72
72
  ```sh
73
- m365 planner task list --bucketName "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
73
+ m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
74
74
  ```
@@ -23,16 +23,16 @@ 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
27
 
28
- `--planName [planName]`
29
- : Name of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
28
+ `--planTitle [planTitle]`
29
+ : Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
30
30
 
31
31
  `--ownerGroupId [ownerGroupId]`
32
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
33
33
 
34
34
  `--ownerGroupName [ownerGroupName]`
35
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
35
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
36
 
37
37
  `--startDateTime [startDateTime]`
38
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`
@@ -91,10 +91,10 @@ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the
91
91
  m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
92
92
  ```
93
93
 
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_
94
+ 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
95
 
96
96
  ```sh
97
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
97
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
98
98
  ```
99
99
 
100
100
  Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
@@ -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,8 +10,11 @@ m365 spo customaction get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : ID of the user custom action to retrieve information for
13
+ `-i, --id [id]`
14
+ : ID of the user custom action to retrieve information for. Specify either `id` or `title`
15
+
16
+ `-t, --title [title]`
17
+ : Title of the user custom action to retrieve information for. Specify either `id` or `title`
15
18
 
16
19
  `-u, --url <url>`
17
20
  : Url of the site or site collection to retrieve the custom action from
@@ -21,6 +24,10 @@ m365 spo customaction get [options]
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
27
+ ## Remarks
28
+
29
+ If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
30
+
24
31
  ## Examples
25
32
 
26
33
  Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
@@ -29,6 +36,12 @@ Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c
29
36
  m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --url https://contoso.sharepoint.com/sites/test
30
37
  ```
31
38
 
39
+ Return details about the user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
40
+
41
+ ```sh
42
+ m365 spo customaction get --title "YourAppCustomizer" --url https://contoso.sharepoint.com/sites/test
43
+ ```
44
+
32
45
  Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_
33
46
 
34
47
  ```sh
@@ -10,8 +10,11 @@ m365 spo customaction remove [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : Id (GUID) of the custom action to remove
13
+ `-i, --id [id]`
14
+ : Id (GUID) of the custom action to remove. Specify either `id` or `title`
15
+
16
+ `-t, --title [title]`
17
+ : Title of the user custom action to retrieve information for. Specify either `id` or `title`
15
18
 
16
19
  `-u, --url <url>`
17
20
  : Url of the site or site collection to remove the custom action from
@@ -24,6 +27,10 @@ m365 spo customaction remove [options]
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
30
+ ## Remarks
31
+
32
+ If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
33
+
27
34
  ## Examples
28
35
 
29
36
  Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
@@ -32,24 +39,48 @@ Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ locate
32
39
  m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --url https://contoso.sharepoint.com/sites/test
33
40
  ```
34
41
 
42
+ Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
43
+
44
+ ```sh
45
+ m365 spo customaction remove --title "YourAppCustomizer" --url https://contoso.sharepoint.com/sites/test
46
+ ```
47
+
35
48
  Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message.
36
49
 
37
50
  ```sh
38
51
  m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --url https://contoso.sharepoint.com/sites/test --confirm
39
52
  ```
40
53
 
54
+ Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message.
55
+
56
+ ```sh
57
+ m365 spo customaction remove --title "YourAppCustomizer" --url https://contoso.sharepoint.com/sites/test --confirm
58
+ ```
59
+
41
60
  Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_
42
61
 
43
62
  ```sh
44
63
  m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --url https://contoso.sharepoint.com/sites/test --scope Site
45
64
  ```
46
65
 
66
+ Removes user custom action with Title _YourAppCustomizer_ located in site collection _https://contoso.sharepoint.com/sites/test_
67
+
68
+ ```sh
69
+ m365 spo customaction remove --title "YourAppCustomizer" --url https://contoso.sharepoint.com/sites/test --scope Site
70
+ ```
71
+
47
72
  Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site _https://contoso.sharepoint.com/sites/test_
48
73
 
49
74
  ```sh
50
75
  m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --url https://contoso.sharepoint.com/sites/test --scope Web
51
76
  ```
52
77
 
78
+ Removes user custom action with Title _YourAppCustomizer_ located in site _https://contoso.sharepoint.com/sites/test_
79
+
80
+ ```sh
81
+ m365 spo customaction remove --title "YourAppCustomizer" --url https://contoso.sharepoint.com/sites/test --scope Web
82
+ ```
83
+
53
84
  ## More information
54
85
 
55
86
  - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
@@ -23,10 +23,13 @@ m365 spo field get [options]
23
23
  : Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl
24
24
 
25
25
  `-i, --id [id]`
26
- : The ID of the field to retrieve. Specify id or fieldTitle but not both
26
+ : The ID of the field to retrieve. Specify id or title but not both
27
27
 
28
28
  `--fieldTitle [fieldTitle]`
29
- : The display name (case-sensitive) of the field to retrieve. Specify id or fieldTitle but not both
29
+ : (deprecated. Use `title` instead) The display name (case-sensitive) of the field to retrieve. Specify id or fieldTitle but not both
30
+
31
+ `-t, --title [title]`
32
+ : The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,5 +50,5 @@ m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales -
47
50
  Retrieves list column by display name located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its url
48
51
 
49
52
  ```sh
50
- m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl 'Lists/Events' --fieldTitle 'Title'
53
+ m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
51
54
  ```
@@ -23,13 +23,16 @@ m365 spo field remove [options]
23
23
  : Server- or web-relative URL of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
24
24
 
25
25
  `-i, --id [id]`
26
- : The ID of the field to remove. Specify id, fieldTitle, or group
26
+ : The ID of the field to remove. Specify id, title, or group
27
27
 
28
- `-t, --fieldTitle [fieldTitle]`
29
- : The display name (case-sensitive) of the field to remove. Specify id, fieldTitle, or group
28
+ `--fieldTitle [fieldTitle]`
29
+ : (deprecated. Use `title` instead) The display name (case-sensitive) of the field to remove. Specify id, fieldTitle, or group
30
+
31
+ `-t, --title [title]`
32
+ : The display name (case-sensitive) of the field to remove. Specify id, title, or group
30
33
 
31
34
  `-g, --group [group]`
32
- : Delete all fields from this group (case-sensitive). Specify id, fieldTitle, or group
35
+ : Delete all fields from this group (case-sensitive). Specify id, title, or group
33
36
 
34
37
  `--confirm`
35
38
  : Don't prompt for confirming removing the field
@@ -53,11 +56,11 @@ m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sale
53
56
  Remove the list column with the specified display name, located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its url
54
57
 
55
58
  ```sh
56
- m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl 'Lists/Events' --fieldTitle 'Title'
59
+ m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
57
60
  ```
58
61
 
59
62
  Remove all site columns from group _MyGroup_
60
63
 
61
64
  ```sh
62
- m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group 'MyGroup'
65
+ m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group "MyGroup"
63
66
  ```
@@ -20,10 +20,13 @@ m365 spo field set [options]
20
20
  : Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
21
21
 
22
22
  `-i, --id [id]`
23
- : ID of the field to update. Specify `name` or `id` but not both
23
+ : ID of the field to update. Specify `id` or `title` but not both
24
+
25
+ `-t, --title [title]`
26
+ : Title or internal name of the field to update. Specify `id` or `title` but not both
24
27
 
25
28
  `-n, --name [name]`
26
- : Title or internal name of the field to update. Specify `name` or `id` but not both
29
+ : (deprecated. Use `title` instead) Title or internal name of the field to update. Specify `id` or `name` but not both
27
30
 
28
31
  `--updateExistingLists`
29
32
  : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
@@ -39,7 +42,7 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
39
42
  Update the title of the site column specified by its internal name and push changes to existing lists
40
43
 
41
44
  ```sh
42
- m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --name 'MyColumn' --updateExistingLists --Title 'My column'
45
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --title 'MyColumn' --updateExistingLists --Title 'My column'
43
46
  ```
44
47
 
45
48
  Update the title of the list column specified by its ID
@@ -51,5 +54,5 @@ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --lis
51
54
  Update column formatting of the specified list column
52
55
 
53
56
  ```sh
54
- m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --name 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
57
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
55
58
  ```