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

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

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo page add
+
+Creates modern page
+
+## Usage
+
+```sh
+m365 spo page add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: Name of the page to create.
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the page should be created.
+
+`-t, --title [title]`
+: Title of the page to create. If not specified, will use the page name as its title.
+
+`-l, --layoutType [layoutType]`
+: Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`, `HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`.
+
+`-p, --promoteAs [promoteAs]`
+: Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`, `Template`.
+
+`--commentsEnabled`
+: Set to enable comments on the page.
+
+`--publish`
+: Set to publish the page.
+
+`--publishMessage [publishMessage]`
+: Message to set when publishing the page.
+
+`--description [description]`
+: The description to set for the page.
+```
+
+<Global />
+
+## Remarks
+
+If you try to create a page with a name of a page that already exists, you will get a `The file exists` error.
+
+If you choose to promote the page using the `promoteAs` option or enable page comments, you will see the result only after publishing the page.
+
+## Examples
+
+Create new modern page. Use the Article layout
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team
+```
+
+Create new modern page and set its title
+
+```sh
+m365 spo page add --name new-page.aspx --title 'My page' --webUrl https://contoso.sharepoint.com/sites/a-team
+```
+
+Create new modern page. Use the Home page layout and include the default set of web parts
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --layoutType Home
+```
+
+Create new article page and promote it as a news article
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --promoteAs NewsPage
+```
+
+Create new page and set it as the site's home page
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --layoutType Home --promoteAs HomePage
+```
+
+Create new article page and promote it as a template
+
+```sh
+m365 spo page add --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --promoteAs Template
+```
+
+Create new article page and enable comments on the page
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --commentsEnabled
+```
+
+Create new article page and publish it
+
+```sh
+m365 spo page add --name new-page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --publish
+```
+
+Create new article page with description
+
+```sh
+m365 spo page add --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --description "Description to add for the page"
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,92 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo page clientsidewebpart add
+
+Adds a client-side web part to a modern page
+
+## Usage
+
+```sh
+m365 spo page clientsidewebpart add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to add the web part to is located.
+
+`-n, --pageName <pageName>`
+: Name of the page to which add the web part.
+
+`--standardWebPart [standardWebPart]`
+: Name of the standard web part to add (see the possible values below). Specify either `standardWebPart` or `webPartId` but not both.
+
+`--webPartId [webPartId]`
+: ID of the custom web part to add. Specify either `standardWebPart` or `webPartId` but not both.
+
+`--webPartProperties [webPartProperties]`
+: JSON string with web part properties to set on the web part. Specify either `webPartProperties` or `webPartData` but not both.
+
+`--webPartData [webPartData]`
+: JSON string with web part data as retrieved from the web part maintenance mode. Specify either `webPartProperties` or `webPartData` but not both.
+
+`--section [section]`
+: Number of the section to which the web part should be added (1 or higher).
+
+`--column [column]`
+: Number of the column in which the web part should be added (1 or higher).
+
+`--order [order]`
+: Order of the web part 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.
+
+To add a standard web part to the page, specify one of the following values: _ContentRollup, BingMap, ContentEmbed, DocumentEmbed, Image, ImageGallery, LinkPreview, NewsFeed, NewsReel, PowerBIReportEmbed, QuickChart, SiteActivity, VideoEmbed, YammerEmbed, Events, GroupCalendar, Hero, List, PageTitle, People, QuickLinks, CustomMessageRegion, Divider, MicrosoftForms, Spacer_.
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Add the standard Bing Map web part to a modern page in the first available location on the page
+
+```sh
+m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap
+```
+
+Add the standard Bing Map web part to a modern page in the third column of the second section
+
+```sh
+m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --section 2 --column 3
+```
+
+Add a custom web part to the modern page
+
+```sh
+m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --webPartId 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1
+```
+
+Add the standard Bing Map web part with the specific properties to a modern page
+
+```sh
+m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties '{"Title":"Foo location"}'
+```
+
+Add the standard Image web part with the preconfigured image
+
+```sh
+m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}'
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/page/page-column-get.mdx

