@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.11542c0

package/docs/docs/cmd/spo/propertybag/propertybag-remove.md

@@ -11,47 +11,51 @@ m365 spo propertybag remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: The URL of the site from which the property should be removed
+: The URL of the site from which the property should be removed.
 
 `-k, --key <key>`
-: Key of the property to be removed. Case-sensitive
+: Key of the property to be removed. Case-sensitive.
 
 `-f, --folder [folder]`
-: Site-relative URL of the folder from which to remove the property bag value
+: Site-relative URL of the folder from which to remove the property bag value.
 
 `--confirm`
-: Don't prompt for confirming removal of property bag value
+: Don't prompt for confirming removal of property bag value.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Removes the value of the _key1_ property from the property bag located in site _https://contoso.sharepoint.com/sites/test_
+Removes the value of the property from the property bag located the given site
 
 ```sh
 m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1
 ```
 
-Removes the value of the _key1_ property from the property bag located in site root folder _https://contoso.sharepoint.com/sites/test_
+Removes the value of the property from the property bag located in the given site root folder
 
 ```sh
 m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder / --confirm
 ```
 
-Removes the value of the _key1_ property from the property bag located in site document library _https://contoso.sharepoint.com/sites/test_
+Removes the value of the property from the property bag located in the given site document library
 
 ```sh
 m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'
 ```
 
-Removes the value of the _key1_ property from the property bag located in folder in site document library _https://contoso.sharepoint.com/sites/test_
+Removes the value of the property from the property bag located in folder in the given site document library
 
 ```sh
 m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents/MyFolder'
 ```
 
-Removes the value of the _key1_ property from the property bag located in site list _https://contoso.sharepoint.com/sites/test_
+Removes the value of the property from the property bag located in the given site list
 
 ```sh
 m365 spo propertybag remove --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /Lists/MyList
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/propertybag/propertybag-set.md

@@ -24,34 +24,42 @@ m365 spo propertybag set [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+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.
+
 ## Examples
 
-Sets the value of the _key1_ property in the property bag of site _https://contoso.sharepoint.com/sites/test_
+Sets the value of the property in the property bag of the given site
 
 ```sh
 m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1
 ```
 
-Sets the value of the _key1_ property in the property bag of the root folder of site _https://contoso.sharepoint.com/sites/test_
+Sets the value of the property in the property bag of the root folder of the given site
 
 ```sh
 m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder /
 ```
 
-Sets the value of the _key1_ property in the property bag of a document library located in site _https://contoso.sharepoint.com/sites/test_
+Sets the value of the property in the property bag of a document library located in the given site
 
 ```sh
 m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder '/Shared Documents'
 ```
 
-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_
+Sets the value of the property in the property bag of a folder in a document library located in the given site
 
 ```sh
 m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder '/Shared Documents/MyFolder'
 ```
 
-Sets the value of the _key1_ property in the property bag of a list in site _https://contoso.sharepoint.com/sites/test_
+Sets the value of the property in the property bag of a list in the given site
 
 ```sh
 m365 spo propertybag set --webUrl https://contoso.sharepoint.com/sites/test --key key1 --value value1 --folder /Lists/MyList
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,10 +11,10 @@ m365 spo report activityfilecounts [options]
 ## Options
 
 `-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -37,3 +37,35 @@ Gets the number of unique, licensed users who interacted with files stored on Sh
 ```sh
 m365 spo report activityfilecounts --period D7 --output json > "activityfilecounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-26",
+        "Viewed Or Edited": "3",
+        "Synced": "",
+        "Shared Internally": "",
+        "Shared Externally": "",
+        "Report Date": "2022-11-26",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+    2022-11-26,3,,,,2022-11-26,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+    2022-11-26,3,,,,2022-11-26,7
+    ```

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

@@ -11,10 +11,10 @@ m365 spo report activitypages [options]
 ## Options
 
 `-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -37,3 +37,32 @@ Gets the number of unique pages visited by users for the last week and exports t
 ```sh
 m365 spo report activitypages --period D7 --output json > "activitypages.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-26",
+        "Visited Page Count": "10",
+        "Report Date": "2022-11-26",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Visited Page Count,Report Date,Report Period
+    2022-11-26,10,2022-11-26,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Visited Page Count,Report Date,Report Period
+    2022-11-26,10,2022-11-26,7
+    ```

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

@@ -11,10 +11,10 @@ m365 spo report activityusercounts [options]
 ## Options
 
 `-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -41,3 +41,36 @@ Gets the trend in the number of active users for the last week and exports the r
 ```sh
 m365 spo report activityusercounts --period D7 --output json > "activityusercounts.json"
 ```
+
+## Response
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```

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

@@ -11,13 +11,13 @@ m365 spo report activityuserdetail [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 the date or period, but not both.
+: 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`
+: 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
+: Path to the file where the Microsoft Teams device usage by user report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -50,3 +50,40 @@ Gets details about SharePoint activity by user for the last week and exports the
 ```sh
 m365 spo report activityuserdetail --period D7 --output json > "activityuserdetail.json"
 ```
+
+## Response
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```

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

@@ -11,13 +11,13 @@ 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 the date or period, but not both.
+: 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`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -50,3 +50,43 @@ Gets details about SharePoint site usage for the last week and exports the repor
 ```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
+    ```

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

@@ -11,10 +11,10 @@ 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`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -41,3 +41,34 @@ Get the total number of files across all sites and the number of active files fo
 ```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
+    ```

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

@@ -11,10 +11,10 @@ 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`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -37,3 +37,33 @@ Gets the number of pages viewed across all sites for the last week and exports t
 ```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
+    ```

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

@@ -11,10 +11,10 @@ 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`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -41,3 +41,34 @@ Gets the total number of files across all sites and the number of active files f
 ```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
+    ```

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

@@ -11,10 +11,10 @@ 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`
+: 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
+: Path to the file where the report should be stored in.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -37,3 +37,33 @@ Gets the trend of storage allocated and consumed during the last week and export
 ```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
+    ```

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

@@ -0,0 +1,47 @@
+# 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.