@pnp/cli-microsoft365 10.8.0-beta.cdb5c81 → 10.9.0-beta.3261443

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 (67) hide show
  1. package/.devcontainer/Dockerfile +1 -1
  2. package/Dockerfile +3 -3
  3. package/README.md +4 -2
  4. package/allCommands.json +1 -1
  5. package/allCommandsFull.json +1 -1
  6. package/dist/m365/app/commands/app-get.js +5 -2
  7. package/dist/m365/app/commands/app-open.js +9 -22
  8. package/dist/m365/app/commands/permission/permission-add.js +18 -30
  9. package/dist/m365/app/commands/permission/permission-list.js +5 -2
  10. package/dist/m365/base/AppCommand.js +9 -25
  11. package/dist/m365/booking/commands/business/business-get.js +18 -25
  12. package/dist/m365/context/commands/context-remove.js +12 -25
  13. package/dist/m365/context/commands/option/option-remove.js +11 -25
  14. package/dist/m365/entra/commands/m365group/m365group-get.js +16 -3
  15. package/dist/m365/entra/commands/m365group/m365group-list.js +7 -1
  16. package/dist/m365/entra/commands/pim/pim-role-assignment-eligibility-list.js +9 -3
  17. package/dist/m365/entra/commands/pim/pim-role-assignment-list.js +9 -3
  18. package/dist/m365/entra/commands/pim/pim-role-request-list.js +9 -3
  19. package/dist/m365/flow/commands/flow-list.js +14 -7
  20. package/dist/m365/flow/commands/run/run-get.js +1 -1
  21. package/dist/m365/graph/commands/directoryextension/directoryextension-list.js +74 -0
  22. package/dist/m365/graph/commands/subscription/subscription-add.js +10 -3
  23. package/dist/m365/graph/commands.js +1 -0
  24. package/dist/m365/pp/commands/solution/solution-publisher-list.js +8 -1
  25. package/dist/m365/purview/commands/threatassessment/threatassessment-get.js +9 -2
  26. package/dist/m365/spo/commands/file/file-move.js +8 -2
  27. package/dist/m365/spo/commands/hubsite/hubsite-get.js +14 -5
  28. package/dist/m365/spo/commands/hubsite/hubsite-list.js +9 -2
  29. package/dist/m365/spo/commands/list/list-get.js +12 -6
  30. package/dist/m365/spo/commands/page/clientsidepages.js +49 -17
  31. package/dist/m365/spo/commands/tenant/tenant-site-list.js +16 -5
  32. package/dist/m365/spo/commands/term/term-list.js +10 -3
  33. package/dist/m365/spp/commands/model/model-apply.js +130 -0
  34. package/dist/m365/spp/commands/model/model-get.js +7 -24
  35. package/dist/m365/spp/commands/model/model-list.js +1 -1
  36. package/dist/m365/spp/commands/model/model-remove.js +1 -1
  37. package/dist/m365/spp/commands.js +1 -0
  38. package/dist/m365/teams/commands/chat/chat-member-add.js +10 -4
  39. package/dist/m365/viva/commands/engage/engage-community-remove.js +99 -0
  40. package/dist/m365/viva/commands/engage/engage-network-list.js +8 -2
  41. package/dist/m365/viva/commands.js +1 -0
  42. package/dist/utils/spp.js +59 -1
  43. package/docs/docs/cmd/entra/m365group/m365group-get.mdx +8 -5
  44. package/docs/docs/cmd/entra/m365group/m365group-list.mdx +14 -12
  45. package/docs/docs/cmd/entra/pim/pim-role-assignment-eligibility-list.mdx +7 -4
  46. package/docs/docs/cmd/entra/pim/pim-role-assignment-list.mdx +9 -6
  47. package/docs/docs/cmd/entra/pim/pim-role-request-list.mdx +7 -4
  48. package/docs/docs/cmd/flow/flow-list.mdx +8 -5
  49. package/docs/docs/cmd/flow/run/run-get.mdx +1 -1
  50. package/docs/docs/cmd/graph/directoryextension/directoryextension-list.mdx +135 -0
  51. package/docs/docs/cmd/graph/subscription/subscription-add.mdx +6 -3
  52. package/docs/docs/cmd/pp/solution/solution-publisher-list.mdx +7 -4
  53. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +7 -4
  54. package/docs/docs/cmd/spo/file/file-move.mdx +4 -1
  55. package/docs/docs/cmd/spo/hubsite/hubsite-get.mdx +6 -3
  56. package/docs/docs/cmd/spo/hubsite/hubsite-list.mdx +7 -4
  57. package/docs/docs/cmd/spo/list/list-add.mdx +1 -1
  58. package/docs/docs/cmd/spo/list/list-get.mdx +12 -3
  59. package/docs/docs/cmd/spo/list/list-set.mdx +2 -2
  60. package/docs/docs/cmd/spo/tenant/tenant-site-list.mdx +10 -7
  61. package/docs/docs/cmd/spo/term/term-list.mdx +7 -4
  62. package/docs/docs/cmd/spp/model/model-apply.mdx +79 -0
  63. package/docs/docs/cmd/teams/chat/chat-member-add.mdx +6 -3
  64. package/docs/docs/cmd/viva/engage/engage-community-remove.mdx +61 -0
  65. package/docs/docs/cmd/viva/engage/engage-network-list.mdx +7 -4
  66. package/npm-shrinkwrap.json +112 -97
  67. package/package.json +14 -14
