@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.6a23aba

package/docs/docs/cmd/spo/page/page-template-list.mdx

@@ -0,0 +1,126 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo page template list
+
+Lists all page templates in the given site
+
+## Usage
+
+```sh
+m365 spo page template list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site from which to retrieve available pages.
+```
+
+<Global />
+
+## Examples
+
+Lists all page templates in the given site
+
+```sh
+m365 spo page template list --webUrl https://contoso.sharepoint.com/sites/team-a
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "AbsoluteUrl": "https://contoso.sharepoint.com/sites/SPDemo/SitePages/Templates/Company-Policy.aspx",
+      "AuthorByline": [
+        "i:0#.f|membership|user@contoso.com"
+      ],
+      "BannerImageUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/d22d83c8-3fb2-4168-8902-a29dc31e95b1/thumbnails/large.jpg?file=1131975775.jpg",
+      "BannerThumbnailUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/d22d83c8-3fb2-4168-8902-a29dc31e95b1/thumbnails/large.jpg?file=1131975775.jpg",
+      "CallToAction": "",
+      "Categories": null,
+      "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
+      "Description": "Company policy are set in place to establish the rules of conduct within an organization, outlining the responsibilities of both employees and employers. The management of company policy and procedures aim to protect the rights of workers as well as…",
+      "DoesUserHaveEditPermission": true,
+      "FileName": "Company-Policy.aspx",
+      "FirstPublished": "0001-01-01T08:00:00Z",
+      "Id": 27,
+      "IsPageCheckedOutToCurrentUser": false,
+      "IsWebWelcomePage": false,
+      "Modified": "2022-11-26T10:51:12Z",
+      "PageLayoutType": "Article",
+      "Path": {
+        "DecodedUrl": "SitePages/Templates/Company-Policy.aspx"
+      },
+      "PromotedState": 0,
+      "Title": "Company Policy",
+      "TopicHeader": null,
+      "UniqueId": "06509101-7e2f-4467-afd2-97bad4a53ef2",
+      "Url": "SitePages/Templates/Company-Policy.aspx",
+      "Version": "0.1",
+      "VersionInfo": {
+        "LastVersionCreated": "0001-01-01T00:00:00-08:00",
+        "LastVersionCreatedBy": ""
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  FileName             Id  PageLayoutType  Title           Url
+  -------------------  --  --------------  --------------  ----------------------------------------
+  Company-Policy.aspx  27  Article         Company Policy  SitePages/Templates/Company-Policy.aspx
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Title,FileName,Id,PageLayoutType,Url
+  Company Policy,Company-Policy.aspx,27,Article,SitePages/Templates/Company-Policy.aspx
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo page template list --webUrl "https://contoso.sharepoint.com/sites/team-a"
+
+  Date: 5/4/2023
+
+  ## template (12)
+
+  Property | Value
+  ---------|-------
+  AbsoluteUrl | https://contoso.sharepoint.com/sites/team-a/SitePages/Templates/Company-Policy.aspx
+  BannerImageUrl | https://contoso.sharepoint.com/\_layouts/15/images/sitepagethumbnail.png
+  BannerThumbnailUrl | https://media.akamai.odsp.cdn.office.net/contoso.sharepoint.com/\_layouts/15/images/sitepagethumbnail.png
+  CallToAction | 
+  ContentTypeId | 0x0101009D1CB255DA76424F860D91F20E6C41180015C00F3A91848C479243E57A8317E76E
+  DoesUserHaveEditPermission | true
+  FileName | template.aspx
+  FirstPublished | 0001-01-01T08:00:00Z
+  Id | 12
+  IsPageCheckedOutToCurrentUser | false
+  IsWebWelcomePage | false
+  Modified | 2023-05-04T09:37:10Z
+  PageLayoutType | Article
+  PromotedState | 0
+  Title | template
+  UniqueId | 318af790-8c04-4b34-b764-e47d6620bba2
+  Url | SitePages/Templates/template.aspx
+  Version | 0.1
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/page/page-text-add.mdx

@@ -0,0 +1,63 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo page text add
+
+Adds text to a modern page
+
+## Usage
+
+```sh
+m365 spo page text add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to add the text to is located.
+
+`-n, --pageName <pageName>`
+: Name of the page to which add the text.
+
+`-t, --text <text>`
+: Text to add to the page
+
+`--section [section]`
+: Number of the section to which the text should be added (1 or higher).
+
+`--column [column]`
+: Number of the column in which the text should be added (1 or higher).
+
+`--order [order]`
+: Order of the text in the column.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `pageName` doesn't refer to an existing modern page, you will get a _File doesn't exists_ error.
+
+## Examples
+
+Add text to a modern page in the first available location on the page
+
+```sh
+m365 spo page text add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --text 'Hello world'
+```
+
+Add text to a modern page in the third column of the second section
+
+```sh
+m365 spo page text add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --text 'Hello world' --section 2 --column 3
+```
+
+Add text at the beginning of the default column on a modern page
+
+```sh
+m365 spo page text add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --text 'Hello world' --order 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/propertybag/propertybag-get.mdx

@@ -0,0 +1,94 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo propertybag get
+
+Gets the value of the specified property from the property bag
+
+## Usage
+
+```sh
+m365 spo propertybag get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site from which the property bag value should be retrieved.
+
+`-k, --key <key>`
+: Key of the property for which the value should be retrieved. Case-sensitive.
+
+`-f, --folder [folder]`
+: Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.
+```
+
+<Global />
+
+## Examples
+
+Returns the value of the property from the property bag located in the given site
+
+```sh
+m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1
+```
+
+Returns the value of the property from the property bag located in root folder of the given site
+
+```sh
+m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /
+```
+
+Returns the value of the property from the property bag located in document library of the given site
+
+```sh
+m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'
+```
+
+Returns the value of the property from the property bag located in folder in a document library located in the given site
+
+```sh
+m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents/MyFolder'
+```
+
+Returns the value of the property from the property bag located in a list in the given site
+
+```sh
+m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /Lists/MyList
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  "Approved Rejected Pending\\ Review"
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Approved Rejected Pending\\ Review
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Approved Rejected Pending\ Review
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Approved Rejected Pending\ Review
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/propertybag/propertybag-list.mdx

