@pnp/cli-microsoft365 10.0.0-beta.303b62c → 10.0.0-beta.558f289

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 (16) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/m365/spo/commands/folder/folder-sharinglink-set.js +90 -0
  4. package/dist/m365/spo/commands/tenant/SPOTenantSitePropertiesEnumerable.js +2 -0
  5. package/dist/m365/spo/commands/tenant/TenantSiteProperties.js +2 -0
  6. package/dist/m365/spo/commands/{site/site-list.js → tenant/tenant-site-list.js} +15 -12
  7. package/dist/m365/spo/commands.js +3 -1
  8. package/dist/m365/teams/commands/cache/cache-remove.js +74 -34
  9. package/dist/m365/viva/commands/engage/engage-community-user-list.js +98 -0
  10. package/dist/m365/viva/commands.js +1 -0
  11. package/dist/utils/vivaEngage.js +61 -0
  12. package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx +116 -0
  13. package/docs/docs/cmd/spo/{site/site-list.mdx → tenant/tenant-site-list.mdx} +13 -7
  14. package/docs/docs/cmd/teams/cache/cache-remove.mdx +10 -1
  15. package/docs/docs/cmd/viva/engage/engage-community-user-list.mdx +123 -0
  16. package/package.json +1 -1
package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx ADDED
@@ -0,0 +1,116 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spo folder sharinglink set
6
+
7
+ Updates a sharing link of a folder
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spo folder sharinglink set [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-u, --webUrl <webUrl>`
19
+ : The URL of the site where the folder is located.
20
+
21
+ `--folderUrl [folderUrl]`
22
+ : The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
23
+
24
+ `--folderId [folderId]`
25
+ : The unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
26
+
27
+ `--id <id>`
28
+ : The sharing link ID.
29
+
30
+ `--expirationDateTime <expirationDateTime>`
31
+ : The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This option only works for anonymous links.
32
+ ```
33
+
34
+ <Global />
35
+
36
+ ## Examples
37
+
38
+ Updates the expiration datetime of an anonymous sharing link for a folder specific by folder ID.
39
+
40
+ ```sh
41
+ m365 spo folder sharinglink set --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime '2022-11-30T00:00:00Z'
42
+ ```
43
+
44
+ Updates the expiration datetime of an anonymous sharing link for a folder specific by folder URL.
45
+
46
+ ```sh
47
+ m365 spo folder sharinglink set --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl /sites/demo/shared%20documents/Folder --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime '2022-11-30T00:00:00Z'
48
+ ```
49
+
50
+ ## Response
51
+
52
+ <Tabs>
53
+ <TabItem value="JSON">
54
+
55
+ ```json
56
+ {
57
+ "id": "bd1481e9-958b-4c1a-a33c-fb021f4ed444",
58
+ "roles": [
59
+ "write"
60
+ ],
61
+ "shareId": "u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0VwLVpGUHF2YkVsQnNnWXJhRjJBNG1jQmZWM1A3cU00eGZVVXJRZHdnSXllNGc",
62
+ "expirationDateTime": "2024-05-05T16:57:00Z",
63
+ "hasPassword": false,
64
+ "grantedToIdentitiesV2": [],
65
+ "grantedToIdentities": [],
66
+ "link": {
67
+ "scope": "anonymous",
68
+ "type": "edit",
69
+ "webUrl": "https://contoso.sharepoint.com/:f:/g/Ep-ZFPqvbElBsgYraF2A4mcBfV3P7qM4xfUUrQdwgIye4g",
70
+ "preventsDownload": false
71
+ }
72
+ }
73
+ ```
74
+
75
+ </TabItem>
76
+ <TabItem value="Text">
77
+
78
+ ```text
79
+ expirationDateTime : 2024-05-05T16:57:00Z
80
+ grantedToIdentities : []
81
+ grantedToIdentitiesV2: []
82
+ hasPassword : false
83
+ id : bd1481e9-958b-4c1a-a33c-fb021f4ed444
84
+ link : {"scope":"anonymous","type":"edit","webUrl":"https://contoso.sharepoint.com/:f:/g/Ep-ZFPqvbElBsgYraF2A4mcBfV3P7qM4xfUUrQdwgIye4g","preventsDownload":false}
85
+ roles : ["write"]
86
+ shareId : u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0VwLVpGUHF2YkVsQnNnWXJhRjJBNG1jQmZWM1A3cU00eGZVVXJRZHdnSXllNGc
87
+ ```
88
+
89
+ </TabItem>
90
+ <TabItem value="CSV">
91
+
92
+ ```csv
93
+ id,shareId,expirationDateTime,hasPassword
94
+ bd1481e9-958b-4c1a-a33c-fb021f4ed444,u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0VwLVpGUHF2YkVsQnNnWXJhRjJBNG1jQmZWM1A3cU00eGZVVXJRZHdnSXllNGc,2024-05-05T16:57:00Z,
95
+ ```
96
+
97
+ </TabItem>
98
+ <TabItem value="Markdown">
99
+
100
+ ```md
101
+ # spo folder sharinglink set --webUrl "https://contoso.sharepoint.com" --folderUrl "/shared documents/f1" --id "bd1481e9-958b-4c1a-a33c-fb021f4ed444" --expirationDateTime "2024-05-05T16:57:00.000Z"
102
+
103
+ Date: 03/05/2024
104
+
105
+ ## bd1481e9-958b-4c1a-a33c-fb021f4ed444
106
+
107
+ Property | Value
108
+ ---------|-------
109
+ id | bd1481e9-958b-4c1a-a33c-fb021f4ed444
110
+ shareId | u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0VwLVpGUHF2YkVsQnNnWXJhRjJBNG1jQmZWM1A3cU00eGZVVXJRZHdnSXllNGc
111
+ expirationDateTime | 2024-05-05T16:57:00Z
112
+ hasPassword | false
113
+ ```
114
+
115
+ </TabItem>
116
+ </Tabs>
package/docs/docs/cmd/spo/{site/site-list.mdx → tenant/tenant-site-list.mdx} RENAMED
@@ -2,14 +2,20 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # spo site list
5
+ # spo tenant site list
6
6
 
7
7
  Lists modern sites of the given type
8
8
 
9
9
  ## Usage
10
10
 
11
11
  ```sh
12
- m365 spo site list [options]
12
+ m365 spo tenant site list [options]
13
+ ```
14
+
15
+ ## Alias
16
+
17
+ ```sh
18
+ m365 spo site list
13
19
  ```
14
20
 
15
21
  ## Options
@@ -49,31 +55,31 @@ To use this command you have to have permissions to access the tenant admin site
49
55
  List all sites in the currently connected tenant
50
56
 
51
57
  ```sh
52
- m365 spo site list
58
+ m365 spo tenant site list
53
59
  ```
54
60
 
55
61
  List all group connected team sites in the currently connected tenant
56
62
 
57
63
  ```sh
58
- m365 spo site list --type TeamSite
64
+ m365 spo tenant site list --type TeamSite
59
65
  ```
60
66
 
61
67
  List all communication sites in the currently connected tenant
62
68
 
63
69
  ```sh
64
- m365 spo site list --type CommunicationSite
70
+ m365 spo tenant site list --type CommunicationSite
65
71
  ```
66
72
 
67
73
  List all group connected team sites that contain _project_ in the URL
68
74
 
69
75
  ```sh
70
- m365 spo site list --type TeamSite --filter "Url -like 'project'"
76
+ m365 spo tenant site list --type TeamSite --filter "Url -like 'project'"
71
77
  ```
72
78
 
73
79
  List all sites in the currently connected tenant including OneDrive sites
74
80
 
75
81
  ```sh
76
- m365 spo site list --includeOneDriveSites
82
+ m365 spo tenant site list --includeOneDriveSites
77
83
  ```
78
84
 
79
85
  ## Response
package/docs/docs/cmd/teams/cache/cache-remove.mdx CHANGED
@@ -13,6 +13,9 @@ m365 teams cache remove [options]
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
+ `-c, --client`
17
+ : Teams client to target. Possible values are: `new` or `classic`. Default value is `new`.
18
+
16
19
  `-f, --force`
17
20
  : Don't prompt for confirmation
18
21
  ```
@@ -43,12 +46,18 @@ The command works only on Windows and macOS. If you run it on a different operat
43
46
 
44
47
  ## Examples
45
48
 
46
- Removes the Microsoft Teams client cache
49
+ Removes the Microsoft Teams client cache for the new client.
47
50
 
48
51
  ```sh
49
52
  m365 teams cache remove
50
53
  ```
51
54
 
55
+ Removes the Microsoft Teams client cache for the classic client.
56
+
57
+ ```sh
58
+ m365 teams cache remove --client classic
59
+ ```
60
+
52
61
  ## Response
53
62
 
54
63
  The command won't return a response on success.
package/docs/docs/cmd/viva/engage/engage-community-user-list.mdx ADDED
@@ -0,0 +1,123 @@
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 user list
6
+
7
+ Lists all users within a specified Microsoft 365 Viva Engage community
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 viva engage community user list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `--communityId [communityId]`
19
+ : The ID of the Viva Engage community. Specify `communityId`, `communityDisplayName` or `entraGroupId`.
20
+
21
+ `-n, --communityDisplayName [communityDisplayName]`
22
+ : The display name of the Viva Engage community. Specify `communityId`, `communityDisplayName` or `entraGroupId`.
23
+
24
+ `--entraGroupId [entraGroupId]`
25
+ : The ID of the Microsoft 365 group. Specify `communityId`, `communityDisplayName` or `entraGroupId`.
26
+
27
+ `-r, --role [role]`
28
+ : Filter the results to only users with the given role: `Admin`, `Member`.
29
+ ```
30
+
31
+ <Global />
32
+
33
+ ## Examples
34
+
35
+ List all users from a community specified by ID.
36
+
37
+ ```sh
38
+ m365 viva engage community user list --communityId eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIzNjAyMDAxMTAwOSJ9
39
+ ```
40
+
41
+ List all admins from a community specified by display name.
42
+
43
+ ```sh
44
+ m365 viva engage community user list --communityDisplayName "All company" --role Admin
45
+ ```
46
+
47
+ List all members from a community specified by group ID.
48
+
49
+ ```sh
50
+ m365 viva engage community user list --entraGroupId b6c35b51-ebca-445c-885a-63a67d24cb53 --role Member
51
+ ```
52
+
53
+ ## Response
54
+
55
+ ### Standard response
56
+
57
+ <Tabs>
58
+ <TabItem value="JSON">
59
+
60
+ ```json
61
+ [
62
+ {
63
+ "id": "da634de7-d23c-4419-ab83-fcd395b4ebd0",
64
+ "businessPhones": [
65
+ "123-555-1215"
66
+ ],
67
+ "displayName": "Anton Johansen",
68
+ "givenName": "Anton",
69
+ "jobTitle": "IT Manager",
70
+ "mail": null,
71
+ "mobilePhone": "123-555-6645",
72
+ "officeLocation": "123455",
73
+ "preferredLanguage": null,
74
+ "surname": "Johansen",
75
+ "userPrincipalName": "Anton.Johansen@contoso.onmicrosoft.com",
76
+ "roles": [
77
+ "Admin"
78
+ ]
79
+ }
80
+ ]
81
+ ```
82
+
83
+ </TabItem>
84
+ <TabItem value="Text">
85
+
86
+ ```text
87
+ id displayName userPrincipalName roles
88
+ ------------------------------------ ---------------- ----------------------------------------- ------
89
+ da634de7-d23c-4419-ab83-fcd395b4ebd0 Anton Johansen Anton.Johansen@contoso.onmicrosoft.com Admin
90
+ ```
91
+
92
+ </TabItem>
93
+ <TabItem value="CSV">
94
+
95
+ ```csv
96
+ id,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName
97
+ da634de7-d23c-4419-ab83-fcd395b4ebd0,Anton Johansen,Anton,IT Manager,,123-555-6645,123455,,Johansen,Anton.Johansen@contoso.onmicrosoft.com
98
+ ```
99
+
100
+ </TabItem>
101
+ <TabItem value="Markdown">
102
+
103
+ ```md
104
+ # viva engage community user list --entraGroupId "b6c35b51-ebca-445c-885a-63a67d24cb53"
105
+
106
+ Date: 19/9/2024
107
+
108
+ ## Anton Johansen (da634de7-d23c-4419-ab83-fcd395b4ebd0)
109
+
110
+ Property | Value
111
+ ---------|-------
112
+ id | da634de7-d23c-4419-ab83-fcd395b4ebd0
113
+ displayName | Anton Johansen
114
+ givenName | Anton
115
+ jobTitle | IT Manager
116
+ mobilePhone | 123-555-6645
117
+ officeLocation | 123455
118
+ surname | Johansen
119
+ userPrincipalName | Anton.Johansen@contoso.onmicrosoft.com
120
+ ```
121
+
122
+ </TabItem>
123
+ </Tabs>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "10.0.0-beta.303b62c",
3
+ "version": "10.0.0-beta.558f289",
4
4
  "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
5
5
  "license": "MIT",
6
6
  "main": "./dist/api.js",