@pnp/cli-microsoft365 7.0.0-beta.68abdfc → 7.0.0-beta.68fea7b

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 (107) hide show
  1. package/dist/Command.js +1 -1
  2. package/dist/cli/Cli.js +23 -8
  3. package/dist/m365/aad/commands/user/user-get.js +7 -1
  4. package/dist/m365/booking/commands/business/business-get.js +14 -15
  5. package/dist/m365/cli/commands/config/config-set.js +1 -1
  6. package/dist/m365/pa/commands/app/app-owner-set.js +115 -0
  7. package/dist/m365/pa/commands/app/app-permission-list.js +104 -0
  8. package/dist/m365/pa/commands.js +2 -0
  9. package/dist/m365/planner/commands/bucket/bucket-add.js +14 -10
  10. package/dist/m365/planner/commands/bucket/bucket-get.js +25 -19
  11. package/dist/m365/planner/commands/bucket/bucket-list.js +14 -10
  12. package/dist/m365/planner/commands/bucket/bucket-remove.js +26 -20
  13. package/dist/m365/planner/commands/bucket/bucket-set.js +26 -28
  14. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +19 -17
  15. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +19 -17
  16. package/dist/m365/search/commands/externalconnection/externalconnection-remove.js +35 -34
  17. package/dist/m365/spfx/commands/project/project-externalize/rules/DynamicRule.js +59 -51
  18. package/dist/m365/spo/commands/folder/folder-remove.js +30 -28
  19. package/dist/m365/spo/commands/list/list-roleassignment-add.js +9 -47
  20. package/dist/m365/spo/commands/page/page-remove.js +33 -31
  21. package/dist/m365/spo/commands/roledefinition/roledefinition-remove.js +25 -23
  22. package/dist/m365/spo/commands/site/site-apppermission-add.js +3 -3
  23. package/dist/m365/spo/commands/site/site-commsite-enable.js +9 -18
  24. package/dist/m365/spo/commands/site/site-set.js +10 -2
  25. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +13 -16
  26. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-set.js +80 -2
  27. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +48 -48
  28. package/dist/m365/spo/commands/theme/theme-get.js +1 -2
  29. package/dist/m365/teams/commands/chat/chat-get.js +4 -4
  30. package/dist/m365/teams/commands/chat/chat-member-add.js +117 -0
  31. package/dist/m365/teams/commands/chat/chat-message-send.js +4 -4
  32. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  33. package/dist/m365/teams/commands.js +1 -0
  34. package/dist/utils/spo.js +74 -0
  35. package/docs/docs/_clisettings.mdx +1 -1
  36. package/docs/docs/cmd/_global.mdx +1 -1
  37. package/docs/docs/cmd/aad/user/user-get.mdx +118 -25
  38. package/docs/docs/cmd/pa/app/app-owner-set.mdx +60 -0
  39. package/docs/docs/cmd/pa/app/app-permission-list.mdx +132 -0
  40. package/docs/docs/cmd/planner/bucket/bucket-add.mdx +21 -4
  41. package/docs/docs/cmd/planner/bucket/bucket-get.mdx +22 -5
  42. package/docs/docs/cmd/planner/bucket/bucket-list.mdx +21 -4
  43. package/docs/docs/cmd/planner/bucket/bucket-remove.mdx +21 -4
  44. package/docs/docs/cmd/planner/bucket/bucket-set.mdx +22 -5
  45. package/docs/docs/cmd/spo/site/site-add.mdx +35 -0
  46. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +5 -1
  47. package/docs/docs/cmd/spo/site/site-appcatalog-list.mdx +14 -0
  48. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +4 -0
  49. package/docs/docs/cmd/spo/site/site-apppermission-add.mdx +68 -0
  50. package/docs/docs/cmd/spo/site/site-apppermission-get.mdx +55 -0
  51. package/docs/docs/cmd/spo/site/site-apppermission-list.mdx +55 -0
  52. package/docs/docs/cmd/spo/site/site-apppermission-remove.mdx +4 -0
  53. package/docs/docs/cmd/spo/site/site-apppermission-set.mdx +66 -0
  54. package/docs/docs/cmd/spo/site/site-chrome-set.mdx +4 -0
  55. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +11 -1
  56. package/docs/docs/cmd/spo/site/site-ensure.mdx +70 -0
  57. package/docs/docs/cmd/spo/site/site-get.mdx +179 -0
  58. package/docs/docs/cmd/spo/site/site-groupify.mdx +54 -0
  59. package/docs/docs/cmd/spo/site/site-hubsite-connect.mdx +4 -0
  60. package/docs/docs/cmd/spo/site/site-hubsite-disconnect.mdx +4 -0
  61. package/docs/docs/cmd/spo/site/site-hubsite-theme-sync.mdx +5 -1
  62. package/docs/docs/cmd/spo/site/site-inplacerecordsmanagement-set.mdx +4 -0
  63. package/docs/docs/cmd/spo/site/site-list.mdx +303 -0
  64. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +80 -0
  65. package/docs/docs/cmd/spo/site/site-recyclebinitem-restore.mdx +4 -0
  66. package/docs/docs/cmd/spo/site/site-remove.mdx +4 -0
  67. package/docs/docs/cmd/spo/site/site-rename.mdx +92 -0
  68. package/docs/docs/cmd/spo/site/site-set.mdx +13 -0
  69. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.mdx +116 -0
  70. package/docs/docs/cmd/spo/sitedesign/sitedesign-apply.mdx +125 -0
  71. package/docs/docs/cmd/spo/sitedesign/sitedesign-get.mdx +117 -0
  72. package/docs/docs/cmd/spo/sitedesign/sitedesign-list.mdx +94 -0
  73. package/docs/docs/cmd/spo/sitedesign/sitedesign-remove.mdx +4 -0
  74. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-grant.mdx +4 -0
  75. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-list.mdx +54 -0
  76. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-revoke.mdx +4 -0
  77. package/docs/docs/cmd/spo/sitedesign/sitedesign-run-list.mdx +66 -0
  78. package/docs/docs/cmd/spo/sitedesign/sitedesign-run-status-get.mdx +65 -0
  79. package/docs/docs/cmd/spo/sitedesign/sitedesign-set.mdx +117 -0
  80. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-get.mdx +61 -0
  81. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-list.mdx +60 -0
  82. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-remove.mdx +4 -0
  83. package/docs/docs/cmd/spo/sitescript/sitescript-add.mdx +75 -0
  84. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +62 -0
  85. package/docs/docs/cmd/spo/sitescript/sitescript-list.mdx +60 -0
  86. package/docs/docs/cmd/spo/sitescript/sitescript-remove.mdx +4 -0
  87. package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +63 -0
  88. package/docs/docs/cmd/spo/storageentity/storageentity-get.mdx +53 -0
  89. package/docs/docs/cmd/spo/storageentity/storageentity-list.mdx +54 -0
  90. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +4 -0
  91. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +4 -0
  92. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +4 -0
  93. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +35 -0
  94. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +12 -3
  95. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +67 -0
  96. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +4 -0
  97. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +50 -0
  98. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +729 -0
  99. package/docs/docs/cmd/spo/tenant/tenant-settings-set.mdx +5 -0
  100. package/docs/docs/cmd/spo/theme/theme-apply.mdx +35 -0
  101. package/docs/docs/cmd/spo/theme/theme-get.mdx +74 -0
  102. package/docs/docs/cmd/spo/theme/theme-list.mdx +52 -0
  103. package/docs/docs/cmd/spo/theme/theme-remove.mdx +4 -0
  104. package/docs/docs/cmd/spo/theme/theme-set.mdx +4 -0
  105. package/docs/docs/cmd/teams/chat/chat-member-add.mdx +66 -0
  106. package/npm-shrinkwrap.json +212 -212
  107. package/package.json +10 -10
