@pnp/cli-microsoft365 6.1.0-beta.825554 → 6.1.0-beta.c68d208

package/docs/docs/cmd/spo/list/{list-label-get.md → list-retentionlabel-get.md}

@@ -1,11 +1,17 @@
-# spo list label get
+# spo list retentionlabel get
 
-Gets label set on the specified list
+Gets the default retention label set on the specified list or library.
 
 ## Usage
 
 ```sh
-m365 spo list label get  [options]
+m365 spo list retentionlabel get [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label get [options]
 ```
 
 ## Options
@@ -26,28 +32,28 @@ m365 spo list label get  [options]
 
 ## Examples
 
-Gets label set on the list with specified title located in the specified site.
+Gets retention label set on the list with specified title located in the specified site.
 
 ```sh
-m365 spo list label get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified id located in the specified site.
+Gets retention label set on the list with specified id located in the specified site.
 
 ```sh
-m365 spo list label get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified server relative url located in the specified site.
+Gets retention label set on the list with specified server relative url located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified site-relative URL located in the specified site.
+Gets retention label set on the list with specified site-relative URL located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
 ## Response

package/docs/docs/cmd/spo/list/list-retentionlabel-set.md

@@ -0,0 +1,65 @@
+# spo list retentionlabel set
+
+Sets a default retention label on the specified list or library.
+
+## Usage
+
+```sh
+m365 spo list retentionlabel set [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located
+
+`--label <label>`
+: The label to set on the list
+
+`-t, --listTitle [listTitle]`
+: The title of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`-l, --listId [listId]`
+: The ID of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--syncToItems`
+: Specify, to set the label on all existing items in the list
+
+`--blockDelete`
+: Specify, to disallow deleting items in the list
+
+`--blockEdit`
+: Specify, to disallow editing items in the list
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items. 
+
+## Examples
+
+Sets retention label "Some label" on the list _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
+```
+
+Sets retention label "Some label" and disables editing and deleting items on the list and all existing items for list for list _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,13 +11,13 @@ m365 spo orgassetslibrary add [options]
 ## Options
 
 `--libraryUrl <libraryUrl>`
-: The URL of the library to promote
+: The URL of the library to promote.
 
 `--thumbnailUrl <thumbnailUrl>`
-: The URL of the thumbnail to render
+: The URL of the thumbnail to render.
 
 `--cdnType [cdnType]`
-: Specifies the CDN type. `Public,Private`. Default is `Private`
+: Specifies the CDN type. Allowed values `Public`, `Private`. Default `Private`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -29,11 +29,15 @@ m365 spo orgassetslibrary add [options]
 Promotes an existing library to become an organization assets library
 
 ```sh
-m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/assets"
+m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/SiteAssets"
 ```
 
 Promotes an existing library to become an organization assets library with Thumbnail
 
 ```sh
-m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/assets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
+m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/SiteAssets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md

@@ -22,3 +22,45 @@ List all libraries that are assigned as asset library
 ```sh
 m365 spo orgassetslibrary list
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    {
+      "Url": "/",
+      "Libraries": [
+        {
+          "DisplayName": "Site Assets",
+          "LibraryUrl": "SiteAssets",
+          "ListId": "/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/",
+          "ThumbnailUrl": null
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Libraries: [{"DisplayName":"Site Assets","LibraryUrl":"SiteAssets","ListId":"/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/","ThumbnailUrl":null}]
+    Url      : /
+    ```
+
+=== "CSV"
+
+    ```csv
+    Url,Libraries
+    /,"[{""DisplayName"":""Site Assets"",""LibraryUrl"":""SiteAssets"",""ListId"":""/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/"",""ThumbnailUrl"":null}]"
+    ```
+
+### Response when no library is assigned as asset library
+
+=== "Text"
+
+    ```text
+    No libraries in Organization Assets
+    ```

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

@@ -11,10 +11,10 @@ m365 spo orgassetslibrary remove [options]
 ## Options
 
 `--libraryUrl <libraryUrl>`
-: The server relative URL of the library to be removed as a central location for organization assets
+: The server relative URL of the library to be removed as a central location for organization assets.
 
 `--confirm`
-: Don't prompt for confirming removing the organization asset library
+: Don't prompt for confirming removing the organization asset library.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -23,8 +23,30 @@ m365 spo orgassetslibrary remove [options]
 
 ## Examples
 
-Removes organization assets library without confirmation
+Removes organization assets library without prompting for confirmation
 
 ```sh
 m365 spo orgassetslibrary remove --libraryUrl "/sites/branding/assets" --confirm
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "IsNull": false
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    IsNull: false
+    ```
+
+=== "CSV"
+
+    ```csv
+    IsNull
+    ```

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md

