@pnp/cli-microsoft365 6.1.0-beta.3e0114a → 6.1.0-beta.539ef23

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 (93) hide show
  1. package/dist/m365/aad/commands/group/group-get.js +79 -0
  2. package/dist/m365/aad/commands/user/user-set.js +84 -11
  3. package/dist/m365/aad/commands.js +1 -0
  4. package/dist/m365/base/ContextCommand.js +33 -0
  5. package/dist/m365/context/commands/context-init.js +28 -0
  6. package/dist/m365/context/commands/context-remove.js +103 -0
  7. package/dist/m365/context/commands.js +8 -0
  8. package/dist/m365/pp/commands/dataverse/dataverse-table-row-remove.js +133 -0
  9. package/dist/m365/pp/commands/environment/environment-get.js +5 -13
  10. package/dist/m365/pp/commands.js +1 -0
  11. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +142 -0
  12. package/dist/m365/purview/commands.js +2 -1
  13. package/dist/m365/search/commands/externalconnection/externalconnection-schema-add.js +86 -0
  14. package/dist/m365/search/commands.js +2 -1
  15. package/dist/m365/spo/commands/group/group-member-add.js +68 -30
  16. package/dist/m365/spo/commands/group/group-member-remove.js +50 -7
  17. package/dist/m365/spo/commands/list/{list-label-set.js → list-retentionlabel-ensure.js} +25 -15
  18. package/dist/m365/spo/commands/list/{list-label-get.js → list-retentionlabel-get.js} +19 -15
  19. package/dist/m365/spo/commands/listitem/listitem-remove.js +1 -1
  20. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +143 -0
  21. package/dist/m365/spo/commands/page/page-add.js +60 -63
  22. package/dist/m365/spo/commands/page/page-set.js +59 -70
  23. package/dist/m365/spo/commands/site/site-appcatalog-list.js +43 -0
  24. package/dist/m365/spo/commands/web/web-retentionlabel-list.js +63 -0
  25. package/dist/m365/spo/commands.js +5 -0
  26. package/dist/request.js +2 -1
  27. package/dist/utils/pid.js +31 -15
  28. package/docs/docs/cmd/aad/group/group-get.md +127 -0
  29. package/docs/docs/cmd/aad/user/user-set.md +31 -3
  30. package/docs/docs/cmd/context/context-init.md +25 -0
  31. package/docs/docs/cmd/context/context-remove.md +34 -0
  32. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.md +61 -0
  33. package/docs/docs/cmd/pp/environment/environment-get.md +9 -3
  34. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +63 -0
  35. package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.md +31 -0
  36. package/docs/docs/cmd/spo/group/group-member-add.md +58 -6
  37. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -8
  38. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +65 -0
  39. package/docs/docs/cmd/spo/list/{list-label-get.md → list-retentionlabel-get.md} +17 -11
  40. package/docs/docs/cmd/spo/listitem/listitem-remove.md +6 -6
  41. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.md +55 -0
  42. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +9 -5
  43. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +42 -0
  44. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +25 -3
  45. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +22 -0
  46. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +6 -2
  47. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +5 -1
  48. package/docs/docs/cmd/spo/page/page-add.md +13 -9
  49. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +6 -2
  50. package/docs/docs/cmd/spo/page/page-column-get.md +68 -5
  51. package/docs/docs/cmd/spo/page/page-column-list.md +36 -4
  52. package/docs/docs/cmd/spo/page/page-control-get.md +70 -3
  53. package/docs/docs/cmd/spo/page/page-control-list.md +69 -3
  54. package/docs/docs/cmd/spo/page/page-control-set.md +11 -7
  55. package/docs/docs/cmd/spo/page/page-copy.md +65 -4
  56. package/docs/docs/cmd/spo/page/page-get.md +100 -4
  57. package/docs/docs/cmd/spo/page/page-header-set.md +17 -13
  58. package/docs/docs/cmd/spo/page/page-list.md +122 -1
  59. package/docs/docs/cmd/spo/page/page-remove.md +9 -5
  60. package/docs/docs/cmd/spo/page/page-section-add.md +10 -6
  61. package/docs/docs/cmd/spo/page/page-section-get.md +36 -4
  62. package/docs/docs/cmd/spo/page/page-section-list.md +38 -3
  63. package/docs/docs/cmd/spo/page/page-set.md +10 -10
  64. package/docs/docs/cmd/spo/page/page-template-list.md +58 -1
  65. package/docs/docs/cmd/spo/page/page-text-add.md +9 -5
  66. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +28 -8
  67. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +35 -7
  68. package/docs/docs/cmd/spo/propertybag/propertybag-remove.md +13 -9
  69. package/docs/docs/cmd/spo/propertybag/propertybag-set.md +13 -5
  70. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +34 -2
  71. package/docs/docs/cmd/spo/report/report-activitypages.md +31 -2
  72. package/docs/docs/cmd/spo/report/report-activityusercounts.md +35 -2
  73. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +40 -3
  74. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +43 -3
  75. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +33 -2
  76. package/docs/docs/cmd/spo/report/report-siteusagepages.md +32 -2
  77. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +33 -2
  78. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +32 -2
  79. package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md +10 -6
  80. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +80 -2
  81. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +76 -2
  82. package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.md +9 -5
  83. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +39 -2
  84. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +32 -0
  85. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md +6 -2
  86. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +14 -74
  87. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md +6 -2
  88. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +30 -0
  89. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +36 -2
  90. package/docs/docs/cmd/spo/site/site-appcatalog-list.md +55 -0
  91. package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +74 -0
  92. package/package.json +1 -1
  93. package/docs/docs/cmd/spo/list/list-label-set.md +0 -55
