@pnp/cli-microsoft365 6.2.0-beta.d5442a1 → 6.2.0-beta.edaa477

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 (18) hide show
  1. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  2. package/dist/m365/onenote/commands.js +2 -1
  3. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  4. package/dist/m365/purview/commands.js +1 -0
  5. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  6. package/dist/m365/spo/commands/file/file-sharinglink-list.js +17 -4
  7. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  8. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  9. package/dist/m365/spo/commands/term/term-list.js +99 -29
  10. package/dist/m365/spo/commands.js +2 -0
  11. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  12. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  13. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  14. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +16 -7
  15. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  16. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  17. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  18. package/package.json +1 -1
package/docs/docs/cmd/spo/file/file-sharinglink-list.md CHANGED
@@ -19,6 +19,9 @@ m365 spo file sharinglink list [options]
19
19
  `-i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
+ `--scope [scope]`
23
+ : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
+
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
@@ -35,6 +38,12 @@ List sharing links of a file by url
35
38
  m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
36
39
  ```
37
40
 
41
+ List anonymous sharing links of a file by url
42
+
43
+ ```sh
44
+ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx" --scope anonymous
45
+ ```
46
+
38
47
  ## Response
39
48
 
40
49
  === "JSON"
@@ -72,9 +81,9 @@ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/dem
72
81
  }
73
82
  ],
74
83
  "link": {
75
- "scope": "anonymous",
84
+ "scope": "organization",
76
85
  "type": "view",
77
- "webUrl": "https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
86
+ "webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
78
87
  "preventsDownload": false
79
88
  }
80
89
  }
@@ -84,14 +93,14 @@ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/dem
84
93
  === "Text"
85
94
 
86
95
  ```text
87
- id roles link
88
- ------------------------------------ ----- -----------------------------------------------------------------------------------------------------------
89
- 2a021f54-90a2-4016-b3b3-5f34d2e7d932 read https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
96
+ id scope roles link
97
+ ------------------------------------ ------------ ----- ----------------------------------------------------------------------------------------
98
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932 organization read https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
90
99
  ```
91
100
 
92
101
  === "CSV"
93
102
 
94
103
  ```csv
95
- id,roles,link
96
- 2a021f54-90a2-4016-b3b3-5f34d2e7d932,read,https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
104
+ id,scope,roles,link
105
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932,organization,read,https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
97
106
  ```
package/docs/docs/cmd/spo/file/file-sharinglink-remove.md ADDED
@@ -0,0 +1,52 @@
1
+ # spo file sharinglink remove
2
+
3
+ Removes a specific sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `-i, --id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes a specific sharing link from a file by id without prompting for confirmation.
33
+
34
+ ```sh
35
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --confirm
36
+ ```
37
+
38
+ Removes a specific sharing link from a file by a specified site-relative URL.
39
+
40
+ ```sh
41
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl 'Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
42
+ ```
43
+
44
+ Removes a specific sharing link from a file by a specified server-relative URL.
45
+
46
+ ```sh
47
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
48
+ ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
package/docs/docs/cmd/spo/group/group-member-add.md CHANGED
@@ -20,19 +20,25 @@ m365 spo group member add [options]
20
20
  : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
21
21
 
22
22
  `--userName [userName]`
23
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
24
24
 
25
25
  `--email [email]`
26
- : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
26
+ : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
27
27
 
28
28
  `--userId [userId]`
29
- : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Id's have to be comma separated. Specify either `userName`, `email` or `userId`
29
+ : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
+
31
+ `--aadGroupId [aadGroupId]`
32
+ : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
33
+
34
+ `--aadGroupName [aadGroupName]`
35
+ : The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
36
 
31
37
  --8<-- "docs/cmd/_global.md"
32
38
 
33
39
  ## Remarks
34
40
 
35
- For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
41
+ For the `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list of invalid values.
36
42
 
37
43
  ## Examples
38
44
 
@@ -72,6 +78,18 @@ Add multiple users with the userId parameter to a SharePoint group with the grou
72
78
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
73
79
  ```
74
80
 
81
+ Add multiple users with the aadUserId parameter to a SharePoint group with the groupId parameter
82
+
83
+ ```sh
84
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserId "56ca9023-3449-4e98-a96a-69e81a6f4983,a96c1755-8aec-4f4d-955f-08504510dc56"
85
+ ```
86
+
87
+ Add multiple users with the aadUserName parameter to a SharePoint group with the groupId parameter
88
+
89
+ ```sh
90
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserName "Azure group one, Azure group two"
91
+ ```
92
+
75
93
  ## Response
76
94
 
77
95
  === "JSON"
package/docs/docs/cmd/spo/term/term-list.md CHANGED
@@ -22,6 +22,9 @@ m365 spo term list [options]
22
22
  `--termSetName [termSetName]`
23
23
  : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
24
24
 
25
+ `--includeChildTerms`
26
+ : If specified, child terms are loaded as well.
27
+
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  !!! important
@@ -40,3 +43,138 @@ List taxonomy terms from the term group and term set with the given ID
40
43
  ```sh
41
44
  m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
42
45
  ```