@@ -22,3 +22,25 @@ List all organizational news sites
 ```sh
 m365 spo orgnewssite list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      "https://contoso.sharepoint.com/sites/contosoNews"
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    https://contoso.sharepoint.com/sites/contosoNews
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://contoso.sharepoint.com/sites/contosoNews
+    ```

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

@@ -11,10 +11,10 @@ m365 spo orgnewssite remove [options]
 ## Options
 
 `-u, --url <url>`
-: Absolute URL of the site to remove
+: Absolute URL of the site to remove.
 
 `--confirm`
-: Don't prompt for confirmation
+: Don't prompt for confirmation.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -34,3 +34,7 @@ Remove a site from the list of organizational news sites, without prompting for
 ```sh
 m365 spo orgnewssite remove --url https://contoso.sharepoint.com/sites/site1 --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,7 +11,7 @@ m365 spo orgnewssite set [options]
 ## Options
 
 `-u, --url <url>`
-: The URL of the site to mark as an organizational news site
+: The URL of the site to mark as an organizational news site.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -29,3 +29,7 @@ Set a site as an organizational news site
 ```sh
 m365 spo orgnewssite set --url https://contoso.sharepoint.com/sites/site1
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,31 +11,31 @@ m365 spo page add [options]
 ## Options
 
 `-n, --name <name>`
-: Name of the page to create
+: Name of the page to create.
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the page should be created
+: 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
+: 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`
+: 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`
+: Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`, `Template`.
 
 `--commentsEnabled`
-: Set to enable comments on the page
+: Set to enable comments on the page.
 
 `--publish`
-: Set to publish the page
+: Set to publish the page.
 
 `--publishMessage [publishMessage]`
-: Message to set when publishing the page
+: Message to set when publishing the page.
 
 `--description [description]`
-: The description to set for the page
+: The description to set for the page.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -100,3 +100,7 @@ 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.md

@@ -23,10 +23,10 @@ m365 spo page clientsidewebpart add [options]
 : 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 `webPartProperties` or `webPartData` but not both.
+: 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 `webPartProperties` or `webPartData` but not both.
+: 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).
@@ -79,3 +79,7 @@ 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.md

@@ -11,16 +11,16 @@ m365 spo page column get [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the page to retrieve is located
+: URL of the site where the page to retrieve is located.
 
 `-n, --pageName <pageName>`
-: Name of the page to get column information of
+: Name of the page to get column information of.
 
 `-s, --section <section>`
-: ID of the section where the column is located
+: ID of the section where the column is located.
 
 `-c, --column <column>`
-: ID of the column for which to retrieve more information
+: ID of the column for which to retrieve more information.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -30,8 +30,71 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
 
 ## Examples
 
-Get information about the first column in the first section of a modern page with name _home.aspx_
+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
+
+=== "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"
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    controls: 7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
+    factor  : 12
+    order   : 1
+    ```
+
+=== "CSV"
+
+    ```csv
+    factor,order,controls
+    12,1,7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
+    ```

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

@@ -11,13 +11,13 @@ m365 spo page column list [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the page to retrieve is located
+: URL of the site where the page to retrieve is located.
 
 `-n, --pageName <pageName>`
-: Name of the page to list columns of
+: Name of the page to list columns of.
 
 `-s, --section <sectionId>`
-: ID of the section for which to list columns
+: ID of the section for which to list columns.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -27,8 +27,40 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
 
 ## Examples
 
-List columns in the first section of a modern page with name _home.aspx_
+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
+
+=== "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
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    controls: 1
+    factor  : 12
+    order   : 1
+    ```
+
+=== "CSV"
+
+    ```csv
+    factor,order,controls
+    12,1,1
+    ```

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

@@ -11,13 +11,13 @@ m365 spo page control get [options]
 ## Options
 
 `-i, --id <id>`
-: ID of the control to retrieve information for
+: ID of the control to retrieve information for.
 
 `-n, --pageName <pageName>`
-: Name of the page where the control is located
+: Name of the page where the control is located.
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the page to retrieve is located
+: URL of the site where the page to retrieve is located.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -32,3 +32,70 @@ Get information about the control with ID _3ede60d3-dc2c-438b-b5bf-cc40bb2351e1_
 ```sh
 m365 spo page control get --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
 ```
+
+
+## Response
+
+=== "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": {}
+          }
+        }
+      }
+    }
+    ```
+
+=== "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
+    ```
+
+=== "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"":{}}}}"
+    ```