@@ -20,10 +20,13 @@ 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` or `email`
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`
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` or `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`
27
+
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`
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
@@ -33,26 +36,75 @@ For the `--userName` or `--email` options you can specify multiple values by sep
33
36
 
34
37
  ## Examples
35
38
 
36
- Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
39
+ Add a user with the userName parameter to a SharePoint group with the groupId parameter
37
40
 
38
41
  ```sh
39
42
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
40
43
  ```
41
44
 
42
- Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
45
+ Add multiple users with the userName parameter to a SharePoint group with the groupId parameter
43
46
 
44
47
  ```sh
45
48
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
46
49
  ```
47
50
 
48
- Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
51
+ Add a user with the email parameter to a SharePoint group with the groupName parameter
49
52
 
50
53
  ```sh
51
54
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
52
55
  ```
53
56
 
54
- Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
57
+ Add multiple users with the email parameter to a SharePoint group with the groupName parameter
55
58
 
56
59
  ```sh
57
60
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
58
61
  ```
62
+
63
+ Add a user with the userId parameter to a SharePoint group with the groupId parameter
64
+
65
+ ```sh
66
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId 5
67
+ ```
68
+
69
+ Add multiple users with the userId parameter to a SharePoint group with the groupId parameter
70
+
71
+ ```sh
72
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
73
+ ```
74
+
75
+ ## Response
76
+
77
+ === "JSON"
78
+
79
+ ```json
80
+ [
81
+ {
82
+ "AllowedRoles": [
83
+ 0
84
+ ],
85
+ "CurrentRole": 0,
86
+ "DisplayName": "John Doe",
87
+ "Email": "john.doe@contoso.onmicrosoft.com",
88
+ "InvitationLink": null,
89
+ "IsUserKnown": true,
90
+ "Message": null,
91
+ "Status": true,
92
+ "User": "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
93
+ }
94
+ ]
95
+ ```
96
+
97
+ === "Text"
98
+
99
+ ```text
100
+ DisplayName Email
101
+ ----------- ---------------------------------
102
+ John Doe john.doe@contoso.onmicrosoft.com
103
+ ```
104
+
105
+ === "CSV"
106
+
107
+ ```csv
108
+ DisplayName,Email
109
+ John Doe,john.doe@contoso.onmicrosoft.com
110
+ ```
@@ -11,29 +11,45 @@ m365 spo group member remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the SharePoint group is available
14
+ : URL of the site where the SharePoint group is available.
15
15
 
