@pnp/cli-microsoft365 7.9.0-beta.bd3bb30 → 7.9.0-beta.c7bc5b8

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 (40) hide show
  1. package/.eslintrc.cjs +2 -0
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/m365/base/DelegatedGraphCommand.js +17 -0
  5. package/dist/m365/base/PowerAppsCommand.js +2 -0
  6. package/dist/m365/base/PowerAutomateCommand.js +2 -0
  7. package/dist/m365/base/PowerBICommand.js +10 -0
  8. package/dist/m365/base/PowerPlatformCommand.js +2 -0
  9. package/dist/m365/base/VivaEngageCommand.js +10 -0
  10. package/dist/m365/commands/commands.js +1 -0
  11. package/dist/m365/commands/search.js +176 -0
  12. package/dist/m365/entra/commands/group/group-user-set.js +206 -0
  13. package/dist/m365/entra/commands/user/user-groupmembership-list.js +92 -0
  14. package/dist/m365/entra/commands/user/user-list.js +47 -44
  15. package/dist/m365/entra/commands.js +2 -0
  16. package/dist/m365/outlook/commands/message/message-move.js +2 -2
  17. package/dist/m365/spfx/commands/spfx-doctor.js +2 -2
  18. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +44 -23
  19. package/dist/m365/teams/commands/chat/chat-message-send.js +2 -2
  20. package/dist/m365/todo/commands/list/list-add.js +2 -2
  21. package/dist/m365/todo/commands/list/list-get.js +2 -2
  22. package/dist/m365/todo/commands/list/list-list.js +2 -2
  23. package/dist/m365/todo/commands/list/list-remove.js +2 -2
  24. package/dist/m365/todo/commands/list/list-set.js +2 -2
  25. package/dist/m365/todo/commands/task/task-add.js +2 -2
  26. package/dist/m365/todo/commands/task/task-get.js +2 -2
  27. package/dist/m365/todo/commands/task/task-list.js +2 -2
  28. package/dist/m365/todo/commands/task/task-remove.js +2 -2
  29. package/dist/m365/todo/commands/task/task-set.js +2 -2
  30. package/dist/m365/viva/commands/engage/engage-community-get.js +49 -0
  31. package/dist/m365/viva/commands.js +1 -0
  32. package/dist/utils/accessToken.js +16 -0
  33. package/dist/utils/validation.js +3 -3
  34. package/docs/docs/cmd/entra/group/group-user-set.mdx +62 -0
  35. package/docs/docs/cmd/entra/user/user-groupmembership-list.mdx +121 -0
  36. package/docs/docs/cmd/entra/user/user-list.mdx +24 -9
  37. package/docs/docs/cmd/search.mdx +260 -0
  38. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +3 -11
  39. package/docs/docs/cmd/viva/engage/engage-community-get.mdx +94 -0
  40. package/package.json +1 -1
