@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
@@ -11,47 +11,51 @@ m365 spo propertybag remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site from which the property should be removed
14
+ : The URL of the site from which the property should be removed.
15
15
 
16
16
  `-k, --key <key>`
17
- : Key of the property to be removed. Case-sensitive
17
+ : Key of the property to be removed. Case-sensitive.
18
18
 
19
19
  `-f, --folder [folder]`
20
- : Site-relative URL of the folder from which to remove the property bag value
20
+ : Site-relative URL of the folder from which to remove the property bag value.
21
21
 
22
22
  `--confirm`
23
- : Don't prompt for confirming removal of property bag value
23
+ : Don't prompt for confirming removal of property bag value.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
27
27
  ## Examples
28
28
 
29
- Removes the value of the _key1_ property from the property bag located in site _https://contoso.sharepoint.com/sites/test_
29
+ Removes the value of the property from the property bag located the given site
30
30
 
31
31
  ```sh
32
32
  m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1
33
33
  ```
34
34
 
35
- Removes the value of the _key1_ property from the property bag located in site root folder _https://contoso.sharepoint.com/sites/test_
35
+ Removes the value of the property from the property bag located in the given site root folder
36
36
 
37
37
  ```sh
38
38
  m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder / --confirm
39
39
  ```
40
40
 
41
- Removes the value of the _key1_ property from the property bag located in site document library _https://contoso.sharepoint.com/sites/test_
41
+ Removes the value of the property from the property bag located in the given site document library
42
42
 
43
43
  ```sh
44
44
  m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'
45
45
  ```
46
46
 
47
- Removes the value of the _key1_ property from the property bag located in folder in site document library _https://contoso.sharepoint.com/sites/test_
47
+ Removes the value of the property from the property bag located in folder in the given site document library
48
48
 
49
49
  ```sh
50
50
  m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents/MyFolder'
51
51
  ```
52
52
 
53
- Removes the value of the _key1_ property from the property bag located in site list _https://contoso.sharepoint.com/sites/test_
53
+ Removes the value of the property from the property bag located in the given site list
54
54
 
55
55
  ```sh
56
56
  m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /Lists/MyList
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ The command won't return a response on success.
@@ -24,34 +24,42 @@ m365 spo propertybag set [options]
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
27
+ ## Remarks
28
+
29
+ SharePoint Online supports setting property bag values only in classic sites. On modern sites you will get a _Site has NoScript enabled, and setting property bag values is not supported_ error.
30
+
27
31
  ## Examples
28
32
 
29
- Sets the value of the _key1_ property in the property bag of site _https://contoso.sharepoint.com/sites/test_
33
+ Sets the value of the property in the property bag of the given site
30
34
 
31
35
  ```sh
32
36
  m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1
33
37
  ```
34
38
 
35
- Sets the value of the _key1_ property in the property bag of the root folder of site _https://contoso.sharepoint.com/sites/test_
39
+ Sets the value of the property in the property bag of the root folder of the given site
36
40
 
37
41
  ```sh
38
42
  m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder /
39
43
  ```
40
44
 
41
- Sets the value of the _key1_ property in the property bag of a document library located in site _https://contoso.sharepoint.com/sites/test_
45
+ Sets the value of the property in the property bag of a document library located in the given site
42
46
 
43
47
  ```sh
44
48
  m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder '/Shared Documents'
45
49
  ```
46
50
 
47
- Sets the value of the _key1_ property in the property bag of a folder in a document library located in site _https://contoso.sharepoint.com/sites/test_
51
+ Sets the value of the property in the property bag of a folder in a document library located in the given site
48
52
 
49
53
  ```sh
50
54
  m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder '/Shared Documents/MyFolder'
51
55
  ```
52
56
 
53
- Sets the value of the _key1_ property in the property bag of a list in site _https://contoso.sharepoint.com/sites/test_
57
+ Sets the value of the property in the property bag of a list in the given site
54
58
 
55
59
  ```sh
56
60
  m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder /Lists/MyList
57
61
  ```
62
+
63
+ ## Response
64
+
65
+ The command won't return a response on success.
@@ -11,10 +11,10 @@ m365 spo report activityfilecounts [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -37,3 +37,35 @@ Gets the number of unique, licensed users who interacted with files stored on Sh
37
37
  ```sh
38
38
  m365 spo report activityfilecounts --period D7 --output json > "activityfilecounts.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2022-11-26",