16
16
  `--groupId [groupId]`
17
- : Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both
17
+ : Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both.
18
18
 
19
19
  `--groupName [groupName]`
20
- : Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both
20
+ : Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
21
21
 
22
- `--userName <userName>`
23
- : The UPN of the user that needs to be removed (user principal name, eg. megan.bowen@contoso.com)
22
+ `--userName [userName]`
23
+ : The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, or `userId`, but not multiple.
24
+
25
+ `--email [email]`
26
+ : The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
27
+
28
+ `--userId [userId]`
29
+ : The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
24
30
 
25
31
  --8<-- "docs/cmd/_global.md"
26
32
 
27
33
  ## Examples
28
34
 
29
- Remove a user from SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
35
+ Remove a user from a SharePoint group by userName.
30
36
 
31
37
  ```sh
32
38
  m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
33
39
  ```
34
40
 
35
- Remove a user from SharePoint group with Name _Site A Visitors_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
41
+ Remove a user from a SharePoint group by email.
42
+
43
+ ```sh
44
+ m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "Alex.Wilber@contoso.com"
45
+ ```
46
+
47
+ Remove a user from a SharePoint group by id.
36
48
 
37
49
  ```sh
38
- m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
50
+ m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
39
51
  ```
52
+
53
+ ## Response
54
+
55
+ The command won't return a response on success.
@@ -0,0 +1,65 @@
1
+ # spo list retentionlabel ensure
2
+
3
+ Sets a default retention label on the specified list or library.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo list retentionlabel ensure [options]
9
+ ```
10
+
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 spo list label set [options]
15
+ ```
16
+
17
+ ## Options
18
+
19
+ `-u, --webUrl <webUrl>`
20
+ : The URL of the site where the list is located.
21
+
22
+ `--label <label>`
23
+ : The label to set on the list.
24
+
25
+ `-t, --listTitle [listTitle]`
26
+ : The title of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
27
+
28
+ `-l, --listId [listId]`
29
+ : The ID of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
30
+
31
+ `--listUrl [listUrl]`
32
+ : Server- or web-relative URL of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
33
+
34
+ `--syncToItems`
35
+ : Specify, to set the label on all existing items in the list.
36
+
37
+ `--blockDelete`
38
+ : (deprecated) Specify, to disallow deleting items in the list.
39
+
40
+ `--blockEdit`
41
+ : (deprecated) Specify, to disallow editing items in the list.
42
+
43
+ --8<-- "docs/cmd/_global.md"
44
+
45
+ ## Remarks
46
+
47
+ A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items.
48
+
49
+ ## Examples
50
+
51
+ Sets retention label on the list with specified site-relative URL located in the specified site.
52
+
53
+ ```sh
54
+ m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
55
+ ```
56
+
57
+ Sets retention label and disables editing and deleting items on the list and all existing items for the list with specified title located in the specified site.
58
+
59
+ ```sh
60
+ m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
61
+ ```
62
+
63
+ ## Response
64
+
65
+ The command won't return a response on success.
@@ -1,11 +1,17 @@
1
- # spo list label get
1
+ # spo list retentionlabel get
2
2
 
3
- Gets label set on the specified list
3
+ Gets the default retention label set on the specified list or library.
4
4
 
5
5
  ## Usage
6
6
 
