@pnp/cli-microsoft365 6.0.0-beta.f73c4f8 → 6.0.0-beta.f94d570

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 (95) 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 +4 -12
  15. package/dist/m365/planner/commands/bucket/bucket-get.js +4 -12
  16. package/dist/m365/planner/commands/bucket/bucket-list.js +4 -12
  17. package/dist/m365/planner/commands/bucket/bucket-remove.js +4 -12
  18. package/dist/m365/planner/commands/bucket/bucket-set.js +4 -12
  19. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  20. package/dist/m365/planner/commands/plan/plan-get.js +0 -4
  21. package/dist/m365/planner/commands/task/task-add.js +4 -10
  22. package/dist/m365/planner/commands/task/task-get.js +4 -19
  23. package/dist/m365/planner/commands/task/task-list.js +4 -12
  24. package/dist/m365/planner/commands/task/task-set.js +4 -10
  25. package/dist/m365/planner/commands.js +0 -2
  26. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  27. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  28. package/dist/m365/spo/commands/field/field-get.js +14 -5
  29. package/dist/m365/spo/commands/field/field-remove.js +19 -10
  30. package/dist/m365/spo/commands/field/field-set.js +16 -9
  31. package/dist/m365/spo/commands/file/file-rename.js +108 -0
  32. package/dist/m365/spo/commands/group/group-add.js +96 -0
  33. package/dist/m365/spo/commands/group/group-get.js +26 -6
  34. package/dist/m365/spo/commands/group/group-set.js +167 -0
  35. package/dist/m365/spo/commands/hubsite/hubsite-get.js +38 -2
  36. package/dist/m365/spo/commands/list/list-list.js +1 -10
  37. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  38. package/dist/m365/spo/commands/listitem/listitem-list.js +9 -26
  39. package/dist/m365/spo/commands/site/site-apppermission-add.js +3 -6
  40. package/dist/m365/spo/commands/site/site-apppermission-set.js +3 -6
  41. package/dist/m365/spo/commands/site/site-list.js +47 -16
  42. package/dist/m365/spo/commands/site/site-set.js +322 -162
  43. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  44. package/dist/m365/spo/commands.js +3 -3
  45. package/dist/m365/teams/commands/tab/tab-get.js +2 -2
  46. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  47. package/dist/m365/teams/commands/team/team-clone.js +33 -7
  48. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  49. package/dist/m365/teams/commands/team/team-set.js +25 -5
  50. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  51. package/docs/docs/cmd/aad/app/app-remove.md +0 -6
  52. package/docs/docs/cmd/aad/app/app-role-remove.md +0 -6
  53. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  54. package/docs/docs/cmd/planner/bucket/bucket-add.md +0 -3
  55. package/docs/docs/cmd/planner/bucket/bucket-get.md +0 -3
  56. package/docs/docs/cmd/planner/bucket/bucket-list.md +0 -3
  57. package/docs/docs/cmd/planner/bucket/bucket-remove.md +0 -3
  58. package/docs/docs/cmd/planner/bucket/bucket-set.md +0 -3
  59. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  60. package/docs/docs/cmd/planner/plan/plan-get.md +0 -6
  61. package/docs/docs/cmd/planner/task/task-add.md +0 -3
  62. package/docs/docs/cmd/planner/task/task-get.md +6 -3
  63. package/docs/docs/cmd/planner/task/task-list.md +0 -3
  64. package/docs/docs/cmd/planner/task/task-set.md +0 -3
  65. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  66. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  67. package/docs/docs/cmd/spo/field/field-get.md +6 -3
  68. package/docs/docs/cmd/spo/field/field-remove.md +9 -6
  69. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  70. package/docs/docs/cmd/spo/file/file-rename.md +43 -0
  71. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  72. package/docs/docs/cmd/spo/group/group-get.md +12 -3
  73. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  74. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +21 -0
  75. package/docs/docs/cmd/spo/list/list-list.md +0 -3
  76. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  77. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -6
  78. package/docs/docs/cmd/spo/site/site-apppermission-add.md +1 -1
  79. package/docs/docs/cmd/spo/site/site-apppermission-set.md +1 -1
  80. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  81. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  82. package/docs/docs/cmd/teams/tab/tab-get.md +2 -2
  83. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  84. package/docs/docs/cmd/teams/team/team-clone.md +11 -5
  85. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  86. package/docs/docs/cmd/teams/team/team-set.md +10 -4
  87. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  88. package/npm-shrinkwrap.json +173 -158
  89. package/package.json +13 -13
  90. package/dist/m365/spo/commands/site/site-classic-add.js +0 -333
  91. package/dist/m365/spo/commands/site/site-classic-list.js +0 -98
  92. package/dist/m365/spo/commands/site/site-classic-set.js +0 -358
  93. package/docs/docs/cmd/spo/site/site-classic-add.md +0 -93
  94. package/docs/docs/cmd/spo/site/site-classic-list.md +0 -65
  95. package/docs/docs/cmd/spo/site/site-classic-set.md +0 -99
