@pnp/cli-microsoft365 6.0.0-beta.3a04435 → 6.0.0-beta.3bf0c3c

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

@@ -11,31 +11,31 @@ m365 spo page clientsidewebpart add [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the page to add the web part to is located
+: 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
+: 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)
+: 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
+: 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 `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 `webPartProperties` or `webPartData` but not both.
 
 `--section [section]`
-: Number of the section to which the web part should be added (1 or higher)
+: 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)
+: 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
+: Order of the web part in the column.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -45,7 +45,8 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
 
 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_.
 
-When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
+!!! warning "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.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
 
 ## Examples
 
@@ -67,20 +68,14 @@ Add a custom web part to the modern page
 m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --webPartId 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1
 ```
 
-Using PowerShell, add the standard Bing Map web part with the specific properties to a modern page
-
-```PowerShell
-m365 --% spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties `"{""Title"":""Foo location""}"`
-```
-
-Using Windows command line, add the standard Bing Map web part with the specific properties to a modern page
+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""}"`
+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}}`'
+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}}'
 ```

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

@@ -31,7 +31,8 @@ m365 spo page control set [options]
 
 If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
 
-When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
+!!! warning "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.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
 
 ## Examples
 

package/docs/docs/cmd/spo/site/site-hubsite-connect.md

