@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/spo/report/report-activityusercounts.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report activityusercounts
+
+Gets the trend in the number of active users
+
+## Usage
+
+```sh
+m365 spo report activityusercounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Remarks
+
+A user is considered active if he or she has executed a file activity (save, sync, modify, or share) or visited a page within the specified time period
+
+## Examples
+
+Gets the trend in the number of active users for the last week
+
+```sh
+m365 spo report activityusercounts --period D7
+```
+
+Gets the trend in the number of active users for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report activityusercounts --period D7 --output text > "activityusercounts.txt"
+```
+
+Gets the trend in the number of active users for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report activityusercounts --period D7 --output json > "activityusercounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Visited Page": "1",
+      "Viewed Or Edited": "1",
+      "Synced": "",
+      "Shared Internally": "",
+      "Shared Externally": "",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+  2022-11-26,1,1,,,,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+  2022-11-26,1,1,,,,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+  2023-05-04,1,1,,,,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-activityuserdetail.mdx

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report activityuserdetail
+
+Gets details about SharePoint activity by user.
+
+## Usage
+
+```sh
+m365 spo report activityuserdetail [options]
+```
+
+## Options
+
+```md definition-list
+`-d, --date [date]`
+: 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.
+
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the Microsoft Teams device usage by user report should be stored in.
+```
+
+<Global />
+
+## Remarks
+
+As this report is only available for the past 28 days, date parameter value should be a date from that range.
+
+## Examples
+
+Gets details about SharePoint activity by user for the last week
+
+```sh
+m365 spo report activityuserdetail --period D7
+```
+
+Gets details about SharePoint activity by user for May 1, 2019
+
+```sh
+m365 spo report activityuserdetail --date 2019-05-01
+```
+
+Gets details about SharePoint activity by user for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report activityuserdetail --period D7 --output text > "activityuserdetail.txt"
+```
+
+Gets details about SharePoint activity by user for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report activityuserdetail --period D7 --output json > "activityuserdetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "User Principal Name": "Amanda.Powell@contoso.onmicrosoft.com",
+      "Is Deleted": "False",
+      "Deleted Date": "",
+      "Last Activity Date": "2022-09-08",
+      "Viewed Or Edited File Count": "0",
+      "Synced File Count": "0",
+      "Shared Internally File Count": "0",
+      "Shared Externally File Count": "0",
+      "Visited Page Count": "0",
+      "Assigned Products": "MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)+MICROSOFT POWER AUTOMATE FREE",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  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
+  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
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  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
+  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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  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
+  2023-05-04,6B56E500AC8309BD90D212680A2B9C03,False,,2023-05-04,16,0,0,0,36,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)+MICROSOFT POWER AUTOMATE FREE,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-siteusagedetail.mdx

@@ -0,0 +1,113 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report siteusagedetail
+
+Gets details about SharePoint site usage
+
+## Usage
+
+```sh
+m365 spo report siteusagedetail [options]
+```
+
+## Options
+
+```md definition-list
+`-d, --date [date]`
+: 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.
+
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Remarks
+
+As this report is only available for the past 28 days, date parameter value should be a date from that range.
+
+## Examples
+
+Gets details about SharePoint site usage for the last week
+
+```sh
+m365 spo report siteusagedetail --period D7
+```
+
+Gets details about SharePoint site usage for May 1, 2019
+
+```sh
+m365 spo report siteusagedetail --date 2019-05-01
+```
+
+Gets details about SharePoint site usage for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report siteusagedetail --period D7 --output text > "siteusagedetail.txt"
+```
+
+Gets details about SharePoint site usage for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report siteusagedetail --period D7 --output json > "siteusagedetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Site Id": "002caf24-2672-4bc4-bc41-2811d5dba62c",
+      "Site URL": "https://contoso.sharepoint.com/sites/ElMontePythons",
+      "Owner Display Name": "El Monte Pythons Owners",
+      "Is Deleted": "False",
+      "Last Activity Date": "",
+      "File Count": "2",
+      "Active File Count": "0",
+      "Page View Count": "0",
+      "Visited Page Count": "0",
+      "Storage Used (Byte)": "1475974",
+      "Storage Allocated (Byte)": "27487790694400",
+      "Root Web Template": "Group",
+      "Owner Principal Name": "ElMontePythons@contoso.onmicrosoft.com",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  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
+  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
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  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
+  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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  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
+  2023-05-04,00000000-0000-0000-0000-000000000000,2D7F5EEA85EDC827EB4E800B9843699A,9CB5FBB74CCA99D813491DF81BD9445D,False,2023-04-21,11,0,0,0,5979747,27487790694400,Group,C1B73ABEAE1BC69423799C66FE6D115F,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-siteusagefilecounts.mdx

@@ -0,0 +1,95 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report siteusagefilecounts
+
+Get the total number of files across all sites and the number of active files
+
+## Usage
+
+```sh
+m365 spo report siteusagefilecounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Remarks
+
+A file (user or system) is considered active if it has been saved, synced, modified, or shared within the specified time period.
+
+## Examples
+
+Get the total number of files across all sites and the number of active files for the last week
+
+```sh
+m365 spo report siteusagefilecounts --period D7
+```
+
+Get the total number of files across all sites and the number of active files for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report siteusagefilecounts --period D7 --output text > "siteusagefilecounts.txt"
+```
+
+Get the total number of files across all sites and the number of active files for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report siteusagefilecounts --period D7 --output json > "siteusagefilecounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Site Type": "All",
+      "Total": "1320",
+      "Active": "3",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2022-11-26,All,1320,3,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2022-11-26,All,1320,3,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2023-05-04,All,2006,10,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-siteusagepages.mdx

@@ -0,0 +1,90 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report siteusagepages
+
+Gets the number of pages viewed across all sites
+
+## Usage
+
+```sh
+m365 spo report siteusagepages [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Examples
+
+Gets the number of pages viewed across all sites for the last week
+
+```sh
+m365 spo report siteusagepages --period D7
+```
+
+Gets the number of pages viewed across all sites for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report siteusagepages --period D7 --output text > "siteusagepages.txt"
+```
+
+Gets the number of pages viewed across all sites for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report siteusagepages --period D7 --output json > "siteusagepages.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Site Type": "All",
+      "Page View Count": "14",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
+  2022-11-26,All,14,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
+  2022-11-26,All,14,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
+  2023-05-04,All,12,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-siteusagesitecounts.mdx

@@ -0,0 +1,95 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report siteusagesitecounts
+
+Gets the total number of files across all sites and the number of active files
+
+## Usage
+
+```sh
+m365 spo report siteusagesitecounts [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Remarks
+
+A file (user or system) is considered active if it has been saved, synced, modified, or shared within the specified time period.
+
+## Examples
+
+Gets the total number of files across all sites and the number of active files for the last week
+
+```sh
+m365 spo report siteusagesitecounts --period D7
+```
+
+Gets the total number of files across all sites and the number of active files for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report siteusagesitecounts --period D7 --output text > "siteusagesitecounts.txt"
+```
+
+Gets the total number of files across all sites and the number of active files for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report siteusagesitecounts --period D7 --output json > "siteusagesitecounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Site Type": "All",
+      "Total": "159",
+      "Active": "2",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2022-11-26,All,159,2,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2022-11-26,All,159,2,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
+  2023-05-04,All,33,3,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/report/report-siteusagestorage.mdx

@@ -0,0 +1,90 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report siteusagestorage
+
+Gets the trend of storage allocated and consumed during the reporting period
+
+## Usage
+
+```sh
+m365 spo report siteusagestorage [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in.
+```
+
+<Global />
+
+## Examples
+
+Gets the trend of storage allocated and consumed during the last week
+
+```sh
+m365 spo report siteusagestorage --period D7
+```
+
+Gets the trend of storage allocated and consumed during the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report siteusagestorage --period D7 --output text > "siteusagestorage.txt"
+```
+
+Gets the trend of storage allocated and consumed during the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report siteusagestorage --period D7 --output json > "siteusagestorage.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Site Type": "All",
+      "Storage Used (Byte)": "2348104595",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
+  2022-11-26,All,2348104595,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
+  2022-11-26,All,2348104595,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
+  2023-05-04,All,272942096,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+