@@ -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]`
@@ -19,9 +19,6 @@ m365 planner task add [options]
19
19
  `--planTitle [planTitle]`
20
20
  : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
21
21
 
22
- `--planName [planName]`
23
- : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
-
25
22
  `--ownerGroupId [ownerGroupId]`
26
23
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
24
 
@@ -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]`
@@ -31,9 +37,6 @@ m365 planner task get [options]
31
37
  `--planTitle [planTitle]`
32
38
  : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
33
39
 
34
- `--planName [planName]`
35
- : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
36
-
37
40
  `--ownerGroupId [ownerGroupId]`
38
41
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
39
42
 
@@ -22,9 +22,6 @@ m365 planner task list [options]
22
22
  `--planTitle [planTitle]`
23
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
- `--planName [planName]`
26
- : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
27
-
28
25
  `--ownerGroupId [ownerGroupId]`
29
26
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
27
 
@@ -28,9 +28,6 @@ m365 planner task set [options]
28
28
  `--planTitle [planTitle]`
29
29
  : Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
30
30
 
31
- `--planName [planName]`
32
- : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
33
-
34
31
  `--ownerGroupId [ownerGroupId]`
35
32
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
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
  ```
@@ -0,0 +1,43 @@
1
+ # spo file rename
2
+
3
+ Renames a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file rename [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located
15
+
16
+ `-s, --sourceUrl <sourceUrl>`
17
+ : Site-relative URL of the file to rename
18
+
19
+ `-t, --targetFileName <targetFileName>`
20
+ : New file name of the file
21
+
22
+ `--force`
23
+ : If a file already exists with target file name, it will be moved to the recycle bin. If omitted, the rename operation will be canceled if a file already exists with the specified file name
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ If you try to rename a file without the `--force` flag and a file with this name already exists, the operation will be cancelled.
30
+
31
+ ## Examples
32
+
33
+ Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_
34
+
35
+ ```sh
36
+ m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx'
37
+ ```
38
+
39
+ Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_. If the file with the target file name already exists, this file will be moved to the recycle bin
40
+
41
+ ```sh
42
+ m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx' --force
43
+ ```
@@ -0,0 +1,51 @@
1
+ # spo group add
2
+
3
+ Creates group in the specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo group add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the group should be added.
15
+
16
+ `-n, --name <name>`
17
+ : Name of the group to add.
18
+
19
+ `--description [description]`
20
+ : The description for the group.
21
+
22
+ `--allowMembersEditMembership [allowMembersEditMembership]`
23
+ : Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this. Default `false`.
24
+
25
+ `--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
26
+ : Who can view the membership of the group? When `false` everyone can view the group membership, otherwise only group members can. Default `true`.
27
+
28
+ `--allowRequestToJoinLeave [allowRequestToJoinLeave]`
29
+ : Specify whether to allow users to request membership in this group and allow users to request to leave the group. Default `false`.
30
+
31
+ `--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
32
+ : If auto-accept is enabled, users will automatically be added or removed when they make a request. Default `false`.
33
+
34
+ `--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
35
+ : All membership requests will be sent to the email address specified.
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Examples
40
+
41
+ Create group with title and description
42
+
43
+ ```sh
44
+ m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --description "This group contains all project leaders"
45
+ ```
46
+
47
+ Create group with membership requests
48
+
49
+ ```sh
50
+ m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
51
+ ```
@@ -11,13 +11,16 @@ m365 spo group get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the group is located
14
+ : URL of the site where the group is located.
15
15
 
16
16
  `-i, --id [id]`
17
- : ID of the site group to get. Use either `id` or `name`, but not all. e.g `7`
17
+ : ID of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
18
18
 
19
19
  `--name [name]`
20
- : Name of the site group to get. Specify either `id` or `name` but not both e.g `Team Site Members`
20
+ : Name of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
21
+
22
+ `--associatedGroup [associatedGroup]`
23
+ : Type of the associated group to get. Available values: `Owner`, `Member`, `Visitor`. Use either `id`, `name` or `associatedGroup` but not multiple.
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
@@ -34,3 +37,9 @@ Get group with name _Team Site Members_ for web _https://contoso.sharepoint.com/
34
37
  ```sh
35
38
  m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --name "Team Site Members"
36
39
  ```