7
7
  ```sh
8
- m365 spo list label get [options]
8
+ m365 spo list retentionlabel get [options]
9
+ ```
10
+
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 spo list label get [options]
9
15
  ```
10
16
 
11
17
  ## Options
@@ -26,28 +32,28 @@ m365 spo list label get [options]
26
32
 
27
33
  ## Examples
28
34
 
29
- Gets label set on the list with specified title located in the specified site.
35
+ Gets retention label set on the list with specified title located in the specified site.
30
36
 
31
37
  ```sh
32
- m365 spo list label get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
38
+ m365 spo list retentionlabel get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
33
39
  ```
34
40
 
35
- Gets label set on the list with specified id located in the specified site.
41
+ Gets retention label set on the list with specified id located in the specified site.
36
42
 
37
43
  ```sh
38
- m365 spo list label get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
44
+ m365 spo list retentionlabel get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
39
45
  ```
40
46
 
41
- Gets label set on the list with specified server relative url located in the specified site.
47
+ Gets retention label set on the list with specified server relative url located in the specified site.
42
48
 
43
49
  ```sh
44
- m365 spo list label get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
50
+ m365 spo list retentionlabel get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
45
51
  ```
46
52
 
47
- Gets label set on the list with specified site-relative URL located in the specified site.
53
+ Gets retention label set on the list with specified site-relative URL located in the specified site.
48
54
 
49
55
  ```sh
50
- m365 spo list label get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
56
+ m365 spo list retentionlabel get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
51
57
  ```
52
58
 
53
59
  ## Response
@@ -11,16 +11,16 @@ m365 spo listitem remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to remove is located
14
+ : URL of the site where the list item to remove is located
15
15
 
16
16
  `-i, --id <id>`
17
17
  : The ID of the list item to remove.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
20
+ : ID of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
23
+ : Title of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
24
24
 
25
25
  `--listUrl [listUrl]`
26
26
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
@@ -35,19 +35,19 @@ m365 spo listitem remove [options]
35
35
 
36
36
  ## Examples
37
37
 
38
- Remove the list item with ID _1_ from list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Remove the list item located in a given site based on the list id
39
39
 
40
40
  ```sh
41
41
  m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
42
42
  ```
43
43
 
44
- Remove the list item with ID _1_ from list with title _List 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
44
+ Remove the list item located in a given site based on the list title
45
45
 
46
46
  ```sh
47
47
  m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
48
48
  ```
49
49
 
50
- Remove the list item with a specific ID from a list retrieved by server-relative URL located in a specific site
50
+ Remove the list item located in a given site based on the server-relative list url
51
51
 
52
52
  ```sh
53
53
  m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
@@ -0,0 +1,55 @@
1
+ # spo listitem retentionlabel remove
2
+
3
+ Clears the retention label from a list item
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo listitem retentionlabel remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the retentionlabel from a listitem to remove is located
15
+
16
+ `-i, --listItemId <listItemId>`
17
+ : The ID of the list item for which the retention label should be removed.
18
+
19
+ `-l, --listId [listId]`
20
+ : ID of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `-t, --listTitle [listTitle]`
23
+ : Title of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
27
+
28
+ `--confirm`
29
+ : Don't prompt for confirming removing the retention label from a list item
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Examples
34
+
35
+ Removes the retention label from a list item in a given site based on the list id
36
+
37
+ ```sh
38
+ m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
39
+ ```
40
+
41
+ Removes the retention label from a list item in a given site based on the list title
42
+
43
+ ```sh
44
+ m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
45
+ ```
46
+
47
+ Removes the retention label from a list item in a given site based on the server relative list url
48
+
49
+ ```sh
50
+ m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
51
+ ```
52
+
53
+ ## Response
54
+
55
+ The command won't return a response on success.
@@ -11,13 +11,13 @@ m365 spo orgassetslibrary add [options]
11
11
  ## Options
12
12
 
13
13
  `--libraryUrl <libraryUrl>`
14
- : The URL of the library to promote
14
+ : The URL of the library to promote.
15
15
 