@@ -0,0 +1,129 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo page column get
+
+Get information about a specific column of a modern page
+
+## Usage
+
+```sh
+m365 spo page column get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to retrieve is located.
+
+`-n, --pageName <pageName>`
+: Name of the page to get column information of.
+
+`-s, --section <section>`
+: ID of the section where the column is located.
+
+`-c, --column <column>`
+: ID of the column for which to retrieve more information.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `pageName` doesn't refer to an existing modern page, you will get a _File doesn't exists_ error.
+
+## Examples
+
+Get information about the first column in the first section of a modern page
+
+```sh
+m365 spo page column get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1 --column 1
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "factor": 12,
+    "order": 1,
+    "dataVersion": "1.0",
+    "jsonData": "&#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;12,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;",
+    "controls": [
+      {
+        "controlType": 3,
+        "dataVersion": "1.0",
+        "order": 1,
+        "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+        "controlData": {
+          "controlType": 3,
+          "displayMode": 2,
+          "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+          "position": {
+            "controlIndex": 1,
+            "sectionIndex": 1,
+            "zoneIndex": 1,
+            "sectionFactor": 12,
+            "layoutIndex": 1
+          },
+          "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+          "emphasis": {}
+        },
+        "title": "Bing Maps",
+        "description": "Display a location on a map using Bing Maps.",
+        "propertieJson": {
+          "pushPins": [],
+          "maxNumberOfPushPins": 1,
+          "shouldShowPushPinTitle": true,
+          "zoomLevel": 12,
+          "mapType": "road"
+        },
+        "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+        "htmlProperties": "",
+        "serverProcessedContent": null,
+        "canvasDataVersion": "1.0"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  controls: 7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
+  factor  : 12
+  order   : 1
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  factor,order,controls
+  12,1,7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo page column get --webUrl "https://contoso.sharepoint.com/sites/team-a" --pageName "home.aspx" --section "1" --column "1"
+
+  Date: 5/1/2023
+
+  Property | Value
+  ---------|-------
+  factor | 6
+  order | 1
+  dataVersion | 1.0
+  jsonData | &#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;6,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,96 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo page column list
+
+Lists columns in the specific section of a modern page
+
+## Usage
+
+```sh
+m365 spo page column list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to retrieve is located.
+
+`-n, --pageName <pageName>`
+: Name of the page to list columns of.
+
+`-s, --section <sectionId>`
+: ID of the section for which to list columns.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `pageName` doesn't refer to an existing modern page, you will get a _File doesn't exists_ error.
+
+## Examples
+
+List columns in the first section of a modern page
+
+```sh
+m365 spo page column list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1
+```
+
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "factor": 12,
+      "order": 1,
+      "dataVersion": "1.0",
+      "jsonData": "&#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;12,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;",
+      "controls": 1
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  controls: 1
+  factor  : 12
+  order   : 1
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  factor,order,controls
+  12,1,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo page column list --webUrl "https://contoso.sharepoint.com/sites/team-a" --pageName "home.aspx" --section "1"
+
+  Date: 5/1/2023
+
+  Property | Value
+  ---------|-------
+  factor | 6
+  order | 1
+  dataVersion | 1.0
+  jsonData | &#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;6,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;
+  controls | 1    
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/page/page-control-get.mdx

@@ -0,0 +1,133 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo page control get
+
+Gets information about the specific control on a modern page
+
+## Usage
+
+```sh
+m365 spo page control get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: ID of the control to retrieve information for.
+
+`-n, --pageName <pageName>`
+: Name of the page where the control is located.
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to retrieve is located.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
+
+## Examples
+
+Get information about the control with ID _3ede60d3-dc2c-438b-b5bf-cc40bb2351e1_ placed on a modern page with name _home.aspx_
+
+```sh
+m365 spo page control get --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
+```
+
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+    "type": "Client-side web part",
+    "title": "Bing Maps",
+    "controlType": 3,
+    "order": 1,
+    "controlData": {
+      "controlType": 3,
+      "displayMode": 2,
+      "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+      "position": {
+        "controlIndex": 1,
+        "sectionIndex": 1,
+        "zoneIndex": 1,
+        "sectionFactor": 12,
+        "layoutIndex": 1
+      },
+      "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+      "emphasis": {},
+      "webPartData": {
+        "dataVersion": "1.0",
+        "description": "Display a location on a map using Bing Maps.",
+        "id": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+        "instanceId": "7558d804-0334-49ca-b14a-53870cf6caae",
+        "properties": {
+          "pushPins": [],
+          "maxNumberOfPushPins": 1,
+          "shouldShowPushPinTitle": true,
+          "zoomLevel": 12,
+          "mapType": "road"
+        },
+        "title": "Bing Maps",
+        "serverProcessedContent": {
+          "htmlStrings": {},
+          "searchablePlainTexts": {},
+          "imageSources": {},
+          "links": {}
+        }
+      }
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  controlData: {"controlType":3,"displayMode":2,"id":"7558d804-0334-49ca-b14a-53870cf6caae","position":{"controlIndex":1,"sectionIndex":1,"zoneIndex":1,"sectionFactor":12,"layoutIndex":1},"webPartId":"e377ea37-9047-43b9-8cdb-a761be2f8e09","emphasis":{},"webPartData":{"dataVersion":"1.0","description":"Display a location on a map using Bing Maps.","id":"e377ea37-9047-43b9-8cdb-a761be2f8e09","instanceId":"7558d804-0334-49ca-b14a-53870cf6caae","properties":{"pushPins":[],"maxNumberOfPushPins":1,"shouldShowPushPinTitle":true,"zoomLevel":12,"mapType":"road"},"title":"Bing Maps","serverProcessedContent":{"htmlStrings":{},"searchablePlainTexts":{},"imageSources":{},"links":{}}}}
+  controlType: 3
+  id         : 7558d804-0334-49ca-b14a-53870cf6caae
+  order      : 1
+  title      : Bing Maps
+  type       : Client-side web part
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,type,title,controlType,order,controlData
+  7558d804-0334-49ca-b14a-53870cf6caae,Client-side web part,Bing Maps,3,1,"{""controlType"":3,""displayMode"":2,""id"":""7558d804-0334-49ca-b14a-53870cf6caae"",""position"":{""controlIndex"":1,""sectionIndex"":1,""zoneIndex"":1,""sectionFactor"":12,""layoutIndex"":1},""webPartId"":""e377ea37-9047-43b9-8cdb-a761be2f8e09"",""emphasis"":{},""webPartData"":{""dataVersion"":""1.0"",""description"":""Display a location on a map using Bing Maps."",""id"":""e377ea37-9047-43b9-8cdb-a761be2f8e09"",""instanceId"":""7558d804-0334-49ca-b14a-53870cf6caae"",""properties"":{""pushPins"":[],""maxNumberOfPushPins"":1,""shouldShowPushPinTitle"":true,""zoomLevel"":12,""mapType"":""road""},""title"":""Bing Maps"",""serverProcessedContent"":{""htmlStrings"":{},""searchablePlainTexts"":{},""imageSources"":{},""links"":{}}}}"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo page control get --id "f85f8dfa-9052-4be8-8954-8cdafe811b97" --webUrl "https://contoso.sharepoint.com/sites/team-a" --pageName "home.aspx"
+
+  Date: 5/1/2023
+
+  ## Bing Maps (f85f8dfa-9052-4be8-8954-8cdafe811b97)
+
+  Property | Value
+  ---------|-------
+  id | f85f8dfa-9052-4be8-8954-8cdafe811b97
+  type | Client-side web part
+  title | Bing Maps
+  controlType | 3
+  order | 1
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,129 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo page control list
+
+Lists controls on the specific modern page
+
+## Usage
+
+```sh
+m365 spo page control list [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --pageName <pageName>`
+: Name of the page to list controls of.
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the page to retrieve is located.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
+
+## Examples
+
+List controls on the modern page
+
+```sh
+m365 spo page control list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
+```
+
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+      "type": "Client-side web part",
+      "title": "Bing Maps",
+      "controlType": 3,
+      "order": 1,
+      "controlData": {
+        "controlType": 3,
+        "displayMode": 2,
+        "id": "7558d804-0334-49ca-b14a-53870cf6caae",
+        "position": {
+          "controlIndex": 1,
+          "sectionIndex": 1,
+          "zoneIndex": 1,
+          "sectionFactor": 12,
+          "layoutIndex": 1
+        },
+        "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+        "emphasis": {},
+        "webPartData": {
+          "dataVersion": "1.0",
+          "description": "Display a location on a map using Bing Maps.",
+          "id": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
+          "instanceId": "7558d804-0334-49ca-b14a-53870cf6caae",
+          "properties": {
+            "pushPins": [],
+            "maxNumberOfPushPins": 1,
+            "shouldShowPushPinTitle": true,
+            "zoomLevel": 12,
+            "mapType": "road"
+          },
+          "title": "Bing Maps",
+          "serverProcessedContent": {
+            "htmlStrings": {},
+            "searchablePlainTexts": {},
+            "imageSources": {},
+            "links": {}
+          }
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    title      type
+  ------------------------------------  ---------  ---------------------
+  7558d804-0334-49ca-b14a-53870cf6caae  Bing Maps  Client-side web part
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,type,title
+  7558d804-0334-49ca-b14a-53870cf6caae,Client-side web part,Bing Maps
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo page control list --webUrl "https://contoso.sharepoint.com/sites/team-a" --pageName "home.aspx"
+
+  Date: 5/1/2023
+
+  ## Bing Maps (f85f8dfa-9052-4be8-8954-8cdafe811b97)
+
+  Property | Value
+  ---------|-------
+  id | f85f8dfa-9052-4be8-8954-8cdafe811b97
+  type | Client-side web part
+  title | Bing Maps
+  controlType | 3
+  order | 1
+  ```
+
+  </TabItem>
+</Tabs>
+