@@ -0,0 +1,121 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra user groupmembership list
6
+
7
+ Retrieves all groups where the user is a member of
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra user groupmembership list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-i, --userId [userId]`
19
+ : The ID of the user to retrieve information for. Use either `userId`, `userName` or `userEmail`, but not multiple.
20
+
21
+ `-n, --userName [userName]`
22
+ : The name of the user to retrieve information for. Use either `userId`, `userName` or `userEmail`, but not multiple.
23
+
24
+ `-e, --userEmail [userEmail]`
25
+ : The email of the user to retrieve information for. Use either `userId`, `userName` or `userEmail`, but not multiple.
26
+
27
+ `--securityEnabledOnly [securityEnabledOnly]`
28
+ : Specifies that only security-enabled groups that the user is a member of should be returned
29
+ ```
30
+
31
+ <Global />
32
+
33
+ ## Examples
34
+
35
+ Retrieves groups that the user is a member of
36
+
37
+ ```sh
38
+ m365 entra user groupmembership list --userId '1caf7dcd-7e83-4c3a-94f7-932a1299c844'
39
+ ```
40
+
41
+ Retrieves only security groups that the user is a member of
42
+
43
+ ```sh
44
+ m365 entra user groupmembership list --userName 'john.doe@contoso.com' --securityEnabledOnly
45
+ ```
46
+
47
+ Retrieves groups where the currently logged user is a member of
48
+
49
+ ```sh
50
+ m365 entra user groupmembership list --userId '@meId'
51
+ ```
52
+
53
+ Retrieves groups where the currently logged user is a member of
54
+
55
+ ```sh
56
+ m365 entra user groupmembership list --userName '@meUserName'
57
+ ```
58
+
59
+ ## Response
60
+
61
+ <Tabs>
62
+ <TabItem value="JSON">
63
+
64
+ ```json
65
+ [
66
+ {
67
+ "groupId": "01b62bc5-9701-4f93-9587-9d1ea58a086d"
68
+ },
69
+ {
70
+ "groupId": "619701a2-4bdc-494a-a9dd-9d3aeebcafd9"
71
+ },
72
+ {
73
+ "groupId": "ec98d904-ac8c-49f0-99e1-c9c0e1a1e453"
74
+ }
75
+ ]
76
+ ```
77
+
78
+ </TabItem>
79
+ <TabItem value="Text">
80
+
81
+ ```text
82
+ groupId
83
+ ------------------------------------
84
+ 01b62bc5-9701-4f93-9587-9d1ea58a086d
85
+ 619701a2-4bdc-494a-a9dd-9d3aeebcafd9
86
+ ec98d904-ac8c-49f0-99e1-c9c0e1a1e453
87
+ ```
88
+
89
+ </TabItem>
90
+ <TabItem value="CSV">
91
+
92
+ ```csv
93
+ groupId
94
+ 01b62bc5-9701-4f93-9587-9d1ea58a086d
95
+ 619701a2-4bdc-494a-a9dd-9d3aeebcafd9
96
+ ec98d904-ac8c-49f0-99e1-c9c0e1a1e453
97
+ ```
98
+
99
+ </TabItem>
100
+ <TabItem value="Markdown">
101
+
102
+ ```md
103
+ # entra user groupmembership list --userId "1f5595b2-aa07-445d-9801-a45ea18160b2"
104
+
105
+ Date: 5/17/2024
106
+
107
+ Property | Value
108
+ ---------|-------
109
+ groupId | 01b62bc5-9701-4f93-9587-9d1ea58a086d
110
+
111
+ Property | Value
112
+ ---------|-------
113
+ groupId | 619701a2-4bdc-494a-a9dd-9d3aeebcafd9
114
+
115
+ Property | Value
116
+ ---------|-------
117
+ groupId | ec98d904-ac8c-49f0-99e1-c9c0e1a1e453
118
+ ```
119
+
120
+ </TabItem>
121
+ </Tabs>
@@ -32,7 +32,7 @@ m365 aad user list [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will retrieve user's display name, account name, id, and mail.
35
+ Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will output the default properties returned by Graph.
36
36
 
37
37
  When the `properties` option includes values with a `/`, for example: `manager/displayName`, an additional `$expand` query parameter will be included on `manager`.
38
38
 
@@ -86,10 +86,19 @@ m365 entra user list --properties "displayName,mail,manager/*"
86
86
  ```json
87
87
  [
88
88
  {
89
- "id": "1f5595b2-aa07-445d-9801-a45ea18160b2",
89
+ "businessPhones": [
90
+ "+32 456 789 123"
91
+ ],
90
92
  "displayName": "John Doe",
93
+ "givenName": "John",
94
+ "jobTitle": "Sales Manager",
91
95
  "mail": "John@contoso.onmicrosoft.com",
92
- "userPrincipalName": "John@contoso.onmicrosoft.com"
96
+ "mobilePhone": "+32 456 789 123",
97
+ "officeLocation": "Antwerp",
98
+ "preferredLanguage": "nl-BE",
99
+ "surname": "Doe",
100
+ "userPrincipalName": "John@contoso.onmicrosoft.com",
101
+ "id": "ef0d4f29-e359-4443-a15d-bc3dccc8143f"
93
102
  }
94
103
  ]
95
104
  ```
@@ -98,17 +107,17 @@ m365 entra user list --properties "displayName,mail,manager/*"
98
107
  <TabItem value="Text">
99
108
 
100
109
  ```text
101
- id displayName mail userPrincipalName
102
- ------------------------------------ ------------------ ----------------------------------- ------------------------------------------
103
- 1f5595b2-aa07-445d-9801-a45ea18160b2 John Doe John@contoso.onmicrosoft.com John@contoso.onmicrosoft.com
110
+ id displayName mail userPrincipalName
111
+ ------------------------------------ ----------- ---------------------------- ----------------------------
112
+ ef0d4f29-e359-4443-a15d-bc3dccc8143f John Doe John@contoso.onmicrosoft.com John@contoso.onmicrosoft.com
104
113
  ```
105
114
 
106
115
  </TabItem>
107
116
  <TabItem value="CSV">
108
117
 
109
118
  ```csv
110
- id,displayName,mail,userPrincipalName
111
- 1f5595b2-aa07-445d-9801-a45ea18160b2,John Doe,John@contoso.onmicrosoft.com,John@contoso.onmicrosoft.com
119
+ displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
120
+ John Doe,John,Sales Manager,John@contoso.onmicrosoft.com,+32 456 789 123,Antwerp,nl-BE,Doe,John@contoso.onmicrosoft.com,ef0d4f29-e359-4443-a15d-bc3dccc8143f
112
121
  ```
113
122
 
114
123
  </TabItem>
@@ -123,10 +132,16 @@ m365 entra user list --properties "displayName,mail,manager/*"
123
132
 
124
133
  Property | Value
125
134
  ---------|-------
126
- id | 1f5595b2-aa07-445d-9801-a45ea18160b2
127
135
  displayName | John Doe
136
+ givenName | John
137
+ jobTitle | Sales Manager
128
138
  mail | John@contoso.onmicrosoft.com
139
+ mobilePhone | +32 456 789 123
140
+ officeLocation | Antwerp
141
+ preferredLanguage | nl-BE
142
+ surname | Doe
129
143
  userPrincipalName | John@contoso.onmicrosoft.com
144
+ id | 1f5595b2-aa07-445d-9801-a45ea18160b2
130
145
  ```
131
146
 
132
147
  </TabItem>
@@ -0,0 +1,260 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # search
6
+
7
+ Uses the Microsoft Search to query Microsoft 365 data
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 search [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-q, --queryText [queryText]`
19
+ : Query to be executed in Keyword Query Language (KQL) format.
20
+
21
+ `-s, --scopes <scopes>`
22
+ : Comma-separated list of scopes for the search request. Allowed values are `chatMessage`, `message`, `event`, `drive`, `driveItem`, `list`, `listItem`, `site`, `bookmark`, `acronym`, or `person`.
23
+
24
+ `--startIndex [startIndex]`
25
+ : Set the number that indicates the 0-based starting point to list search results on the page. The default value is 0.
26
+
27
+ `--pageSize [pageSize]`
28
+ : Set the number that indicates the number of results to be returned for a page. The default is 25 results. The maximum is 500 results.
29
+
30
+ `--allResults`
31
+ : Set to get all search results from all pages.
32
+
33
+ `--resultsOnly`
34
+ : Set to get only the results form the query response.
35
+
36
+ `--enableTopResults`
37
+ : Use to get the first three messages in the response are sorted by relevance. Use this option only when scopes is set to message type.
38
+
39
+ `--select [select]`
40
+ : Comma-separated list of properties to return in the search results.
41
+
42
+ `--sortBy [sortBy]`
43
+ : Comma-separated list of properties to sort search results.
44
+
45
+ `--enableSpellingSuggestion`
46
+ : Set to get the suggested spelling correction information for typos in the user query.
47
+
48
+ `--enableSpellingModification`
49
+ : Set to get the search results for the corrected query when there are no results for the original query with typos, and get the corresponding correction information.
50
+ ```
51
+
52
+ <Global />
53
+
54
+ ## Remarks
55
+
56
+ The `queryText` option supports [Keyword Query Language](https://learn.microsoft.com/graph/api/resources/search-api-overview#keyword-query-language-kql-support) (KQL).
57
+
58
+ The `sortBy` option allows to specify the order. By default, the order is ascending. If you want to apply descending order, add `:desc` to the property name, like `createdDateTime:desc`.
59
+
60
+ ## Examples
61
+
62
+ Queries messages in the current user mailbox that contain the string "contoso" in any part of the message (the sender name, subject, message body, or any attachments). The query returns the first 100 results.
63
+
64
+ ```sh
65
+ m365 search --scopes 'message' --queryText 'contoso' --pageSize 100
66
+ ```
67
+
68
+ Queries list items and sites that contain the string "accountt" and requests a spelling modification for the query.
69
+
70
+ ```sh
71
+ m365 search --scopes 'listItem, site' --queryText 'accountt' --enableSpellingSuggestion --enableSpellingModification
72
+ ```
73
+
74
+ Search for file report.xlsl in specific folder of user personal OneDrive
75
+
76
+ ```sh
77
+ m365 search --scopes 'driveItem' --queryText 'filename:report.xlsl AND path:\"https://contoso-my.sharepoint.com/personal/john.doe_contoso_com/Documents/Reports/2024\"'
78
+ ```
79
+
80
+ Search for all sites
81
+
82
+ ```sh
83
+ m365 search --scopes 'site' --queryText 'site:\"https://contoso-my.sharepoint.com/personal/*\"'
84
+ ```
85
+
86
+ ## Response
87
+
88
+ ### Standard response
89
+
90
+ <Tabs>
91
+ <TabItem value="JSON">
92
+
93
+ ```json
94
+ {
95
+ "searchTerms": [
96
+ "openapi"
97
+ ],
98
+ "hitsContainers": [
99
+ {
100
+ "hits": [
101
+ {
102
+ "hitId": "012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC",
103
+ "rank": 1,
104
+ "summary": "<ddd/><c0>OpenAPI</c0> Specification v3.1.0 | Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>",
105
+ "resource": {
106
+ "@odata.type": "#microsoft.graph.driveItem",
107
+ "size": 2980854,
108
+ "fileSystemInfo": {
109
+ "createdDateTime": "2023-11-18T20:26:55Z",
110
+ "lastModifiedDateTime": "2023-11-18T10:10:10Z"
111
+ },
112
+ "listItem": {
113
+ "@odata.type": "#microsoft.graph.listItem",
114
+ "fields": {},
115
+ "id": "5a85c2cd-4b8c-487b-8d01-5368795edf50"
116
+ },
117
+ "id": "012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC",
118
+ "createdBy": {
119
+ "user": {
120
+ "displayName": "John Doe",
121
+ "email": "john.doe@contoso.onmicrosoft.com"
122
+ }
123
+ },
124
+ "createdDateTime": "2023-11-18T20:26:55Z",
125
+ "lastModifiedBy": {
126
+ "user": {
127
+ "displayName": "John Doe",
128
+ "email": "john.doe@contoso.onmicrosoft.com"
129
+ }
130
+ },
131
+ "lastModifiedDateTime": "2023-11-18T10:10:10Z",
132
+ "name": "OpenAPI_spec.pdf",
133
+ "parentReference": {
134
+ "driveId": "b!j_Me8ql9502cTAMB_abcdefabcdefabcdefabcdefMPe9GMre9LSYBTqeitDmsf9gu",
135
+ "id": "01LDCVMA6EMNPM3RRBTVFLSNVCPEJCKWQL",
136
+ "sharepointIds": {
137
+ "listId": "abc52111-d6ab-ab12-cd34-de85ab63ab41",
138
+ "listItemId": "5",
139
+ "listItemUniqueId": "5a85c2cd-4b8c-487b-8d01-5368795edf50"
140
+ },
141
+ "siteId": "contoso.sharepoint.com,f21ef38f-4de7-7da9-0301-9c4cfe485e53,574a2bbe-e791-75cc-1234-5a0b4cbd3def"
142
+ },
143
+ "webUrl": "https://contoso.sharepoint.com/sites/knowledgebase/Shared Documents/OpenAPI_spec.pdf"
144
+ }
145
+ }
146
+ ],
147
+ "total": 1,
148
+ "moreResultsAvailable": false
149
+ }
150
+ ]
151
+ }
152
+ ```
153
+
154
+ </TabItem>
155
+ <TabItem value="Text">
156
+
157
+ ```text
158
+ hitsContainers: [{"hits":[{"hitId":"012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC","rank":1,"summary":"<ddd/><c0>OpenAPI</c0> Specification v3.1.0 | Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>","resource":{"@odata.type":"#microsoft.graph.driveItem","size":2980854,"fileSystemInfo":{"createdDateTime":"2023-11-18T20:26:55Z","lastModifiedDateTime":"2023-11-18T10:10:10Z"},"listItem":{"@odata.type":"#microsoft.graph.listItem","fields":{},"id":"5a85c2cd-4b8c-487b-8d01-5368795edf50"},"id":"012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC","createdBy":{"user":{"displayName":"John Doe","email":"john.doe@contoso.onmicrosoft.com"}},"createdDateTime":"2023-11-18T20:26:55Z","lastModifiedBy":{"user":{"displayName":"John Doe","email":"john.doe@contoso.onmicrosoft.com"}},"lastModifiedDateTime":"2023-11-18T10:10:10Z","name":"OpenAPI_spec.pdf","parentReference":{"driveId":"b!j_Me8ql9502cTAMB_abcdefabcdefabcdefabcdefMPe9GMre9LSYBTqeitDmsf9gu","id":"01LDCVMA6EMNPM3RRBTVFLSNVCPEJCKWQL","sharepointIds":{"listId":"abc52111-d6ab-ab12-cd34-de85ab63ab41","listItemId":"5","listItemUniqueId":"5a85c2cd-4b8c-487b-8d01-5368795edf50"},"siteId":"contoso.sharepoint.com,f21ef38f-4de7-7da9-0301-9c4cfe485e53,574a2bbe-e791-75cc-1234-5a0b4cbd3def"},"webUrl":"https://contoso.sharepoint.com/sites/knowledgebase/Shared Documents/OpenAPI_spec.pdf"}}],"total":1,"moreResultsAvailable":false}]
159
+ searchTerms : ["openapi"]
160
+ ```
161
+
162
+ </TabItem>
163
+ </Tabs>
164
+
165
+ ### With `resultsOnly` response
166
+
167
+ When we make use of the option `resultsOnly` the response will differ.
168
+
169
+ <Tabs>
170
+ <TabItem value="JSON">
171
+
172
+ ```json
173
+ [
174
+ {
175
+ "hitId": "012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC",
176
+ "rank": 1,
177
+ "summary": "<ddd/><c0>OpenAPI</c0> Specification v3.1.0 | Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>",
178
+ "resource": {
179
+ "@odata.type": "#microsoft.graph.driveItem",
180
+ "size": 2980854,
181
+ "fileSystemInfo": {
182
+ "createdDateTime": "2023-11-18T20:26:55Z",
183
+ "lastModifiedDateTime": "2023-11-18T10:10:10Z"
184
+ },
185
+ "listItem": {
186
+ "@odata.type": "#microsoft.graph.listItem",
187
+ "fields": {},
188
+ "id": "5a85c2cd-4b8c-487b-8d01-5368795edf50"
189
+ },
190
+ "id": "012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC",
191
+ "createdBy": {
192
+ "user": {
193
+ "displayName": "John Doe",
194
+ "email": "john.doe@contoso.onmicrosoft.com"
195
+ }
196
+ },
197
+ "createdDateTime": "2023-11-18T20:26:55Z",
198
+ "lastModifiedBy": {
199
+ "user": {
200
+ "displayName": "John Doe",
201
+ "email": "john.doe@contoso.onmicrosoft.com"
202
+ }
203
+ },
204
+ "lastModifiedDateTime": "2023-11-18T10:10:10Z",
205
+ "name": "OpenAPI_spec.pdf",
206
+ "parentReference": {
207
+ "driveId": "b!j_Me8ql9502cTAMB_abcdefabcdefabcdefabcdefMPe9GMre9LSYBTqeitDmsf9gu",
208
+ "id": "01LDCVMA6EMNPM3RRBTVFLSNVCPEJCKWQL",
209
+ "sharepointIds": {
210
+ "listId": "abc52111-d6ab-ab12-cd34-de85ab63ab41",
211
+ "listItemId": "5",
212
+ "listItemUniqueId": "5a85c2cd-4b8c-487b-8d01-5368795edf50"
213
+ },
214
+ "siteId": "contoso.sharepoint.com,f21ef38f-4de7-7da9-0301-9c4cfe485e53,574a2bbe-e791-75cc-1234-5a0b4cbd3def"
215
+ },
216
+ "webUrl": "https://contoso.sharepoint.com/sites/knowledgebase/Shared Documents/OpenAPI_spec.pdf"
217
+ }
218
+ }
219
+ ]
220
+ ```
221
+
222
+ </TabItem>
223
+ <TabItem value="Text">
224
+
225
+ ```text
226
+ hitId : 012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC
227
+ rank : 1
228
+ resource: {"@odata.type":"#microsoft.graph.driveItem","size":2980854,"fileSystemInfo":{"createdDateTime":"2023-11-18T20:26:55Z","lastModifiedDateTime":"2023-11-18T10:10:10Z"},"listItem":{"@odata.type":"#microsoft.graph.listItem","fields":{},"id":"5a85c2cd-4b8c-487b-8d01-5368795edf50"},"id":"012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC","createdBy":{"user":{"displayName":"John Doe","email":"john.doe@contoso.onmicrosoft.com"}},"createdDateTime":"2023-11-18T20:26:55Z","lastModifiedBy":{"user":{"displayName":"John Doe","email":"john.doe@contoso.onmicrosoft.com"}},"lastModifiedDateTime":"2023-11-18T10:10:10Z","name":"OpenAPI_spec.pdf","parentReference":{"driveId":"b!j_Me8ql9502cTAMB_abcdefabcdefabcdefabcdefMPe9GMre9LSYBTqeitDmsf9gu","id":"01LDCVMA6EMNPM3RRBTVFLSNVCPEJCKWQL","sharepointIds":{"listId":"abc52111-d6ab-ab12-cd34-de85ab63ab41","listItemId":"5","listItemUniqueId":"5a85c2cd-4b8c-487b-8d01-5368795edf50"},"siteId":"contoso.sharepoint.com,f21ef38f-4de7-7da9-0301-9c4cfe485e53,574a2bbe-e791-75cc-1234-5a0b4cbd3def"},"webUrl":"https://contoso.sharepoint.com/sites/knowledgebase/Shared Documents/OpenAPI_spec.pdf"}
229
+ summary : <ddd/><c0>OpenAPI</c0> Specification v3.1.0 | Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>
230
+ ```
231
+
232
+ </TabItem>
233
+ <TabItem value="CSV">
234
+
235
+ ```md
236
+ hitId,rank,summary
237
+ 012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC,1,"<ddd/><c0>OpenAPI</c0> Specification v3.1.0 | Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>"
238
+ ```
239
+
240
+ </TabItem>
241
+ <TabItem value="Markdown">
242
+
243
+ ```md
244
+ # search --scopes "driveItem" --queryString "OpenAPI" --resultsOnly "true"
245
+
246
+ Date: 3/3/2024
247
+
248
+ Property | Value
249
+ ---------|-------
250
+ hitId | 012Q4A6LPNNYLDCVMEI2KCVAKTNBV5XVDC
251
+ rank | 1
252
+ summary | <ddd/><c0>OpenAPI</c0> Specification v3.1.0 \| Introduction, Definitions, & More https://spec.openapis.org<ddd/><c0>OpenAPI</c0> Specification v3.1.0 Version 3.1.0 Published 15 February 2021 Latest editor's <ddd/>
253
+ ```
254
+
255
+ </TabItem>
256
+ </Tabs>
257
+
258
+ ## More information
259
+
260
+ - Use the Microsoft Search API to query data: https://learn.microsoft.com/graph/api/resources/search-api-overview
@@ -16,21 +16,19 @@ m365 spo tenant recyclebinitem restore [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-u, --siteUrl <siteUrl>`
19
- : URL of the site to restore
19
+ : URL of the site.
20
20
 
21
21
  `--wait`
22
- : Wait for the site collection to be restored before completing the command
22
+ : (deprecated) Wait for the site collection to be restored before completing the command.
23
23
  ```
24
24
 
25
25
  <Global />
26
26
 
27
27
  ## Remarks
28
28
 
29
- Restoring deleted site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully restored, you should use the `--wait` flag. When using this flag, the `spo tenant recyclebinitem restore` command will keep running until it received confirmation from Microsoft 365 that the site has been fully restored.
30
-
31
29
  :::info
32
30
 
33
- To use this command you have to have permissions to access the tenant admin site.
31
+ To use this command you must be a Global or SharePoint administrator.
34
32
 
35
33
  :::
36
34
 
@@ -42,12 +40,6 @@ Restore a deleted site collection from tenant recycle bin
42
40
  m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/sites/team
43
41
  ```
44
42
 
45
- Restore a deleted site collection from tenant recycle bin and wait for completion
46
-
47
- ```sh
48
- m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/sites/team --wait
49
- ```
50
-
51
43
  ## Response
52
44
 
53
45
  <Tabs>
@@ -0,0 +1,94 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # viva engage community get
6
+
7
+ Gets information of a Viva Engage community
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 viva engage community get [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-i, --id <id>`
19
+ : The unique identifier of the community.
20
+ ```
21
+
22
+ <Global />
23
+
24
+ ## Remarks
25
+
26
+ :::warning
27
+
28
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
29
+
30
+ :::
31
+
32
+ ## Examples
33
+
34
+ Get a specific community by ID.
35
+
36
+ ```sh
37
+ m365 viva engage community get --id eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0Mjg1NzkwNjE3NyJ9
38
+ ```
39
+
40
+ ## Response
41
+
42
+ <Tabs>
43
+ <TabItem value="JSON">
44
+
45
+ ```json
46
+ {
47
+ "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ",
48
+ "displayName": "New Employee Onboarding",
49
+ "description": "New Employee Onboarding",
50
+ "privacy": "public",
51
+ "groupId": "54dda9b2-2df1-4ce8-ae1e-b400956b5b34"
52
+ }
53
+ ```
54
+
55
+ </TabItem>
56
+ <TabItem value="Text">
57
+
58
+ ```text
59
+ description: New Employee Onboarding
60
+ displayName: New Employee Onboarding
61
+ groupId : 54dda9b2-2df1-4ce8-ae1e-b400956b5b34
62
+ id : eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ
63
+ privacy : public
64
+ ```
65
+
66
+ </TabItem>
67
+ <TabItem value="CSV">
68
+
69
+ ```csv
70
+ id,displayName,description,privacy,groupId
71
+ eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ,New Employee Onboarding,New Employee Onboarding,public,54dda9b2-2df1-4ce8-ae1e-b400956b5b34
72
+ ```
73
+
74
+ </TabItem>
75
+ <TabItem value="Markdown">
76
+
77
+ ```md
78
+ # viva engage community get --id "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ"
79
+
80
+ Date: 14/03/2024
81
+
82
+ ## New Employee Onboarding (eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ)
83
+
84
+ Property | Value
85
+ ---------|-------
86
+ id | eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxNTU1MjcwOTQyNzIifQ
87
+ displayName | New Employee Onboarding
88
+ description | New Employee Onboarding
89
+ privacy | public
90
+ groupId | 54dda9b2-2df1-4ce8-ae1e-b400956b5b34
91
+ ```
92
+
93
+ </TabItem>
94
+ </Tabs>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "7.9.0-beta.bd3bb30",
3
+ "version": "7.9.0-beta.c7bc5b8",
4
4
  "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
5
5
  "license": "MIT",
6
6
  "main": "./dist/api.js",