16
16
  `--thumbnailUrl <thumbnailUrl>`
17
- : The URL of the thumbnail to render
17
+ : The URL of the thumbnail to render.
18
18
 
19
19
  `--cdnType [cdnType]`
20
- : Specifies the CDN type. `Public,Private`. Default is `Private`
20
+ : Specifies the CDN type. Allowed values `Public`, `Private`. Default `Private`.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -29,11 +29,15 @@ m365 spo orgassetslibrary add [options]
29
29
  Promotes an existing library to become an organization assets library
30
30
 
31
31
  ```sh
32
- m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/assets"
32
+ m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/SiteAssets"
33
33
  ```
34
34
 
35
35
  Promotes an existing library to become an organization assets library with Thumbnail
36
36
 
37
37
  ```sh
38
- m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/assets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
38
+ m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/SiteAssets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -22,3 +22,45 @@ List all libraries that are assigned as asset library
22
22
  ```sh
23
23
  m365 spo orgassetslibrary list
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ ### Standard response
29
+
30
+ === "JSON"
31
+
32
+ ```json
33
+ {
34
+ "Url": "/",
35
+ "Libraries": [
36
+ {
37
+ "DisplayName": "Site Assets",
38
+ "LibraryUrl": "SiteAssets",
39
+ "ListId": "/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/",
40
+ "ThumbnailUrl": null
41
+ }
42
+ ]
43
+ }
44
+ ```
45
+
46
+ === "Text"
47
+
48
+ ```text
49
+ Libraries: [{"DisplayName":"Site Assets","LibraryUrl":"SiteAssets","ListId":"/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/","ThumbnailUrl":null}]
50
+ Url : /
51
+ ```
52
+
53
+ === "CSV"
54
+
55
+ ```csv
56
+ Url,Libraries
57
+ /,"[{""DisplayName"":""Site Assets"",""LibraryUrl"":""SiteAssets"",""ListId"":""/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/"",""ThumbnailUrl"":null}]"
58
+ ```
59
+
60
+ ### Response when no library is assigned as asset library
61
+
62
+ === "Text"
63
+
64
+ ```text
65
+ No libraries in Organization Assets
66
+ ```
@@ -11,10 +11,10 @@ m365 spo orgassetslibrary remove [options]
11
11
  ## Options
12
12
 
13
13
  `--libraryUrl <libraryUrl>`
14
- : The server relative URL of the library to be removed as a central location for organization assets
14
+ : The server relative URL of the library to be removed as a central location for organization assets.
15
15
 
16
16
  `--confirm`
17
- : Don't prompt for confirming removing the organization asset library
17
+ : Don't prompt for confirming removing the organization asset library.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -23,8 +23,30 @@ m365 spo orgassetslibrary remove [options]
23
23
 
24
24
  ## Examples
25
25
 
26
- Removes organization assets library without confirmation
26
+ Removes organization assets library without prompting for confirmation
27
27
 
28
28
  ```sh
29
29
  m365 spo orgassetslibrary remove --libraryUrl "/sites/branding/assets" --confirm
30
30
  ```
31
+
32
+ ## Response
33
+
34
+ === "JSON"
35
+
36
+ ```json
37
+ {
38
+ "IsNull": false
39
+ }
40
+ ```
41
+
42
+ === "Text"
43
+
44
+ ```text
45
+ IsNull: false
46
+ ```
47
+
48
+ === "CSV"
49
+
50
+ ```csv
51
+ IsNull
52
+ ```
@@ -22,3 +22,25 @@ List all organizational news sites
22
22
  ```sh
23
23
  m365 spo orgnewssite list
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ [
32
+ "https://contoso.sharepoint.com/sites/contosoNews"
33
+ ]
34
+ ```
35
+
36
+ === "Text"
37
+
38
+ ```text
39
+ https://contoso.sharepoint.com/sites/contosoNews
40
+ ```
41
+
42
+ === "CSV"
43
+
44
+ ```csv
45
+ https://contoso.sharepoint.com/sites/contosoNews
46
+ ```
@@ -11,10 +11,10 @@ m365 spo orgnewssite remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --url <url>`
14
- : Absolute URL of the site to remove
14
+ : Absolute URL of the site to remove.
15
15
 
16
16
  `--confirm`
17
- : Don't prompt for confirmation
17
+ : Don't prompt for confirmation.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -34,3 +34,7 @@ Remove a site from the list of organizational news sites, without prompting for
34
34
  ```sh