@@ -20,9 +20,6 @@ m365 spo site hubsite connect [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
-
 If the specified site collection is already connected to a hub site, it will be disconnected and connected to the newly specified hub site.
 
 If the specified `id` doesn't point to a valid hub site, you will get a `ResourceNotFoundException` error.

package/docs/docs/cmd/spo/site/site-hubsite-disconnect.md

@@ -18,11 +18,6 @@ m365 spo site hubsite disconnect [options]
 
 --8<-- "docs/cmd/_global.md"
 
-## Remarks
-
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
-
 ## Examples
 
 Disconnect a specific site collection from its hub site. Will prompt for confirmation before disconnecting from the hub site.

package/docs/docs/cmd/spo/site/site-hubsite-theme-sync.md

@@ -0,0 +1,28 @@
+# spo site hubsite theme sync
+
+Applies any theme updates from the hub site the site is connected to.
+
+## Usage
+
+```sh
+m365 spo site hubsite theme sync [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site to apply theme updates from the hub site to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Applies any theme updates from the hub site to a specific site
+
+```sh
+m365 spo site hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## More information
+
+- SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

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

@@ -11,10 +11,10 @@ m365 spo sitedesign get [options]
 ## Options
 
 `-i, --id [id]`
-: Site design ID. Specify either id or title but not both
+: Site design ID. Specify either `id` or `title` but not both.
 
 `--title [title]`
-: Site design title. Specify either id or title but not both
+: Site design title. Specify either `id` or `title` but not both.
 
 --8<-- "docs/cmd/_global.md"
 

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

@@ -23,3 +23,26 @@ Get the context URL for the root SharePoint site collection and SharePoint tenan
 ```sh
 m365 spo get --output json
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "SpoUrl": "https://contoso.sharepoint.com"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    SpoUrl: https://contoso.sharepoint.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    SpoUrl
+    https://contoso.sharepoint.com
+    ```

package/docs/docs/cmd/spo/spo-search.md

@@ -109,3 +109,32 @@ Return only items from a specific result source (using the source id).
 ```sh
 m365 spo search --queryText "*" --sourceId "6e71030e-5e16-4406-9bff-9c1829843083"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Title": "Document",
+        "OriginalPath": "https://contoso.sharepoint.com/Shared Documents/Document.docx"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Title                    OriginalPath
+    -----------------------  --------------------------------------------------------------------------------------------------------
+    Document                 https://contoso.sharepoint.com/Shared Documents/Document.docx
+    ```
+
+=== "CSV"
+
+    ```csv
+    Title,OriginalPath
+    Document,https://contoso.sharepoint.com/Shared Documents/Document.docx
+    ```
+

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

@@ -26,3 +26,7 @@ Set SPO URL to the specified URL
 ```sh
 m365 spo set --url https://contoso.sharepoint.com
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -45,6 +45,11 @@ m365 spo term add [options]
 !!! important
     To use this command you have to have permissions to access the tenant admin site.
 
+## Remarks
+
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--customProperties` and/or `--localCustomProperties` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
 ## Examples
 
 Add taxonomy term with the specified name to the term group and term set specified by their names

package/docs/docs/cmd/spo/term/term-set-add.md

@@ -33,6 +33,11 @@ m365 spo term set add [options]
 !!! important
     To use this command you have to have permissions to access the tenant admin site.
 
+## Remarks
+
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--customProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
 ## Examples
 
 Add taxonomy term set to the term group specified by ID
@@ -56,5 +61,5 @@ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-
 Add taxonomy term set and set its custom properties
 
 ```sh
-m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '`{"Property":"Value"}`'
+m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '{"Property":"Value"}'
 ```

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

@@ -38,9 +38,56 @@ Get user with ID _6_ for web _https://contoso.sharepoint.com/sites/project-x_
 m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6
 ```
 
-Get user with login name 'i:0#.f
-: membership|john.doe@mytenant.onmicrosoft.com' for web _https://contoso.sharepoint.com/sites/project-x_
+Get user with login name 'i:0#.f|membership|john.doe@mytenant.onmicrosoft.com' for web _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
 m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "Id": 10,
+      "IsHiddenInUI": false,
+      "LoginName": "i:0#.f|membership|johndoe@contoso.onmicrosoft.com",
+      "Title": "John Doe",
+      "PrincipalType": 1,
+      "Email": "johndoe@contoso.onmicrosoft.com",
+      "Expiration": "",
+      "IsEmailAuthenticationGuestUser": false,
+      "IsShareByEmailGuestUser": false,
+      "IsSiteAdmin": false,
+      "UserId": {
+        "NameId": "100320022ec308a7",
+        "NameIdIssuer": "urn:federation:microsoftonline"
+      },
+      "UserPrincipalName": "johndoe@contoso.onmicrosoft.com"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Email                         : johndoe@contoso.onmicrosoft.com
+    Expiration                    :
+    Id                            : 10
+    IsEmailAuthenticationGuestUser: false
+    IsHiddenInUI                  : false
+    IsShareByEmailGuestUser       : false
+    IsSiteAdmin                   : false
+    LoginName                     : i:0#.f|membership|johndoe@contoso.onmicrosoft.com
+    PrincipalType                 : 1
+    Title                         : John Doe
+    UserId                        : {"NameId":"100320022ec308a7","NameIdIssuer":"urn:federation:microsoftonline"}
+    UserPrincipalName             : johndoe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserId,UserPrincipalName
+    10,,i:0#.f|membership|johndoe@contoso.onmicrosoft.com,John Doe,1,johndoe@contoso.onmicrosoft.com,,,,,"{""NameId"":""100320022ec308a7"",""NameIdIssuer"":""urn:federation:microsoftonline""}",johndoe@contoso.onmicrosoft.com
+    ```

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

@@ -22,3 +22,44 @@ Get list of users in web _https://contoso.sharepoint.com/sites/project-x_
 ```sh
 m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Id": 10,
+        "IsHiddenInUI": false,
+        "LoginName": "i:0#.f|membership|johndoe@contoso.onmicrosoft.com",
+        "Title": "John DOe",
+        "PrincipalType": 1,
+        "Email": "johndoe@contoso.onmicrosoft.com",
+        "Expiration": "",
+        "IsEmailAuthenticationGuestUser": false,
+        "IsShareByEmailGuestUser": false,
+        "IsSiteAdmin": false,
+        "UserId": {
+          "NameId": "100320022ec308a7",
+          "NameIdIssuer": "urn:federation:microsoftonline"
+        },
+        "UserPrincipalName": "johndoe@contoso.onmicrosoft.com"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Id          Title                           LoginName
+    ----------  ------------------------------  --------------------------------------------------------------------------
+    10          John Doe                        i:0#.f|membership|johndoe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    Id,Title,LoginName
+    10,John Doe,i:0#.f|membership|johndoe@contoso.onmicrosoft.com
+    ```

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

@@ -42,6 +42,10 @@ Removes user with login name _i:0#.f|membership|john.doe@mytenant.onmicrosoft.co
 m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Remove-PnPUser - [https://docs.microsoft.com/en-us/powershell/module/sharepoint-pnp/remove-pnpuser?view=sharepoint-ps](https://docs.microsoft.com/en-us/powershell/module/sharepoint-pnp/remove-pnpuser?view=sharepoint-ps)