@@ -0,0 +1,60 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # pa app owner set
6
+
7
+ Sets a new owner for a Power Apps app
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 pa app owner set [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-e, --environmentName <environmentName>`
19
+ : The name of the environment.
20
+
21
+ `--appName <appName>`
22
+ : The name (GUID) of the Microsoft Power App.
23
+
24
+ `--userId [userId]`
25
+ : The Azure AD ID of the new owner. Specify either `userId` or `userName` but not both.
26
+
27
+ `--userName [userName]`
28
+ : The user principal name of the new owner. Specify either `userId` or `userName` but not both.
29
+
30
+ `--roleForOldAppOwner [roleForOldAppOwner]`
31
+ : Grant permissions for the previous owner. Allowed values: `CanView`, `CanEdit`. Don't specify a value to remove the previous owner from the app.
32
+ ```
33
+
34
+ <Global />
35
+
36
+ ## Remarks
37
+
38
+ :::info
39
+
40
+ To use this command you must be a Global or Power Platform admin.
41
+
42
+ :::
43
+
44
+ ## Examples
45
+
46
+ Set a new owner for a Power Apps app and make the previous owner co-owner
47
+
48
+ ```sh
49
+ m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userId c6ee6ed4-0172-4fdc-87a3-cfd9c324de1d --roleForOldAppOwner CanEdit
50
+ ```
51
+
52
+ Set a new owner for a Power Apps app and remove the previous owner
53
+
54
+ ```sh
55
+ m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userName john.doe@contoso.com
56
+ ```
57
+
58
+ ## Response
59
+
60
+ The command won't return a response on success.
@@ -0,0 +1,132 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # pa app permission list
6
+
7
+ Lists all permissions of a Power Apps app
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 pa app permission list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `--appName <appName>`
19
+ : The name (GUID) of the Microsoft Power App.
20
+
21
+ `--roleName [roleName]`
22
+ : Filter the results to only a given role: `Owner`, `CanEdit`, `CanView`.
23
+
24
+ `--asAdmin`
25
+ : Run the command as admin for apps you don't own.
26
+
27
+ `-e, --environmentName [environmentName]`
28
+ : The name of the environment. Required when using `asAdmin`.
29
+ ```
30
+
31
+ <Global />
32
+
33
+ ## Remarks
34
+
35
+ When you specify a value for `roleName`, consider the following:
36
+
37
+ - `Owner` shows all the owners of the application.
38
+ - `CanEdit` shows all the co-owners of the application.
39
+ - `CanView` shows all the users with run only permissions.
40
+
41
+ ## Examples
42
+
43
+ List all permissions for an app you have access to
44
+
45
+ ```sh
46
+ m365 pa app permission list --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0
47
+ ```
48
+
49
+ List all permissions as admin for an app you don't have access to
50
+
51
+ ```sh
52
+ m365 pa app permission list --environmentName "Default-e448e34a-40cc-441a-94c6-ec701a9a9ec2" --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --asAdmin
53
+ ```
54
+
55
+ List all co-owners for an app you have access to
56
+
57
+ ```sh
58
+ m365 pa app permission list --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --roleName CanEdit
59
+ ```
60
+
61
+ ## Response
62
+
63
+ <Tabs>
64
+ <TabItem value="JSON">
65
+
66
+ ```json
67
+ [
68
+ {
69
+ "name": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
70
+ "id": "/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a",
71
+ "type": "Microsoft.PowerApps/apps/permissions",
72
+ "properties": {
73
+ "roleName": "Owner",
74
+ "principal": {
75
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
76
+ "displayName": "John Doe",
77
+ "email": "john@contoso.com",
78
+ "type": "User",
79
+ "tenantId": "e1dd4023-a656-480a-8a0e-c1b1eec51e1d"
80
+ },
81
+ "scope": "/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb",
82
+ "notifyShareTargetOption": "NotSpecified",
83
+ "inviteGuestToTenant": false,
84
+ "createdOn": "2022-10-25T21:28:14.2122305Z",
85
+ "createdBy": "f0db9c91-3dae-49c8-98fa-8059b8909d45"
86
+ },
87
+ "roleName": "Owner",
88
+ "principalId": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
89
+ "principalType": "User"
90
+ }
91
+ ]
92
+ ```
93
+
94
+ </TabItem>
95
+ <TabItem value="Text">
96
+
97
+ ```text
98
+ roleName principalId principalType
99
+ -------- ------------------------------------ -------------
100
+ Owner fe36f75e-c103-410b-a18a-2bf6df06ac3a User
101
+ ```
102
+
103
+ </TabItem>
104
+ <TabItem value="CSV">
105
+
106
+ ```csv
107
+ name,id,type,roleName,principalId,principalType
108
+ fe36f75e-c103-410b-a18a-2bf6df06ac3a,/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a,Microsoft.PowerApps/apps/permissions,Owner,fe36f75e-c103-410b-a18a-2bf6df06ac3a,User
109
+ ```
110
+
111
+ </TabItem>
112
+ <TabItem value="Markdown">
113
+
114
+ ```md
115
+ # pa app permission list --appName "37ea6004-f07b-46ca-8ef3-a256b67b4dbb"
116
+
117
+ Date: 25/06/2023
118
+
119
+ ## fe36f75e-c103-410b-a18a-2bf6df06ac3a (/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
120
+
121
+ Property | Value
122
+ ---------|-------
123
+ name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
124
+ id | /providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a
125
+ type | Microsoft.PowerApps/apps/permissions
126
+ roleName | Owner
127
+ principalId | fe36f75e-c103-410b-a18a-2bf6df06ac3a
128
+ principalType | User
129
+ ```
130
+
131
+ </TabItem>
132
+ </Tabs>
@@ -19,10 +19,13 @@ m365 planner bucket add [options]
19
19
  : Name of the bucket to add.
20
20
 
21
21
  `--planId [planId]`
22
- : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
22
+ : ID of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
23
23
 
24
24
  `--planTitle [planTitle]`
25
- : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
25
+ : Title of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
+
27
+ `--rosterId [rosterId]`
28
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
29
 
27
30
  `--ownerGroupId [ownerGroupId]`
28
31
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -36,20 +39,34 @@ m365 planner bucket add [options]
36
39
 
37
40
  <Global />
38
41
 
42
+ ## Remarks
43
+
44
+ :::caution
45
+
46
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
47
+
48
+ :::
49
+
39
50
  ## Examples
40
51
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the ID _xqQg5FS2LkCp935s-FIFm2QAFkHM_ with order hint
52
+ Adds a Microsoft Planner bucket for a plan based on its ID with an order hint
42
53
 
43
54
  ```sh
44
55
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
45
56
  ```
46
57
 
47
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
58
+ Adds a Microsoft Planner bucket for a plan based on its title and owner group name
48
59
 
49
60
  ```sh
50
61
  m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
51
62
  ```
52
63
 
64
+ Adds a Microsoft Planner bucket for a plan based on its Planner Roster ID
65
+
66
+ ```sh
67
+ m365 planner bucket add --name "My Planner Bucket" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
68
+ ```
69
+
53
70
  ## Response
54
71
 
55
72
  <Tabs>
@@ -22,10 +22,13 @@ m365 planner bucket get [options]
22
22
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
23
23
 
24
24
  `--planId [planId]`
25
- : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
25
+ : ID of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
26
26
 
27
27
  `--planTitle [planTitle]`
28
- : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
28
+ : Title of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
29
+
30
+ `--rosterId [rosterId]`
31
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
29
32
 
30
33
  `--ownerGroupId [ownerGroupId]`
31
34
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -36,6 +39,14 @@ m365 planner bucket get [options]
36
39
 
37
40
  <Global />
38
41
 
42
+ ## Remarks
43
+
44
+ :::caution
45
+
46
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
47
+
48
+ :::
49
+
39
50
  ## Examples
40
51
 
41
52
  Gets the specified Microsoft Planner bucket
@@ -44,24 +55,30 @@ Gets the specified Microsoft Planner bucket
44
55
  m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
45
56
  ```
46
57
 
47
- Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
58
+ Gets the Microsoft Planner bucket based on its plan ID
48
59
 
49
60
  ```sh
50
61
  m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
51
62
  ```
52
63
 
53
- Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
64
+ Gets the Microsoft Planner bucket based on its plan title and owner group name
54
65
 
55
66
  ```sh
56
67
  m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
57
68
  ```
58
69
 
59
- Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
70
+ Gets the Microsoft Planner bucket based on its plan title and owner group ID
60
71
 
61
72
  ```sh
62
73
  m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
63
74
  ```
64
75
 
76
+ Gets the Microsoft Planner bucket based on its Roster ID
77
+
78
+ ```sh
79
+ m365 planner bucket get --name "Planner Bucket A" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
80
+ ```
81
+
65
82
  ## Response
66
83
 
67
84
  <Tabs>
@@ -16,10 +16,13 @@ m365 planner bucket list [options]
16
16
 
17
17
  ```md definition-list
18
18
  `--planId [planId]`
19
- : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
19
+ : ID of the plan to list the buckets of. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
20
20
 
21
21
  `--planTitle [planTitle]`
22
- : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
22
+ : Title of the plan to list the buckets of. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
23
+
24
+ `--rosterId [rosterId]`
25
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
23
26
 
24
27
  `--ownerGroupId [ownerGroupId]`
25
28
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -30,20 +33,34 @@ m365 planner bucket list [options]
30
33
 
31
34
  <Global />
32
35
 
36
+ ## Remarks
37
+
38
+ :::caution
39
+
40
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
41
+
42
+ :::
43
+
33
44
  ## Examples
34
45
 
35
- Lists the Microsoft Planner buckets in the Plan _xqQg5FS2LkCp935s-FIFm2QAFkHM_
46
+ Lists the Microsoft Planner buckets based on its plan ID
36
47
 
37
48
  ```sh
38
49
  m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
39
50
  ```
40
51
 
41
- Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
52
+ Lists the Microsoft Planner buckets based on its plan title and owner group name
42
53
 
43
54
  ```sh
44
55
  m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
45
56
  ```
46
57
 
58
+ Lists the Microsoft Planner buckets based on its Roster ID
59
+
60
+ ```sh
61
+ m365 planner bucket list --planTitle "My Plan" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
62
+ ```
63
+
47
64
  ## Response
48
65
 
49
66
  <Tabs>
@@ -20,10 +20,13 @@ m365 planner bucket remove [options]
20
20
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
21
21
 
22
22
  `--planId [planId]`
23
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
23
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
24
24
 
25
25
  `--planTitle [planTitle]`
26
- : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
26
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
27
+
28
+ `--rosterId [rosterId]`
29
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
27
30
 
28
31
  `--ownerGroupId [ownerGroupId]`
29
32
  : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -37,6 +40,14 @@ m365 planner bucket remove [options]
37
40
 
38
41
  <Global />
39
42
 
43
+ ## Remarks
44
+
45
+ :::caution
46
+
47
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
48
+
49
+ :::
50
+
40
51
  ## Examples
41
52
 
42
53
  Removes the Microsoft Planner bucket by ID
@@ -51,18 +62,24 @@ Removes the Microsoft Planner bucket by ID without confirmation
51
62
  m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz" --force
52
63
  ```
53
64
 
54
- Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
65
+ Removes the Microsoft Planner bucket by its name based on the plan ID
55
66
 
56
67
  ```sh
57
68
  m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
58
69
  ```
59
70
 
60
- Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
71
+ Removes the Microsoft Planner bucket by its name based on the plan title and owner group name
61
72
 
62
73
  ```sh
63
74
  m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
64
75
  ```
65
76
 
77
+ Removes the Microsoft Planner bucket by its name based on the Roster ID
78
+
79
+ ```sh
80
+ m365 planner bucket remove --name "My Bucket" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
81
+ ```
82
+
66
83
  ## Response
67
84
 
68
85
  The command won't return a response on success.
@@ -20,10 +20,13 @@ m365 planner bucket set [options]
20
20
  : Name of the bucket. Specify either `id` or `name` but not both.
21
21
 
22
22
  `--planId [planId]`
23
- : ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
23
+ : ID of the plan to update the bucket of. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
24
24
 
25
25
  `--planTitle [planTitle]`
26
- : 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`.
26
+ : Title of the plan to update the bucket of. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
27
+
28
+ `--rosterId [rosterId]`
29
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
27
30
 
28
31
  `--ownerGroupId [ownerGroupId]`
29
32
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -40,26 +43,40 @@ m365 planner bucket set [options]
40
43
 
41
44
  <Global />
42
45
 
46
+ ## Remarks
47
+
48
+ :::caution
49
+
50
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
51
+
52
+ :::
53
+
43
54
  ## Examples
44
55
 
45
- Updates the Microsoft Planner bucket with ID _vncYUXCRBke28qMLB-d4xJcACtNz_
56
+ Updates the Microsoft Planner bucket by its ID
46
57
 
47
58
  ```sh
48
59
  m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucket name"
49
60
  ```
50
61
 
51
- Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
62
+ Updates the Microsoft Planner bucket with a given name based on its plan title and owner group name
52
63
 
53
64
  ```sh
54
65
  m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
55
66
  ```
56
67
 
57
- Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
68
+ Updates the Microsoft Planner bucket with a given name based on its plan title and owner group ID
58
69
 
59
70
  ```sh
60
71
  m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
61
72
  ```
62
73
 
74
+ Updates the Microsoft Planner bucket with a given name based on its Roster ID
75
+
76
+ ```sh
77
+ m365 planner bucket set --name "My Bucket" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI" --newName "New bucket name"
78
+ ```
79
+
63
80
  ## Response
64
81
 
65
82
  The command won't return a response on success.
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo site add
4
6
 
@@ -178,6 +180,39 @@ Create new classic site collection using the Team site template. Set time zone t
178
180
  m365 spo site add --type ClassicSite --url https://contoso.sharepoint.com/sites/team --title Team --owners admin@contoso.onmicrosoft.com --timeZone 4 --webTemplate STS#0 --removeDeletedSite --wait
179
181
  ```
180
182
 
183
+ ## Response
184
+
185
+ <Tabs>
186
+ <TabItem value="JSON">
187
+
188
+ ```json
189
+ "https://contoso.sharepoint.com/sites/marketing"
190
+ ```
191
+
192
+ </TabItem>
193
+ <TabItem value="Text">
194
+
195
+ ```text
196
+ https://contoso.sharepoint.com/sites/marketing
197
+ ```
198
+
199
+ </TabItem>
200
+ <TabItem value="CSV">
201
+
202
+ ```csv
203
+ https://contoso.sharepoint.com/sites/marketing
204
+ ```
205
+
206
+ </TabItem>
207
+ <TabItem value="Markdown">
208
+
209
+ ```md
210
+ https://contoso.sharepoint.com/sites/marketing
211
+ ```
212
+
213
+ </TabItem>
214
+ </Tabs>
215
+
181
216
  ## More information
182
217
 
183
218
  - Creating SharePoint Communication Site using REST: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/communication-site-creation-rest](https://docs.microsoft.com/en-us/sharepoint/dev/apis/communication-site-creation-rest)
@@ -32,9 +32,13 @@ To use this command you have to have permissions to access the tenant admin site
32
32
  Add a site collection app catalog to the specified site
33
33
 
34
34
  ```sh
35
- m365 spo site appcatalog add --siteUrl https://contoso.sharepoint/sites/site
35
+ m365 spo site appcatalog add --siteUrl https://contoso.sharepoint.com/sites/site
36
36
  ```
37
37
 
38
+ ## Response
39
+
40
+ The command won't return a response on success.
41
+
38
42
  ## More information
39
43
 
40
44
  - Use the site collection app catalog: [https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog)
@@ -64,6 +64,20 @@ m365 spo site appcatalog list
64
64
  https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
65
65
  ```
66
66
 
67
+ </TabItem>
68
+ <TabItem value="Markdown">
69
+
70
+ ```md
71
+ # spo site appcatalog list
72
+
73
+ Date: 2023-06-21
74
+
75
+ Property | Value
76
+ ---------|-------
77
+ AbsoluteUrl | https://contoso.sharepoint.com/sites/site1
78
+ SiteID | 9798e615-b586-455e-8486-84913f492c49
79
+ ```
80
+
67
81
  </TabItem>
68
82
  </Tabs>
69
83
 
@@ -37,6 +37,10 @@ Remove the site collection app catalog from specified site
37
37
  m365 spo site appcatalog remove --siteUrl https://contoso.sharepoint/sites/site
38
38
  ```
39
39
 
40
+ ## Response
41
+
42
+ The command won't return a response on success.
43
+
40
44
  ## More information
41
45
 
42
46
  - Use the site collection app catalog: [https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog)
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo site apppermission add
4
6
 
@@ -39,3 +41,69 @@ Grants the specified app the _read_ permission to site _https://contoso.sharepoi
39
41
  ```sh
40
42
  m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/project-x --permission read --appDisplayName Foo
41
43
  ```
44
+
45
+ ## Response
46
+
47
+ <Tabs>
48
+ <TabItem value="JSON">
49
+
50
+ ```json
51
+ {
52
+ "id": "aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0",
53
+ "roles": [
54
+ "read"
55
+ ],
56
+ "grantedToIdentitiesV2": [
57
+ {
58
+ "application": {
59
+ "displayName": "Foo",
60
+ "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
61
+ }
62
+ }
63
+ ],
64
+ "grantedToIdentities": [
65
+ {
66
+ "application": {
67
+ "displayName": "Foo",
68
+ "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
69
+ }
70
+ }
71
+ ]
72
+ }
73
+ ```
74
+
75
+ </TabItem>
76
+ <TabItem value="Text">
77
+
78
+ ```text
79
+ grantedToIdentities : [{"application":{"displayName":"Foo","id":"5c89fbbf-670e-48e7-a0bc-fa8942c895a2"}}]
80
+ grantedToIdentitiesV2: [{"application":{"displayName":"Foo","id":"5c89fbbf-670e-48e7-a0bc-fa8942c895a2"}}]
81
+ id : aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0
82
+ roles : ["read"]
83
+ ```
84
+
85
+ </TabItem>
86
+ <TabItem value="CSV">
87
+
88
+ ```csv
89
+ id
90
+ aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0
91
+ ```
92
+
93
+ </TabItem>
94
+ <TabItem value="Markdown">
95
+
96
+ ```md
97
+ # spo site apppermission add --siteUrl "https://contoso.sharepoint.com/sites/team1" --permission "read" --appDisplayName "Foo"
98
+
99
+ Date: 2023-06-21
100
+
101
+ ## aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0
102
+
103
+ Property | Value
104
+ ---------|-------
105
+ id | aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0
106
+ ```
107
+
108
+ </TabItem>
109
+ </Tabs>