49
+ "Viewed Or Edited": "3",
50
+ "Synced": "",
51
+ "Shared Internally": "",
52
+ "Shared Externally": "",
53
+ "Report Date": "2022-11-26",
54
+ "Report Period": "7"
55
+ }
56
+ ]
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```text
62
+ Report Refresh Date,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
63
+ 2022-11-26,3,,,,2022-11-26,7
64
+ ```
65
+
66
+ === "CSV"
67
+
68
+ ```csv
69
+ Report Refresh Date,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
70
+ 2022-11-26,3,,,,2022-11-26,7
71
+ ```
@@ -11,10 +11,10 @@ m365 spo report activitypages [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -37,3 +37,32 @@ Gets the number of unique pages visited by users for the last week and exports t
37
37
  ```sh
38
38
  m365 spo report activitypages --period D7 --output json > "activitypages.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2022-11-26",
49
+ "Visited Page Count": "10",
50
+ "Report Date": "2022-11-26",
51
+ "Report Period": "7"
52
+ }
53
+ ]
54
+ ```
55
+
56
+ === "Text"
57
+
58
+ ```text
59
+ Report Refresh Date,Visited Page Count,Report Date,Report Period
60
+ 2022-11-26,10,2022-11-26,7
61
+ ```
62
+
63
+ === "CSV"
64
+
65
+ ```csv
66
+ Report Refresh Date,Visited Page Count,Report Date,Report Period
67
+ 2022-11-26,10,2022-11-26,7
68
+ ```
@@ -11,10 +11,10 @@ m365 spo report activityusercounts [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -41,3 +41,36 @@ Gets the trend in the number of active users for the last week and exports the r
41
41
  ```sh
42
42
  m365 spo report activityusercounts --period D7 --output json > "activityusercounts.json"
43
43
  ```
44
+
45
+ ## Response
46
+
47
+ === "JSON"
48
+
49
+ ```json
50
+ [
51
+ {
52
+ "Report Refresh Date": "2022-11-26",
53
+ "Visited Page": "1",
54
+ "Viewed Or Edited": "1",
55
+ "Synced": "",
56
+ "Shared Internally": "",
57
+ "Shared Externally": "",
58
+ "Report Date": "2022-11-26",
59
+ "Report Period": "7"
60
+ }
61
+ ]
62
+ ```
63
+
64
+ === "Text"
65
+
66
+ ```text
67
+ Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
68
+ 2022-11-26,1,1,,,,2022-11-26,7
69
+ ```
70
+
71
+ === "CSV"
72
+
73
+ ```csv
74
+ Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
75
+ 2022-11-26,1,1,,,,2022-11-26,7
76
+ ```
@@ -11,13 +11,13 @@ m365 spo report activityuserdetail [options]
11
11
  ## Options
12
12
 
13
13
  `-d, --date [date]`
14
- : The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`. Specify the date or period, but not both.
14
+ : The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`. Specify either `date` or `period`, but not both.
15
15
 
16
16
  `-p, --period [period]`
17
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
17
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
18
18
 
19
19
  `-f, --outputFile [outputFile]`
20
- : Path to the file where the Microsoft Teams device usage by user report should be stored in
20
+ : Path to the file where the Microsoft Teams device usage by user report should be stored in.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -50,3 +50,40 @@ Gets details about SharePoint activity by user for the last week and exports the
50
50
  ```sh
51
51
  m365 spo report activityuserdetail --period D7 --output json > "activityuserdetail.json"
52
52
  ```
53
+
54
+ ## Response
55
+
56
+ === "JSON"
57
+
58
+ ```json
59
+ [
60
+ {
61
+ "Report Refresh Date": "2022-11-26",
62
+ "User Principal Name": "Amanda.Powell@contoso.onmicrosoft.com",
63
+ "Is Deleted": "False",
64
+ "Deleted Date": "",
65
+ "Last Activity Date": "2022-09-08",
66
+ "Viewed Or Edited File Count": "0",
67
+ "Synced File Count": "0",
68
+ "Shared Internally File Count": "0",
69
+ "Shared Externally File Count": "0",
70
+ "Visited Page Count": "0",
71
+ "Assigned Products": "MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)+MICROSOFT POWER AUTOMATE FREE",
72
+ "Report Period": "7"
73
+ }
74
+ ]
75
+ ```
76
+
77
+ === "Text"
78
+
79
+ ```text
80
+ Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Viewed Or Edited File Count,Synced File Count,Shared Internally File Count,Shared Externally File Count,Visited Page Count,Assigned Products,Report Period
81
+ 2022-11-26,Amanda.Powell@contoso.onmicrosoft.com,False,,2022-09-08,0,0,0,0,0,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)+MICROSOFT POWER AUTOMATE FREE,7
82
+ ```
83
+
84
+ === "CSV"
85
+
86
+ ```csv
87
+ Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Viewed Or Edited File Count,Synced File Count,Shared Internally File Count,Shared Externally File Count,Visited Page Count,Assigned Products,Report Period
88
+ 2022-11-26,Amanda.Powell@contoso.onmicrosoft.com,False,,2022-09-08,0,0,0,0,0,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)+MICROSOFT POWER AUTOMATE FREE,7
89
+ ```
@@ -11,13 +11,13 @@ m365 spo report siteusagedetail [options]
11
11
  ## Options
12
12
 
13
13
  `-d, --date [date]`
14
- : The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`. Specify the date or period, but not both.
14
+ : The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`. Specify either `date` or `period`, but not both.
15
15
 
16
16
  `-p, --period [period]`
17
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
17
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
18
18
 
19
19
  `-f, --outputFile [outputFile]`
20
- : Path to the file where the report should be stored in
20
+ : Path to the file where the report should be stored in.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -50,3 +50,43 @@ Gets details about SharePoint site usage for the last week and exports the repor
50
50
  ```sh
51
51
  m365 spo report siteusagedetail --period D7 --output json > "siteusagedetail.json"
52
52
  ```
53
+
54
+ ## Response
55
+
56
+ === "JSON"
57
+
58
+ ```json
59
+ [
60
+ {
61
+ "Report Refresh Date": "2022-11-26",
62
+ "Site Id": "002caf24-2672-4bc4-bc41-2811d5dba62c",
63
+ "Site URL": "https://contoso.sharepoint.com/sites/ElMontePythons",
64
+ "Owner Display Name": "El Monte Pythons Owners",
65
+ "Is Deleted": "False",
66
+ "Last Activity Date": "",
67
+ "File Count": "2",
68
+ "Active File Count": "0",
69
+ "Page View Count": "0",
70
+ "Visited Page Count": "0",
71
+ "Storage Used (Byte)": "1475974",
72
+ "Storage Allocated (Byte)": "27487790694400",
73
+ "Root Web Template": "Group",
74
+ "Owner Principal Name": "ElMontePythons@contoso.onmicrosoft.com",
75
+ "Report Period": "7"
76
+ }
77
+ ]
78
+ ```
79
+
80
+ === "Text"
81
+
82
+ ```text
83
+ Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period
84
+ 2022-11-26,002caf24-2672-4bc4-bc41-2811d5dba62c,https://contoso.sharepoint.com/sites/ElMontePythons,El Monte Pythons Owners,False,,2,0,0,0,1475974,27487790694400,Group,ElMontePythons@contoso.onmicrosoft.com,7
85
+ ```
86
+
87
+ === "CSV"
88
+
89
+ ```csv
90
+ Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period
91
+ 2022-11-26,002caf24-2672-4bc4-bc41-2811d5dba62c,https://contoso.sharepoint.com/sites/ElMontePythons,El Monte Pythons Owners,False,,2,0,0,0,1475974,27487790694400,Group,ElMontePythons@contoso.onmicrosoft.com,7
92
+ ```
@@ -11,10 +11,10 @@ m365 spo report siteusagefilecounts [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -41,3 +41,34 @@ Get the total number of files across all sites and the number of active files fo
41
41
  ```sh
42
42
  m365 spo report siteusagefilecounts --period D7 --output json > "siteusagefilecounts.json"
43
43
  ```
44
+
45
+ ## Response
46
+
47
+ === "JSON"
48
+
49
+ ```json
50
+ [
51
+ {
52
+ "Report Refresh Date": "2022-11-26",
53
+ "Site Type": "All",
54
+ "Total": "1320",
55
+ "Active": "3",
56
+ "Report Date": "2022-11-26",
57
+ "Report Period": "7"
58
+ }
59
+ ]
60
+ ```
61
+
62
+ === "Text"
63
+
64
+ ```text
65
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
66
+ 2022-11-26,All,1320,3,2022-11-26,7
67
+ ```
68
+
69
+ === "CSV"
70
+
71
+ ```csv
72
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
73
+ 2022-11-26,All,1320,3,2022-11-26,7
74
+ ```
@@ -11,10 +11,10 @@ m365 spo report siteusagepages [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -37,3 +37,33 @@ Gets the number of pages viewed across all sites for the last week and exports t
37
37
  ```sh
38
38
  m365 spo report siteusagepages --period D7 --output json > "siteusagepages.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2022-11-26",
49
+ "Site Type": "All",
50
+ "Page View Count": "14",
51
+ "Report Date": "2022-11-26",
52
+ "Report Period": "7"
53
+ }
54
+ ]
55
+ ```
56
+
57
+ === "Text"
58
+
59
+ ```text
60
+ Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
61
+ 2022-11-26,All,14,2022-11-26,7
62
+ ```
63
+
64
+ === "CSV"
65
+
66
+ ```csv
67
+ Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
68
+ 2022-11-26,All,14,2022-11-26,7
69
+ ```
@@ -11,10 +11,10 @@ m365 spo report siteusagesitecounts [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -41,3 +41,34 @@ Gets the total number of files across all sites and the number of active files f
41
41
  ```sh
42
42
  m365 spo report siteusagesitecounts --period D7 --output json > "siteusagesitecounts.json"
43
43
  ```
44
+
45
+ ## Response
46
+
47
+ === "JSON"
48
+
49
+ ```json
50
+ [
51
+ {
52
+ "Report Refresh Date": "2022-11-26",
53
+ "Site Type": "All",
54
+ "Total": "159",
55
+ "Active": "2",
56
+ "Report Date": "2022-11-26",
57
+ "Report Period": "7"
58
+ }
59
+ ]
60
+ ```
61
+
62
+ === "Text"
63
+
64
+ ```text
65
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
66
+ 2022-11-26,All,159,2,2022-11-26,7
67
+ ```
68
+
69
+ === "CSV"
70
+
71
+ ```csv
72
+ Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
73
+ 2022-11-26,All,159,2,2022-11-26,7
74
+ ```
@@ -11,10 +11,10 @@ m365 spo report siteusagestorage [options]
11
11
  ## Options
12
12
 
13
13
  `-p, --period <period>`
14
- : The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
14
+ : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
15
15
 
16
16
  `-f, --outputFile [outputFile]`
17
- : Path to the file where the report should be stored in
17
+ : Path to the file where the report should be stored in.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -37,3 +37,33 @@ Gets the trend of storage allocated and consumed during the last week and export
37
37
  ```sh
38
38
  m365 spo report siteusagestorage --period D7 --output json > "siteusagestorage.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2022-11-26",
49
+ "Site Type": "All",
50
+ "Storage Used (Byte)": "2348104595",
51
+ "Report Date": "2022-11-26",
52
+ "Report Period": "7"
53
+ }
54
+ ]
55
+ ```
56
+
57
+ === "Text"
58
+
59
+ ```text
60
+ Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
61
+ 2022-11-26,All,2348104595,2022-11-26,7
62
+ ```
63
+
64
+ === "CSV"
65
+
66
+ ```csv
67
+ Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
68
+ 2022-11-26,All,2348104595,2022-11-26,7
69
+ ```
@@ -11,16 +11,16 @@ m365 spo roledefinition add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site to which role should be added
14
+ : URL of the site to which role should be added.
15
15
 
16
16
  `-n, --name <name>`
17
- : role definition name
17
+ : role definition name.
18
18
 
19
19
  `-d, --description [description]`
20
- : role definition description
20
+ : role definition description.
21
21
 
22
22
  `--rights [rights]`
23
- : A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask,ViewListItems,AddListItems,EditListItems,DeleteListItems,ApproveItems,OpenItems,ViewVersions,DeleteVersions,CancelCheckout,ManagePersonalViews,ManageLists,ViewFormPages,AnonymousSearchAccessList,Open,ViewPages,AddAndCustomizePages,ApplyThemeAndBorder,ApplyStyleSheets,ViewUsageData,CreateSSCSite,ManageSubwebs,CreateGroups,ManagePermissions,BrowseDirectories,BrowseUserInfo,AddDelPrivateWebParts,UpdatePersonalWebParts,ManageWeb,AnonymousSearchAccessWebLists,UseClientIntegration,UseRemoteAPIs,ManageAlerts,CreateAlerts,EditMyUserInfo,EnumeratePermissions,FullMask`. Default `EmptyMask`
23
+ : A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`,`UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Default `EmptyMask`.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -30,14 +30,18 @@ The `--rights` option accepts **case-sensitive** values.
30
30
 
31
31
  ## Examples
32
32
 
33
- Adds the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with name _test_
33
+ Adds the role definition for the given site
34
34
 
35
35
  ```sh
36
36
  m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test
37
37
  ```
38
38
 
39
- Adds the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with name _test_ and description _test description_ and rights _ViewListItems,AddListItems,EditListItems,DeleteListItems_
39
+ Adds the role definition for the given site with description and rights
40
40
 
41
41
  ```sh
42
42
  m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test --description "test description" --rights "ViewListItems,AddListItems,EditListItems,DeleteListItems"
43
43
  ```
44
+
45
+ ## Response
46
+
47
+ The command won't return a response on success.