@pnp/cli-microsoft365 5.4.0-beta.fdd7cb1 → 5.5.0-beta.3b0d087

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 (123) hide show
  1. package/dist/Auth.js +3 -3
  2. package/dist/Command.js +22 -0
  3. package/dist/m365/aad/commands/app/app-set.js +4 -1
  4. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-remove.js +129 -0
  5. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  6. package/dist/m365/aad/commands.js +1 -0
  7. package/dist/m365/base/PowerAppsCommand.js +10 -0
  8. package/dist/m365/flow/commands/flow-export.js +3 -0
  9. package/dist/m365/pa/commands/app/app-get.js +3 -5
  10. package/dist/m365/pa/commands/app/app-list.js +10 -9
  11. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  12. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  13. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  14. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  15. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  16. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  17. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  18. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  19. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  20. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  21. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  22. package/dist/m365/planner/commands/plan/plan-get.js +58 -17
  23. package/dist/m365/planner/commands/plan/plan-remove.js +141 -0
  24. package/dist/m365/planner/commands/task/task-add.js +73 -24
  25. package/dist/m365/planner/commands/task/task-checklistitem-list.js +53 -0
  26. package/dist/m365/planner/commands/task/task-checklistitem-remove.js +85 -0
  27. package/dist/m365/planner/commands/task/task-get.js +14 -9
  28. package/dist/m365/planner/commands/task/task-list.js +19 -11
  29. package/dist/m365/planner/commands/task/task-reference-add.js +1 -7
  30. package/dist/m365/planner/commands/task/task-reference-remove.js +122 -0
  31. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  32. package/dist/m365/planner/commands/task/task-set.js +34 -24
  33. package/dist/m365/planner/commands/tenant/tenant-settings-set.js +95 -0
  34. package/dist/m365/planner/commands.js +6 -1
  35. package/dist/m365/planner/taskPriority.js +27 -0
  36. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  37. package/dist/m365/search/commands.js +1 -0
  38. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.15.0.js +23 -0
  39. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  40. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  41. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.15.0-rc.0.js → upgrade-1.15.0.js} +34 -32
  42. package/dist/m365/spfx/commands/project/project-upgrade.js +13 -15
  43. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  44. package/dist/m365/spo/base-permissions.js +9 -0
  45. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  46. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  47. package/dist/m365/spo/commands/field/field-set.js +16 -9
  48. package/dist/m365/spo/commands/group/group-add.js +96 -0
  49. package/dist/m365/spo/commands/group/group-set.js +167 -0
  50. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  51. package/dist/m365/spo/commands/hubsite/hubsite-list.js +1 -1
  52. package/dist/m365/spo/commands/list/ListPrincipalType.js +13 -0
  53. package/dist/m365/spo/commands/list/list-get.js +6 -0
  54. package/dist/m365/spo/commands/list/list-list.js +10 -1
  55. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  56. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  57. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  58. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  59. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  60. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  61. package/dist/m365/spo/commands/site/site-classic-list.js +1 -0
  62. package/dist/m365/spo/commands/site/site-classic-set.js +1 -0
  63. package/dist/m365/spo/commands/site/site-list.js +59 -17
  64. package/dist/m365/spo/commands/site/site-set.js +322 -162
  65. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  66. package/dist/m365/spo/commands.js +3 -0
  67. package/dist/m365/teams/commands/cache/cache-remove.js +155 -0
  68. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  69. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  70. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  71. package/dist/m365/teams/commands.js +1 -0
  72. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  73. package/dist/utils/accessToken.js +18 -0
  74. package/dist/utils/planner.js +9 -8
  75. package/dist/utils/validation.js +5 -1
  76. package/docs/docs/cmd/aad/app/app-set.md +1 -1
  77. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-remove.md +45 -0
  78. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  79. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  80. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  81. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  82. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  83. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  84. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  85. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  86. package/docs/docs/cmd/planner/plan/plan-get.md +14 -2
  87. package/docs/docs/cmd/planner/plan/plan-remove.md +48 -0
  88. package/docs/docs/cmd/planner/task/task-add.md +51 -12
  89. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +24 -0
  90. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +36 -0
  91. package/docs/docs/cmd/planner/task/task-get.md +17 -8
  92. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  93. package/docs/docs/cmd/planner/task/task-reference-remove.md +39 -0
  94. package/docs/docs/cmd/planner/task/task-set.md +20 -7
  95. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +56 -0
  96. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  97. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  98. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  99. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  100. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  101. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  102. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  103. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  104. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +1 -4
  105. package/docs/docs/cmd/spo/list/list-list.md +3 -0
  106. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  107. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  108. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  109. package/docs/docs/cmd/spo/site/site-classic-list.md +3 -0
  110. package/docs/docs/cmd/spo/site/site-classic-set.md +3 -0
  111. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  112. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  113. package/docs/docs/cmd/teams/cache/cache-remove.md +46 -0
  114. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  115. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  116. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  117. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +1 -1
  118. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +1 -1
  119. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +1 -1
  120. package/npm-shrinkwrap.json +175 -160
  121. package/package.json +13 -13
  122. package/dist/m365/planner/commands/plan/plan-details-get.js +0 -116
  123. package/docs/docs/cmd/planner/plan/plan-details-get.md +0 -45
