@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.148279d

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

@@ -1,99 +0,0 @@
-# spo report siteusagedetail
-
-Gets details about SharePoint site usage
-
-## Usage
-
-```sh
-m365 spo report siteusagedetail [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "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"
-      }
-    ]
-    ```
-
-=== "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
-    ```
-
-=== "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
-    ```
-
-=== "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
-    ```

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

@@ -1,81 +0,0 @@
-# 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
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "Report Refresh Date": "2022-11-26",
-        "Site Type": "All",
-        "Total": "1320",
-        "Active": "3",
-        "Report Date": "2022-11-26",
-        "Report Period": "7"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2022-11-26,All,1320,3,2022-11-26,7
-    ```
-
-=== "CSV"
-
-    ```csv
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2022-11-26,All,1320,3,2022-11-26,7
-    ```
-
-=== "Markdown"
-
-    ```md
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2023-05-04,All,2006,10,2023-05-04,7
-    ```

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

@@ -1,76 +0,0 @@
-# spo report siteusagepages
-
-Gets the number of pages viewed across all sites
-
-## Usage
-
-```sh
-m365 spo report siteusagepages [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "Report Refresh Date": "2022-11-26",
-        "Site Type": "All",
-        "Page View Count": "14",
-        "Report Date": "2022-11-26",
-        "Report Period": "7"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
-    2022-11-26,All,14,2022-11-26,7
-    ```
-
-=== "CSV"
-
-    ```csv
-    Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
-    2022-11-26,All,14,2022-11-26,7
-    ```
-
-=== "Markdown"
-
-    ```md
-    Report Refresh Date,Site Type,Page View Count,Report Date,Report Period
-    2023-05-04,All,12,2023-05-04,7
-    ```

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

@@ -1,81 +0,0 @@
-# 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
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "Report Refresh Date": "2022-11-26",
-        "Site Type": "All",
-        "Total": "159",
-        "Active": "2",
-        "Report Date": "2022-11-26",
-        "Report Period": "7"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2022-11-26,All,159,2,2022-11-26,7
-    ```
-
-=== "CSV"
-
-    ```csv
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2022-11-26,All,159,2,2022-11-26,7
-    ```
-
-=== "Markdown"
-
-    ```md
-    Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
-    2023-05-04,All,33,3,2023-05-04,7
-    ```

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

@@ -1,76 +0,0 @@
-# spo report siteusagestorage
-
-Gets the trend of storage allocated and consumed during the reporting period
-
-## Usage
-
-```sh
-m365 spo report siteusagestorage [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "Report Refresh Date": "2022-11-26",
-        "Site Type": "All",
-        "Storage Used (Byte)": "2348104595",
-        "Report Date": "2022-11-26",
-        "Report Period": "7"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
-    2022-11-26,All,2348104595,2022-11-26,7
-    ```
-
-=== "CSV"
-
-    ```csv
-    Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
-    2022-11-26,All,2348104595,2022-11-26,7
-    ```
-
-=== "Markdown"
-
-    ```md
-    Report Refresh Date,Site Type,Storage Used (Byte),Report Date,Report Period
-    2023-05-04,All,272942096,2023-05-04,7
-    ```

package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md

@@ -1,47 +0,0 @@
-# spo roledefinition add
-
-Adds a new roledefinition to web
-
-## Usage
-
-```sh
-m365 spo roledefinition add [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site to which role should be added.
-
-`-n, --name <name>`
-: role definition name.
-
-`-d, --description [description]`
-: role definition description.
-
-`--rights [rights]`
-: 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`.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-The `--rights` option accepts **case-sensitive** values.
-
-## Examples
-
-Adds the role definition for the given site
-
-```sh
-m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test
-```
-
-Adds the role definition for the given site with description and rights
-
-```sh
-m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test --description "test description" --rights "ViewListItems,AddListItems,EditListItems,DeleteListItems"
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md

@@ -1,125 +0,0 @@
-# spo roledefinition get
-
-Gets specified role definition from web
-
-## Usage
-
-```sh
-m365 spo roledefinition get [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site for which to retrieve the role definition.
-
-`-i, --id <id>`
-: The Id of the role definition to retrieve.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Retrieve the role definition for the given site
-
-```sh
-m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "BasePermissions": {
-        "High": "2147483647",
-        "Low": "4294967295"
-      },
-      "Description": "Has full control.",
-      "Hidden": false,
-      "Id": 1073741829,
-      "Name": "Full Control",
-      "Order": 1,
-      "RoleTypeKind": 5,
-      "BasePermissionsValue": [
-        "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"
-      ],
-      "RoleTypeKindValue": "Administrator"
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    BasePermissions     : {"High":"2147483647","Low":"4294967295"}
-    BasePermissionsValue: ["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"]
-    Description         : Has full control.
-    Hidden              : false
-    Id                  : 1073741829
-    Name                : Full Control
-    Order               : 1
-    RoleTypeKind        : 5
-    RoleTypeKindValue   : Administrator
-    ```
-
-=== "CSV"
-
-    ```csv
-    BasePermissions,Description,Hidden,Id,Name,Order,RoleTypeKind,BasePermissionsValue,RoleTypeKindValue
-    "{""High"":""2147483647"",""Low"":""4294967295""}",Has full control.,,1073741829,Full Control,1,5,"[""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""]",Administrator
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo roledefinition get --webUrl "https://contoso.sharepoint.com/sites/project-x" --id "1073741829"
-
-    Date: 5/6/2023
-
-    ## Full Control (1073741829)
-
-    Property | Value
-    ---------|-------
-    Description | Has full control.
-    Hidden | false
-    Id | 1073741829
-    Name | Full Control
-    Order | 1
-    RoleTypeKind | 5
-    RoleTypeKindValue | Administrator
-    ```