46
+
47
+ List taxonomy terms from the term group and term set with the given ID including child terms if any are found
48
+
49
+ ```sh
50
+ m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
51
+ ```
52
+
53
+ ## Response
54
+
55
+ ### Standard response
56
+
57
+ === "JSON"
58
+
59
+ ```json
60
+ [
61
+ {
62
+ "_ObjectType_": "SP.Taxonomy.Term",
63
+ "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
64
+ "CreatedDate": "2021-10-12T09:42:44.880Z",
65
+ "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
66
+ "LastModifiedDate": "2021-10-12T09:42:45.237Z",
67
+ "Name": "Departments",
68
+ "CustomProperties": {},
69
+ "CustomSortOrder": null,
70
+ "IsAvailableForTagging": true,
71
+ "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
72
+ "Description": "",
73
+ "IsDeprecated": false,
74
+ "IsKeyword": false,
75
+ "IsPinned": false,
76
+ "IsPinnedRoot": false,
77
+ "IsReused": false,
78
+ "IsRoot": true,
79
+ "IsSourceTerm": true,
80
+ "LocalCustomProperties": {
81
+ "Id": "termDepartments"
82
+ },
83
+ "MergedTermIds": [],
84
+ "PathOfTerm": "Departments",
85
+ "TermsCount": 1
86
+ }
87
+ ]
88
+ ```
89
+
90
+ === "Text"
91
+
92
+ ```text
93
+ Id Name
94
+ ------------------------------------ ---------
95
+ c387e91c-b553-4b92-886b-9af717cd73b0 Financing
96
+ ```
97
+
98
+ === "CSV"
99
+
100
+ ```csv
101
+ Id,Name
102
+ c387e91c-b553-4b92-886b-9af717cd73b0,Financing
103
+ ```
104
+
105
+ ### `includeChildTerms` response
106
+
107
+ When we make use of the option `includeChildTerms` the response will differ.
108
+
109
+ === "JSON"
110
+
111
+ ```json
112
+ [
113
+ {
114
+ "_ObjectType_": "SP.Taxonomy.Term",
115
+ "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
116
+ "CreatedDate": "2021-10-12T09:42:44.880Z",
117
+ "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
118
+ "LastModifiedDate": "2021-10-12T09:42:45.237Z",
119
+ "Name": "Departments",
120
+ "CustomProperties": {},
121
+ "CustomSortOrder": null,
122
+ "IsAvailableForTagging": true,
123
+ "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
124
+ "Description": "",
125
+ "IsDeprecated": false,
126
+ "IsKeyword": false,
127
+ "IsPinned": false,
128
+ "IsPinnedRoot": false,
129
+ "IsReused": false,
130
+ "IsRoot": true,
131
+ "IsSourceTerm": true,
132
+ "LocalCustomProperties": {
133
+ "Id": "termDepartments"
134
+ },
135
+ "MergedTermIds": [],
136
+ "PathOfTerm": "Departments",
137
+ "TermsCount": 1,
138
+ "Children": [{
139
+ "_ObjectType_": "SP.Taxonomy.Term",
140
+ "_ObjectIdentity_": "d10486a0-4067-5000-de97-bf1ab5bff53c|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNf5ybB0mfG0Kx6YO5CODZ1A==",
141
+ "CreatedDate": "2022-12-25T23:59:15.200Z",
142
+ "Id": "079b9c7f-9f49-421b-b1e9-83b908e0d9d4",
143
+ "LastModifiedDate": "2022-12-25T23:59:15.200Z",
144
+ "Name": "Financing",
145
+ "CustomProperties": {},
146
+ "CustomSortOrder": null,
147
+ "IsAvailableForTagging": true,
148
+ "Owner": "i:0#.f|membership|admin@mathijsdev2.onmicrosoft.com",
149
+ "Description": "",
150
+ "IsDeprecated": false,
151
+ "IsKeyword": false,
152
+ "IsPinned": false,
153
+ "IsPinnedRoot": false,
154
+ "IsReused": false,
155
+ "IsRoot": false,
156
+ "IsSourceTerm": true,
157
+ "LocalCustomProperties": {},
158
+ "MergedTermIds": [],
159
+ "PathOfTerm": "Departments;Financing",
160
+ "TermsCount": 0
161
+ }]
162
+ }
163
+ ]
164
+ ```
165
+
166
+ === "Text"
167
+
168
+ ```text
169
+ Id Name ParentTermId
170
+ ------------------------------------ --------- ------------------------------------
171
+ c387e91c-b553-4b92-886b-9af717cd73b0 Financing 079b9c7f-9f49-421b-b1e9-83b908e0d9d4
172
+ ```
173
+
174
+ === "CSV"
175
+
176
+ ```csv
177
+ Id,Name,ParentTermId
178
+ c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
179
+ ```
180
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "6.2.0-beta.d5442a1",
3
+ "version": "6.2.0-beta.edaa477",
4
4
  "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
5
5
  "license": "MIT",
6
6
  "main": "./dist/api.js",