35
35
  m365 spo orgnewssite remove --url https://contoso.sharepoint.com/sites/site1 --confirm
36
36
  ```
37
+
38
+ ## Response
39
+
40
+ The command won't return a response on success.
@@ -11,7 +11,7 @@ m365 spo orgnewssite set [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --url <url>`
14
- : The URL of the site to mark as an organizational news site
14
+ : The URL of the site to mark as an organizational news site.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -29,3 +29,7 @@ Set a site as an organizational news site
29
29
  ```sh
30
30
  m365 spo orgnewssite set --url https://contoso.sharepoint.com/sites/site1
31
31
  ```
32
+
33
+ ## Response
34
+
35
+ The command won't return a response on success.
@@ -11,31 +11,31 @@ m365 spo page add [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --name <name>`
14
- : Name of the page to create
14
+ : Name of the page to create.
15
15
 
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the page should be created
17
+ : URL of the site where the page should be created.
18
18
 
19
19
  `-t, --title [title]`
20
- : Title of the page to create. If not specified, will use the page name as its title
20
+ : Title of the page to create. If not specified, will use the page name as its title.
21
21
 
22
22
  `-l, --layoutType [layoutType]`
23
- : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`, `HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`
23
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`, `HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`.
24
24
 
25
25
  `-p, --promoteAs [promoteAs]`
26
- : Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`, `Template`
26
+ : Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`, `Template`.
27
27
 
28
28
  `--commentsEnabled`
29
- : Set to enable comments on the page
29
+ : Set to enable comments on the page.
30
30
 
31
31
  `--publish`
32
- : Set to publish the page
32
+ : Set to publish the page.
33
33
 
34
34
  `--publishMessage [publishMessage]`
35
- : Message to set when publishing the page
35
+ : Message to set when publishing the page.
36
36
 
37
37
  `--description [description]`
38
- : The description to set for the page
38
+ : The description to set for the page.
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
@@ -100,3 +100,7 @@ Create new article page with description
100
100
  ```sh
101
101
  m365 spo page add --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --description "Description to add for the page"
102
102
  ```
103
+
104
+ ## Response
105
+
106
+ The command won't return a response on success.
@@ -23,10 +23,10 @@ m365 spo page clientsidewebpart add [options]
23
23
  : ID of the custom web part to add. Specify either `standardWebPart` or `webPartId` but not both.
24
24
 
25
25
  `--webPartProperties [webPartProperties]`
26
- : JSON string with web part properties to set on the web part. Specify `webPartProperties` or `webPartData` but not both.
26
+ : JSON string with web part properties to set on the web part. Specify either `webPartProperties` or `webPartData` but not both.
27
27
 
28
28
  `--webPartData [webPartData]`
29
- : JSON string with web part data as retrieved from the web part maintenance mode. Specify `webPartProperties` or `webPartData` but not both.
29
+ : JSON string with web part data as retrieved from the web part maintenance mode. Specify either `webPartProperties` or `webPartData` but not both.
30
30
 
31
31
  `--section [section]`
32
32
  : Number of the section to which the web part should be added (1 or higher).
@@ -79,3 +79,7 @@ Add the standard Image web part with the preconfigured image
79
79
  ```sh
80
80
  m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}'
81
81
  ```
82
+
83
+ ## Response
84
+
85
+ The command won't return a response on success.