40
+
41
+ Get the associated owner group of a specified site
42
+
43
+ ```sh
44
+ m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --associatedGroup Owner
45
+ ```
@@ -0,0 +1,69 @@
1
+ # spo group set
2
+
3
+ Updates a group in the specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo group set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the group is located.
15
+
16
+ `-i, --id [id]`
17
+ : ID of the group to update. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : Name of the group. Specify either `id` or `name` but not both.
21
+
22
+ `--newName [newName]`
23
+ : New name for the group.
24
+
25
+ `--description [description]`
26
+ : The description for the group.
27
+
28
+ `--allowMembersEditMembership [allowMembersEditMembership]`
29
+ : Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this.
30
+
31
+ `--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
32
+ : Who can view the membership of the group? When `true` only group members can view the membership, otherwise everyone can.
33
+
34
+ `--allowRequestToJoinLeave [allowRequestToJoinLeave]`
35
+ : Specify whether to allow users to request membership in this group and allow users to request to leave the group.
36
+
37
+ `--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
38
+ : If auto-accept is enabled, users will automatically be added or removed when they make a request.
39
+
40
+ `--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
41
+ : All membership requests will be sent to the email address specified.
42
+
43
+ `--ownerEmail [ownerEmail]`
44
+ : Set user with this email as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
45
+
46
+ `--ownerUserName [ownerUserName]`
47
+ : Set user with this login name as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
48
+
49
+ --8<-- "docs/cmd/_global.md"
50
+
51
+ ## Examples
52
+
53
+ Update group title and description
54
+
55
+ ```sh
56
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --newTitle "Project leaders" --description "This group contains all project leaders"
57
+ ```
58
+
59
+ Update group with membership requests
60
+
61
+ ```sh
62
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --title "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
63
+ ```
64
+
65
+ Sets a specified user as group owner
66
+
67
+ ```sh
68
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --ownerEmail john.doe@contoso.com
69
+ ```
@@ -19,6 +19,9 @@ m365 spo hubsite get [options]
19
19
  `-u, --url [url]`
20
20
  : URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
21
21
 
22
+ `--includeAssociatedSites`
23
+ : Include the associated sites in the result (only in JSON output)
24
+
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
@@ -41,6 +44,24 @@ Get information about the hub site with URL _https://contoso.sharepoint.com/site
41
44
  m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
42
45
  ```
43
46
 
47
+ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_, including its associated sites. Associated site info is only shown in JSON output.
48
+
49
+ ```sh
50
+ m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
51
+ ```
52
+
53
+ Get information about the hub site with Title _My Hub Site_
54
+
55
+ ```sh
56
+ m365 spo hubsite get --title "My Hub Site"
57
+ ```
58
+
59
+ Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
60
+
61
+ ```sh
62
+ m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
63
+ ```
64
+
44
65
  ## More information
45
66
 
46
67
  - 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)
@@ -13,9 +13,6 @@ m365 spo list list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the lists to retrieve are located
15
15
 
16
- `--executeWithLimitedPermissions`
17
- : Use this option to execute this command with site member or visitor permissions. Not specifying this option will require site owner (or admin) permissions.
18
-
19
16
  --8<-- "docs/cmd/_global.md"
20
17
 
21
18
  ## Examples
@@ -27,6 +27,10 @@ m365 spo listitem get [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
32
+ If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
33
+
30
34
  ## Examples
31
35
 
32
36
  Get an item with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -35,9 +39,14 @@ Get an item with ID _147_ from list with title _Demo List_ in site _https://cont
35
39
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
36
40
  ```
37
41
 
38
-
39
- Get an items Title and Created column and with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Get an items _Title_ and _Created_ column with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
40
43
 
41
44
  ```sh
42
45
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
43
46
  ```
47
+
48
+ Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
49
+
50
+ ```sh
51
+ m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
52
+ ```
@@ -16,15 +16,9 @@ m365 spo listitem list [options]
16
16
  `-i, --listId [listId]`
17
17
  : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
18
18
 
19
- `--id [id]`
20
- : (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
21
-
22
19
  `-t, --listTitle [listTitle]`
23
20
  : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
24
21
 
25
- `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
27
-
28
22
  `-q, --camlQuery [camlQuery]`
29
23
  : CAML query to use to query the list of items with
30
24
 
@@ -46,6 +40,8 @@ m365 spo listitem list [options]
46
40
 
47
41
  `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
48
42
 
43
+ If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
44
+
49
45
  ## Examples
50
46
 
51
47
  Get all items from a list named Demo List
@@ -72,6 +68,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
72
68
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
73
69
  ```
74
70
 
71
+ Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
72
+
73
+ ```sh
74
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
75
+ ```
76
+
75
77
  From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
76
78
 
77
79
  ```sh
@@ -14,7 +14,7 @@ m365 spo site apppermission add [options]
14
14
  : URL of the site collection to add the permission
15
15
 
16
16
  `-p, --permission <permission>`
17
- : Permission to site (`read`, `write`, `read,write`). If multiple permissions have to be granted, they have to be comma separated ex. `read,write`
17
+ : Permission to site (`read`, `write`, or `owner`)
18
18
 
19
19
  `-i, --appId [appId]`
20
20
  : Client ID of the Azure AD app for which to grant permissions
@@ -23,7 +23,7 @@ m365 spo site apppermission set [options]
23
23
  : Display name of the Azure AD app for which to update permissions. Specify `permissionId`, `appId` or `appDisplayName`
24
24
 
25
25
  `-p, --permission <permission>`
26
- : Permission to site (`read`, `write`, `read,write`). If multiple permissions have to be granted, they have to be comma separated ex. `read,write`
26
+ : Permission to site (`read`, `write`, or `owner`)
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29