@@ -0,0 +1,106 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo propertybag list
+
+Gets property bag values
+
+## Usage
+
+```sh
+m365 spo propertybag list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site from which the property bag value should be retrieved.
+
+`-f, --folder [folder]`
+: Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.
+```
+
+<Global />
+
+## Examples
+
+Return property bag values located in the given site
+
+```sh
+m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Return property bag values located in the given site root folder
+
+```sh
+m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /
+```
+
+Return property bag values located in the given site document library
+
+```sh
+m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents'
+```
+
+Return property bag values located in folder in the given site document library
+
+```sh
+m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents/MyFolder'
+```
+
+Return property bag values located in the given site list
+
+```sh
+m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /Lists/MyList
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "key": "vti_approvallevels",
+      "value": "Approved Rejected Pending\\ Review"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  key                   value                                                                             
+  --------------------  -----------------------------------
+  vti_approvallevels     Approved Rejected Pending\ Review
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  key,value
+  vti_approvallevels,Approved Rejected Pending\ Review
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo propertybag list --webUrl "https://contoso.sharepoint.com/sites/test"
+
+  Date: 5/6/2023
+
+  Property | Value
+  ---------|-------
+  key | vti_approvallevels
+  value | Approved Rejected Pending\ Review
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo propertybag remove
+
+Removes specified property from the property bag
+
+## Usage
+
+```sh
+m365 spo propertybag remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site from which the property should be removed.
+
+`-k, --key <key>`
+: 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.
+
+`--confirm`
+: Don't prompt for confirming removal of property bag value.
+```
+
+<Global />
+
+## Examples
+
+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 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 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 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 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.mdx

@@ -0,0 +1,69 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo propertybag set
+
+Sets the value of the specified property in the property bag. Adds the property if it does not exist
+
+## Usage
+
+```sh
+m365 spo propertybag set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site in which the property should be set
+
+`-k, --key <key>`
+: Key of the property to be set. Case-sensitive
+
+`-v, --value <value>`
+: Value of the property to be set
+
+`-f, --folder [folder]`
+: Site-relative URL of the folder on which the property should be set
+```
+
+<Global />
+
+## 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 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 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 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 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 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.mdx

@@ -0,0 +1,92 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report activityfilecounts
+
+Gets the number of unique, licensed users who interacted with files stored on SharePoint sites
+
+## Usage
+
+```sh
+m365 spo report activityfilecounts [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 unique, licensed users who interacted with files stored on SharePoint sites for the last week
+
+```sh
+m365 spo report activityfilecounts --period D7
+```
+
+Gets the number of unique, licensed users who interacted with files stored on SharePoint sites for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report activityfilecounts --period D7 --output text > "activityfilecounts.txt"
+```
+
+Gets the number of unique, licensed users who interacted with files stored on SharePoint sites for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report activityfilecounts --period D7 --output json > "activityfilecounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="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"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period
+  2023-05-04,10,,,,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo report activitypages
+
+Gets the number of unique pages visited by users
+
+## Usage
+
+```sh
+m365 spo report activitypages [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 unique pages visited by users for the last week
+
+```sh
+m365 spo report activitypages --period D7
+```
+
+Gets the number of unique pages visited by users for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 spo report activitypages --period D7 --output text > "activitypages.txt"
+```
+
+Gets the number of unique pages visited by users for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 spo report activitypages --period D7 --output json > "activitypages.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-26",
+      "Visited Page Count": "10",
+      "Report Date": "2022-11-26",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Visited Page Count,Report Date,Report Period
+  2022-11-26,10,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Visited Page Count,Report Date,Report Period
+  2022-11-26,10,2022-11-26,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Visited Page Count,Report Date,Report Period
+  2023-05-04,11,2023-05-04,7
+  ```
+
+  </TabItem>
+</Tabs>
+