@@ -0,0 +1,39 @@
1
+ # planner task reference remove
2
+
3
+ Removes the reference from the Planner task.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task reference remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --url [url]`
14
+ : URL location of the reference. Specify either `alias` or `url` but not both.
15
+
16
+ `--alias [alias]`
17
+ : The alias of the reference. Specify either `alias` or `url` but not both.
18
+
19
+ `-i, --taskId <taskId>`
20
+ : ID of the task.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirmation
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Removes a reference with the url _https://www.microsoft.com_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
30
+
31
+ ```sh
32
+ m365 planner task reference remove --url "https://www.microsoft.com" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
33
+ ```
34
+
35
+ Removes a reference with the alias _Parker_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
36
+
37
+ ```sh
38
+ m365 planner task reference remove --alias "Parker" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
39
+ ```
@@ -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`
@@ -61,16 +64,26 @@ m365 planner task set [options]
61
64
  `--appliedCategories [appliedCategories]`
62
65
  : Comma-separated categories that should be added to the task
63
66
 
67
+ `--priority [priority]`
68
+ : Priority of the task: Urgent, Important, Medium, Low. Or an integer between 0 and 10 (check remarks section for more info).
69
+
64
70
  --8<-- "docs/cmd/_global.md"
65
71
 
66
72
  ## Remarks
67
73
 
68
- When you specify the value for `percentageComplete`, consider the following:
74
+ When you specify the value for `percentComplete`, consider the following:
69
75
 
70
76
  - when set to 0, the task is considered _Not started_
71
77
  - when set between 1 and 99, the task is considered _In progress_
72
78
  - when set to 100, the task is considered _Completed_
73
79
 
80
+ When you specify an integer value for `priority`, consider the following:
81
+
82
+ - values 0 and 1 are interpreted as _Urgent_
83
+ - values 2, 3 and 4 are interpreted as _Important_
84
+ - values 5, 6 and 7 are interpreted as _Medium_
85
+ - values 8, 9 and 10 are interpreted as _Low_
86
+
74
87
  You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
75
88
 
76
89
  ## Examples
@@ -81,10 +94,10 @@ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the
81
94
  m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
82
95
  ```
83
96
 
84
- Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
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_
85
98
 
86
99
  ```sh
87
- 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"
88
101
  ```
89
102
 
90
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
+ ```
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.14.0). If you specify the `preview` option without a specific version, the command will upgrade your project to the latest preview version v1.15.0-rc.0.
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.15.0).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -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)
@@ -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,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
+ ```
@@ -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
+ ```
@@ -10,17 +10,19 @@ 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"
16
+ `-t, --title [title]`
17
+ : Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
17
18
 
18
- ## Remarks
19
+ `-u, --url [url]`
20
+ : URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
19
21
 
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.
22
+ `--includeAssociatedSites`
23
+ : Include the associated sites in the result (only in JSON output)
22
24
 
23
- If the specified `id` doesn't refer to an existing hub site, you will get a `ResourceNotFoundException` error.
25
+ --8<-- "docs/cmd/_global.md"
24
26
 
25
27
  ## Examples
26
28
 
@@ -30,6 +32,36 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
30
32
  m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
31
33
  ```
32
34
 
35
+ Get information about the hub site with Title _My Hub Site_
36
+
37
+ ```sh
38
+ m365 spo hubsite get --title 'My Hub Site'
39
+ ```
40
+
41
+ Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
42
+
43
+ ```sh
44
+ m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
45
+ ```
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
+
33
65
  ## More information
34
66
 
35
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)
@@ -17,10 +17,7 @@ m365 spo hubsite list [options]
17
17
 
18
18
  ## Remarks
19
19
 
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.
22
-
23
- When using the text output type (default), the command lists only the values of the `ID`, `SiteUrl` and `Title` properties of the hub site. When setting the output type to JSON, all available properties are included in the command output.
20
+ When using the text or csv output type, the command lists only the values of the `ID`, `SiteUrl` and `Title` properties of the hub site. With the output type as JSON, all available properties are included in the command output.
24
21
 
25
22
  ## Examples
26
23
 
@@ -13,6 +13,9 @@ 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
+
16
19
  --8<-- "docs/cmd/_global.md"
17
20
 
18
21
  ## 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
+ ```
@@ -46,6 +46,8 @@ m365 spo listitem list [options]
46
46
 
47
47
  `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
48
48
 
49
+ If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
50
+
49
51
  ## Examples
50
52
 
51
53
  Get all items from a list named Demo List
@@ -72,6 +74,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
72
74
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
73
75
  ```
74
76
 
77
+ 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_
78
+
79
+ ```sh
80
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
81
+ ```
82
+
75
83
  From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
76
84
 
77
85
  ```sh
@@ -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
+ ```
@@ -24,6 +24,9 @@ m365 spo site classic list [options]
24
24
  !!! important
25
25
  To use this command you have to have permissions to access the tenant admin site.
26
26
 
27
+ !!! important
28
+ This command is deprecated. Please use [spo site list](./site-list.md) instead.
29
+
27
30
  ## Remarks
28
31
 
29
32
  Using the `-t, --webTemplate` option you can specify which sites you want to retrieve. For example, to get sites with the `STS#0` as their web template, use `--webTemplate STS#0` as the option.
@@ -54,6 +54,9 @@ m365 spo site classic set [options]
54
54
  !!! important
55
55
  To use this command you have to have permissions to access the tenant admin site.
56
56
 
57
+ !!! important
58
+ This command is deprecated. Please use [spo site set](./site-set.md) instead.
59
+
57
60
  ## Remarks
58
61
 
59
62
  The value of the `--resourceQuota` option must not exceed the company's aggregate available Sandboxed Solutions quota. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010: [http://msdn.microsoft.com/en-us/library/gg615462.aspx](http://msdn.microsoft.com/en-us/library/gg615462.aspx).