@@ -16,54 +16,56 @@ m365 entra m365group list [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-d, --displayName [displayName]`
19
- : Retrieve only groups with displayName starting with the specified value
19
+ : Retrieve only groups with displayName starting with the specified value.
20
20
 
21
21
  `-m, --mailNickname [displayName]`
22
- : Retrieve only groups with mailNickname starting with the specified value
22
+ : Retrieve only groups with mailNickname starting with the specified value.
23
23
 
24
24
  `--includeSiteUrl`
25
- : Set to retrieve the site URL for each group
25
+ : (deprecated. Use option `withSiteUrl` instead) Set to retrieve the site URL for each group.
26
+
27
+ `--withSiteUrl`
28
+ : Set to retrieve the site URL for each group.
26
29
 
27
30
  `--orphaned`
28
- : Set to only retrieve groups without owners
31
+ : Set to only retrieve groups without owners.
29
32
  ```
30
33
 
31
34
  <Global />
32
35
 
33
36
  ## Remarks
34
37
 
35
- Using the `--includeSiteUrl` option, you can retrieve the URL of the site associated with the particular Microsoft 365 Group. If you however retrieve too many groups and will try to get their site URLs, you will most likely get an error as the command will get throttled, issuing too many requests, too frequently. If you get an error, consider narrowing down the result set using the `--displayName` and `--mailNickname` filters.
38
+ Using the `--withSiteUrl` option, you can retrieve the URL of the site associated with the particular Microsoft 365 Group. If you however retrieve too many groups and will try to get their site URLs, you will most likely get an error as the command will get throttled, issuing too many requests, too frequently. If you get an error, consider narrowing down the result set using the `--displayName` and `--mailNickname` filters.
36
39
 
37
40
  Using the `--orphaned` option, you can retrieve Microsoft 365 Groups without owners.
38
41
 
39
42
  ## Examples
40
43
 
41
- List all Microsoft 365 Groups in the tenant
44
+ List all Microsoft 365 Groups in the tenant.
42
45
 
43
46
  ```sh
44
47
  m365 entra m365group list
45
48
  ```
46
49
 
47
- List Microsoft 365 Groups with display name starting with _Project_
50
+ List Microsoft 365 Groups with display name starting with _Project_.
48
51
 
49
52
  ```sh
50
53
  m365 entra m365group list --displayName Project
51
54
  ```
52
55
 
53
- List Microsoft 365 Groups mail nick name starting with _team_
56
+ List Microsoft 365 Groups mail nick name starting with _team_.
54
57
 
55
58
  ```sh
56
59
  m365 entra m365group list --mailNickname team
57
60
  ```
58
61
 
59
- List Microsoft 365 Groups with display name starting with _Project_ including
60
- the URL of the corresponding SharePoint site
62
+ List Microsoft 365 Groups with display name starting with _Project_ including the URL of the corresponding SharePoint site.
61
63
 
62
64
  ```sh
63
- m365 entra m365group list --displayName Project --includeSiteUrl
65
+ m365 entra m365group list --displayName Project --withSiteUrl
64
66
  ```
65
67
 
66
- List Microsoft 365 Groups without owners
68
+ List Microsoft 365 Groups without owners.
67
69
 
68
70
  ```sh
69
71
  m365 entra m365group list --orphaned
@@ -28,6 +28,9 @@ m365 entra pim role assignment eligibility list [options]
28
28
  : Display name of the group for which to list eligible roles. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all eligible roles will be listed.
29
29
 
30
30
  `--includePrincipalDetails`
31
+ : (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were eligible for a role.
32
+
33
+ `--withPrincipalDetails`
31
34
  : An optional flag to include details of the principals that were eligible for a role.
32
35
  ```
33
36
 
@@ -50,7 +53,7 @@ m365 entra pim role assignment eligibility list --userId '@meID'
50
53
  Get a list of eligible roles for any user with principal details.
51
54
 
52
55
  ```sh
53
- m365 entra pim role assignment eligibility list --includePrincipalDetails
56
+ m365 entra pim role assignment eligibility list --withPrincipalDetails
54
57
  ```
55
58
 
56
59
  ## Response
@@ -121,9 +124,9 @@ m365 entra pim role assignment eligibility list --includePrincipalDetails
121
124
  </TabItem>
122
125
  </Tabs>
123
126
 
124
- ### `includePrincipalDetails` response
127
+ ### `withPrincipalDetails` response
125
128
 
126
- When we make use of the option `includePrincipalDetails` the response will differ.
129
+ When we make use of the option `withPrincipalDetails` the response will differ.
127
130
 
128
131
  <Tabs>
129
132
  <TabItem value="JSON">
@@ -183,7 +186,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
183
186
  <TabItem value="Markdown">
184
187
 
185
188
  ```md
186
- # entra pim role assignment eligibility list --includePrincipalDetails "true"
189
+ # entra pim role assignment eligibility list --withPrincipalDetails "true"
187
190
 
188
191
  Date: 4/8/2024
189
192
 
@@ -31,7 +31,10 @@ m365 entra pim role assignment list [options]
31
31
  : An optional ISO 8601 formatted date filter to search from.
32
32
 
33
33
  `--includePrincipalDetails`
34
- : An optional flag to include details of the principals that were assigned a role
34
+ : (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were assigned a role.
35
+
36
+ `--withPrincipalDetails`
37
+ : An optional flag to include details of the principals that were assigned a role.
35
38
  ```
36
39
 
37
40
  <Global />
@@ -50,7 +53,7 @@ Get a list of Entra role assignments for the current user.
50
53
  m365 entra pim role assignment list --userId '@meID'
51
54
  ```
52
55
 
53
- Get a list of Entra role assignments since the first of January 2024
56
+ Get a list of Entra role assignments since the first of January 2024.
54
57
 
55
58
  ```sh
56
59
  m365 entra pim role assignment list --startDateTime 2024-01-01T00:00:00Z
@@ -59,7 +62,7 @@ m365 entra pim role assignment list --startDateTime 2024-01-01T00:00:00Z
59
62
  Get a list of Entra role assignments with principal details.
60
63
 
61
64
  ```sh
62
- m365 entra pim role assignment list --includePrincipalDetails
65
+ m365 entra pim role assignment list --withPrincipalDetails
63
66
  ```
64
67
 
65
68
  ## Response
@@ -135,9 +138,9 @@ m365 entra pim role assignment list --includePrincipalDetails
135
138
  </TabItem>
136
139
  </Tabs>
137
140
 
138
- ### `includePrincipalDetails` response
141
+ ### `withPrincipalDetails` response
139
142
 
140
- When we make use of the option `includePrincipalDetails` the response will differ.
143
+ When we make use of the option `withPrincipalDetails` the response will differ.
141
144
 
142
145
  <Tabs>
143
146
  <TabItem value="JSON">
@@ -201,7 +204,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
201
204
  <TabItem value="Markdown">
202
205
 
203
206
  ```md
204
- # entra pim role assignment list --includePrincipalDetails "true"
207
+ # entra pim role assignment list --withPrincipalDetails "true"
205
208
 
206
209
  Date: 3/31/2024
207
210
 
@@ -34,6 +34,9 @@ m365 entra pim role request list [options]
34
34
  : An optional value to filter the list of requests. Allowed values are: `Canceled`, `Denied`, `Failed`, `Granted`, `PendingAdminDecision`, `PendingApproval`, `PendingProvisioning`, `PendingScheduleCreation`, `Provisioned`, `Revoked`, and `ScheduleCreated`.
35
35
 
36
36
  `--includePrincipalDetails`
37
+ : (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were assigned a role.
38
+
39
+ `--withPrincipalDetails`
37
40
  : An optional flag to include details of the principals that were assigned a role.
38
41
  ```
39
42
 
@@ -62,7 +65,7 @@ m365 entra pim role request list --createdDateTime 2024-01-01T00:00:00Z
62
65
  Get a list of PIM requests with principal details.
63
66
 
64
67
  ```sh
65
- m365 entra pim role request list --includePrincipalDetails
68
+ m365 entra pim role request list --withPrincipalDetails
66
69
  ```
67
70
 
68
71
  Get a list of PIM requests with pending approvals.
@@ -158,9 +161,9 @@ m365 entra pim role request list --status PendingApproval
158
161
  </TabItem>
159
162
  </Tabs>
160
163
 
161
- ### `includePrincipalDetails` response
164
+ ### `withPrincipalDetails` response
162
165
 
163
- When we make use of the option `includePrincipalDetails` the response will differ.
166
+ When we make use of the option `withPrincipalDetails` the response will differ.
164
167
 
165
168
  <Tabs>
166
169
  <TabItem value="JSON">
@@ -238,7 +241,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
238
241
  <TabItem value="Markdown">
239
242
 
240
243
  ```md
241
- # entra pim role request list --includePrincipalDetails "true"
244
+ # entra pim role request list --withPrincipalDetails "true"
242
245
 
243
246
  Date: 5/30/2024
244
247
 
@@ -22,6 +22,9 @@ m365 flow list [options]
22
22
  : List a specific type of flows. Valid values: `ownedByMe`, `personal`, `sharedWithMe`, `all`. Defaults to `ownedByMe`. Don't specify this option when using asAdmin.
23
23
 
24
24
  `--includeSolutions`
25
+ : (deprecated. Use option `withSolutions` instead) Include flows from solutions.
26
+
27
+ `--withSolutions`
25
28
  : Include flows from solutions.
26
29
 
27
30
  `--asAdmin`
@@ -49,28 +52,28 @@ When you specify a value for `sharingStatus`, consider the following:
49
52
 
50
53
  ## Examples
51
54
 
52
- List all your flows in the given environment
55
+ List all your flows in the given environment.
53
56
 
54
57
  ```sh
55
58
  m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
56
59
  ```
57
60
 
58
- List all flows in the given environment
61
+ List all flows in the given environment.
59
62
 
60
63
  ```sh
61
64
  m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
62
65
  ```
63
66
 
64
- List all flows that are shared with the current user
67
+ List all flows that are shared with the current user.
65
68
 
66
69
  ```sh
67
70
  m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus sharedWithMe
68
71
  ```
69
72
 
70
- List all personal flows and include flows from solutions
73
+ List all personal flows and include flows from solutions.
71
74
 
72
75
  ```sh
73
- m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --includeSolutions
76
+ m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --withSolutions
74
77
  ```
75
78
 
76
79
  ## Response
@@ -22,7 +22,7 @@ m365 flow run get [options]
22
22
  : The name of the Power Automate flow for which to retrieve information.
23
23
 
24
24
  `-e, --environmentName <environmentName>`
25
- : The name of the environment where the flow is located
25
+ : The name of the environment where the flow is located.
26
26
 
27
27
  `--includeTriggerInformation`
28
28
  : (deprecated. Use option `withTrigger` instead) If specified, include information about the trigger details.
@@ -0,0 +1,135 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # graph directoryextension list
6
+
7
+ Retrieves a list of directory extensions
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 graph directoryextension list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `--appId [appId]`
19
+ : Application (client) ID of the Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.
20
+
21
+ `--appObjectId [appObjectId]`
22
+ : Object ID of the Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.
23
+
24
+ `--appName [appName]`
25
+ : The name of Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.
26
+ ```
27
+
28
+ <Global />
29
+
30
+ ## Remarks
31
+
32
+ When neither `appId`, `appObjectId` nor `appName` is specified, the command will return all available directory extensions including those registered for multi-tenant apps.
33
+
34
+ https://learn.microsoft.com/en-us/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0&tabs=http
35
+
36
+ Otherwise, it will return directory extensions for a specific application.
37
+
38
+ https://learn.microsoft.com/en-us/graph/api/application-list-extensionproperty?view=graph-rest-1.0&tabs=http
39
+
40
+ ## Examples
41
+
42
+ Get all available directory extensions including those registered for multi-tenant apps
43
+
44
+ ```sh
45
+ m365 graph directoryextension list
46
+ ```
47
+
48
+ Get all directory extensions registered for an application specified by app id.
49
+
50
+ ```sh
51
+ m365 graph directoryextension list --appId fd918e4b-c821-4efb-b50a-5eddd23afc6f
52
+ ```
53
+
54
+ Get all directory extensions registered for an application specified by app object id.
55
+
56
+ ```sh
57
+ m365 graph directoryextension list --appObjectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844
58
+ ```
59
+
60
+ Get all directory extensions registered for an application specified by name.
61
+
62
+ ```sh
63
+ m365 graph directoryextension list --appName ContosoApp
64
+ ```
65
+
66
+ ## Response
67
+
68
+ <Tabs>
69
+ <TabItem value="JSON">
70
+
71
+ ```json
72
+ [
73
+ {
74
+ "id": "8133c498-ad76-4a7b-90a0-675bf5adf492",
75
+ "deletedDateTime": null,
76
+ "appDisplayName": "ContosoApp",
77
+ "dataType": "String",
78
+ "isMultiValued": true,
79
+ "isSyncedFromOnPremises": false,
80
+ "name": "extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup",
81
+ "targetObjects": [
82
+ "User"
83
+ ]
84
+ }
85
+ ]
86
+ ```
87
+
88
+ </TabItem>
89
+ <TabItem value="Text">
90
+
91
+ ```text
92
+ appDisplayName : ContosoApp
93
+ dataType : String
94
+ deletedDateTime : null
95
+ id : 8133c498-ad76-4a7b-90a0-675bf5adf492
96
+ isMultiValued : true
97
+ isSyncedFromOnPremises: false
98
+ name : extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup
99
+ targetObjects : ["User"]
100
+ ```
101
+
102
+ </TabItem>
103
+ <TabItem value="CSV">
104
+
105
+ ```csv
106
+ id,deletedDateTime,appDisplayName,dataType,isMultiValued,isSyncedFromOnPremises,name
107
+ 8133c498-ad76-4a7b-90a0-675bf5adf492,,ContosoApp,String,1,0,extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup
108
+ ```
109
+
110
+ </TabItem>
111
+ <TabItem value="Markdown">
112
+
113
+ ```md
114
+ # graph directoryextension list --debug "false" --verbose "false" --appId "66eac1c5-0538-4aec-9e02-4b9e60f5e4b9"
115
+
116
+ Date: 3/23/2025
117
+
118
+ ## extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup (8133c498-ad76-4a7b-90a0-675bf5adf492)
119
+
120
+ Property | Value
121
+ ---------|-------
122
+ id | 8133c498-ad76-4a7b-90a0-675bf5adf492
123
+ appDisplayName | ContosoApp
124
+ dataType | String
125
+ isMultiValued | true
126
+ isSyncedFromOnPremises | false
127
+ name | extension\_66eac1c505384aec9e024b9e60f5e4b9\_jobGroup
128
+ ```
129
+
130
+ </TabItem>
131
+ </Tabs>
132
+
133
+ ## More information
134
+
135
+ - Directory extensions: https://learn.microsoft.com/graph/extensibility-overview#directory-microsoft-entra-id-extensions
@@ -40,13 +40,16 @@ m365 graph subscription add [options]
40
40
  : The latest version of TLS that the notification endpoint supports. Allowed values are `v1_0`, `v1_1`, `v1_2`, `v1_3`. Default is `v1_2`.
41
41
 
42
42
  `--includeResourceData`
43
+ : (deprecated. Use option `withResourceData` instead) When set, the change notifications will include the changed resource data.
44
+
45
+ `--withResourceData`
43
46
  : When set, the change notifications will include the changed resource data.
44
47
 
45
48
  `--encryptionCertificate [encryptionCertificate]`
46
- : A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `includeResourceData`.
49
+ : A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `withResourceData`.
47
50
 
48
51
  `--encryptionCertificateId [encryptionCertificateId]`
49
- : A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `includeResourceData`.
52
+ : A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `withResourceData`.
50
53
  ```
51
54
 
52
55
  <Global />
@@ -83,7 +86,7 @@ m365 graph subscription add --resource "me/mailFolders('Inbox')/messages" --chan
83
86
  Create a subscription on multiple change types and include resource data
84
87
 
85
88
  ```sh
86
- m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --includeResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
89
+ m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --withResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
87
90
  ```
88
91
 
89
92
  Create a subscription using the maximum allowed expiration for Group resources
@@ -16,10 +16,13 @@ m365 pp solution publisher list [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-e, --environmentName <environmentName>`
19
- : The name of the environment
19
+ : The name of the environment.
20
20
 
21
21
  `--includeMicrosoftPublishers`
22
- : Include the Microsoft Publishers
22
+ : (deprecated. Use option `withMicrosoftPublishers` instead) Include the Microsoft Publishers.
23
+
24
+ `--withMicrosoftPublishers`
25
+ : Include the Microsoft Publishers.
23
26
 
24
27
  `--asAdmin`
25
28
  : Run the command as admin for environments you do not have explicitly assigned permissions to.
@@ -29,13 +32,13 @@ m365 pp solution publisher list [options]
29
32
 
30
33
  ## Examples
31
34
 
32
- List all publishers in a specific environment
35
+ List all publishers in a specific environment.
33
36
 
34
37
  ```sh
35
38
  m365 pp solution publisher list --environmentName "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
36
39
  ```
37
40
 
38
- List all publishers in a specific environment as Admin
41
+ List all publishers in a specific environment as Admin.
39
42
 
40
43
  ```sh
41
44
  m365 pp solution publisher list --environmentName "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
@@ -19,6 +19,9 @@ m365 purview threatassessment get [options]
19
19
  : The Id of the threat assessment.
20
20
 
21
21
  `--includeResults`
22
+ : (deprecated. Use option `withResults` instead) Include the threat assessment results.
23
+
24
+ `--withResults`
22
25
  : Include the threat assessment results.
23
26
  ```
24
27
 
@@ -35,7 +38,7 @@ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e
35
38
  Get a threat assessment including results.
36
39
 
37
40
  ```sh
38
- m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --includeResults
41
+ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --withResults
39
42
  ```
40
43
 
41
44
  ## Response
@@ -118,9 +121,9 @@ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --in
118
121
  </TabItem>
119
122
  </Tabs>
120
123
 
121
- ### `includeResults` response
124
+ ### `withResults` response
122
125
 
123
- When we make use of the option `includeResults` the response will differ.
126
+ When we make use of the option `withResults` the response will differ.
124
127
 
125
128
  <Tabs>
126
129
  <TabItem value="JSON">
@@ -184,7 +187,7 @@ When we make use of the option `includeResults` the response will differ.
184
187
  <TabItem value="Markdown">
185
188
 
186
189
  ```md
187
- # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731" --includeResults "true"
190
+ # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731" --withResults "true"
188
191
 
189
192
  Date: 25/02/2023
190
193
 
@@ -34,6 +34,9 @@ m365 spo file move [options]
34
34
  : Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
35
35
 
36
36
  `--includeItemPermissions`
37
+ : (deprecated. Use option `withItemPermissions` instead) Ensure that item-level permissions are preserved during the move.
38
+
39
+ `--withItemPermissions`
37
40
  : Ensure that item-level permissions are preserved during the move.
38
41
 
39
42
  `--bypassSharedLock`
@@ -75,7 +78,7 @@ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sou
75
78
  Move a file referenced by its ID to another document library and retain item-level permissions.
76
79
 
77
80
  ```sh
78
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/My Documents" --includeItemPermissions
81
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/My Documents" --withItemPermissions
79
82
  ```
80
83
 
81
84
  ## Response
@@ -25,6 +25,9 @@ m365 spo hubsite get [options]
25
25
  : URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
26
26
 
27
27
  `--includeAssociatedSites`
28
+ : (deprecated. Use option `withAssociatedSites` instead) Include the associated sites in the result (only in JSON output).
29
+
30
+ `--withAssociatedSites`
28
31
  : Include the associated sites in the result (only in JSON output)
29
32
  ```
30
33
 
@@ -53,7 +56,7 @@ m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
53
56
  Get information about the hub site with specific ID, including its associated sites. Associated site info is only shown in JSON output.
54
57
 
55
58
  ```sh
56
- m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
59
+ m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --withAssociatedSites --output json
57
60
  ```
58
61
 
59
62
  ## Response
@@ -147,9 +150,9 @@ m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociat
147
150
  </TabItem>
148
151
  </Tabs>
149
152
 
150
- ### `includeAssociatedSites` response
153
+ ### `withAssociatedSites` response
151
154
 
152
- When we make use of the option `includeAssociatedSites` the response will differ. This command can only be executed using --output json or an error will be thrown.
155
+ When we make use of the option `withAssociatedSites` the response will differ. This command can only be executed using --output json or an error will be thrown.
153
156
 
154
157
  <Tabs>
155
158
  <TabItem value="JSON">
@@ -16,6 +16,9 @@ m365 spo hubsite list [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-i, --includeAssociatedSites`
19
+ : (deprecated. Use option `withAssociatedSites` instead) Include the associated sites in the result (only in JSON output).
20
+
21
+ `--withAssociatedSites`
19
22
  : Include the associated sites in the result (only in JSON output).
20
23
  ```
21
24
 
@@ -36,7 +39,7 @@ m365 spo hubsite list
36
39
  List hub sites, including their associated sites, in the current tenant. Associated site info is only shown in JSON output.
37
40
 
38
41
  ```sh
39
- m365 spo hubsite list --includeAssociatedSites --output json
42
+ m365 spo hubsite list --withAssociatedSites --output json
40
43
  ```
41
44
 
42
45
  ## Response
@@ -119,9 +122,9 @@ m365 spo hubsite list --includeAssociatedSites --output json
119
122
  </TabItem>
120
123
  </Tabs>
121
124
 
122
- ### `includeAssociatedSites` response
125
+ ### `withAssociatedSites` response
123
126
 
124
- When we make use of the option `includeAssociatedSites` the response will differ.
127
+ When we make use of the option `withAssociatedSites` the response will differ.
125
128
 
126
129
  <Tabs>
127
130
  <TabItem value="JSON">
@@ -176,7 +179,7 @@ When we make use of the option `includeAssociatedSites` the response will differ
176
179
  <TabItem value="Markdown">
177
180
 
178
181
  ```md
179
- # spo hubsite list --includeAssociatedSites "true"
182
+ # spo hubsite list --withAssociatedSites "true"
180
183
 
181
184
  Date: 2/20/2023
182
185
 
@@ -127,7 +127,7 @@ m365 spo list add [options]
127
127
  : Boolean value that specifies whether the list is hidden. Valid values are `true`, `false`.
128
128
 
129
129
  `--includedInMyFilesScope [includedInMyFilesScope]`
130
- : Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string myfiles by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
130
+ : Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string "myfiles" by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
131
131
 
132
132
  `--irmEnabled [irmEnabled]`
133
133
  : Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.
@@ -19,13 +19,16 @@ m365 spo list get [options]
19
19
  : URL of the site where the list to retrieve is located.
20
20
 
21
21
  `-i, --id [id]`
22
- : ID of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.
22
+ : ID of the list to retrieve information for. Specify either `id`, `title`,`url` or `default` but not multiple.
23
23
 
24
24
  `-t, --title [title]`
25
- : Title of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.
25
+ : Title of the list to retrieve information for. Specify either `id`, `title`,`url` or `default` but not multiple.
26
26
 
27
27
  `--url [url]`
28
- : Server- or site-relative URL of the list. Specify either `id`, `title`, or `url` but not multiple.
28
+ : Server- or site-relative URL of the list. Specify either `id`, `title`,`url` or `default` but not multiple.
29
+
30
+ `--default`
31
+ : Set to retrieve the default list from the site. Specify either `id`, `title`, `url`, or `default` but not multiple.
29
32
 
30
33
  `-p, --properties [properties]`
31
34
  : Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
@@ -42,6 +45,12 @@ When the `properties` option includes values with a `/`, for example: `ListItemA
42
45
 
43
46
  ## Examples
44
47
 
48
+ Get the default document library located in the specified site.
49
+
50
+ ```sh
51
+ m365 spo list get --webUrl https://contoso.sharepoint.com/sites/project-x --default
52
+ ```
53
+
45
54
  Get information about a list with specified ID located in the specified site.
46
55
 
47
56
  ```sh
@@ -14,7 +14,7 @@ m365 spo list set [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site
17
+ : URL of the site.
18
18
 
19
19
  `--id [id]`
20
20
  : ID of the list. Specify either `id`, `title`, or `url` but not multiple.
@@ -128,7 +128,7 @@ m365 spo list set [options]
128
128
  : Boolean value that specifies whether the list is hidden. Valid values are `true`, `false`.
129
129
 
130
130
  `--includedInMyFilesScope [includedInMyFilesScope]`
131
- : Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string myfiles by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
131
+ : Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string "myfiles" by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
132
132
 
133
133
  `--irmEnabled [irmEnabled]`
134
134
  : Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.