@pnp/cli-microsoft365 6.0.0-beta.e1e0a1b → 6.0.0-beta.e42aed1

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

@@ -0,0 +1,37 @@
+# spo site hubsite connect
+
+Connects the specified site collection to the given hub site
+
+## Usage
+
+```sh
+m365 spo site hubsite connect [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: The URL of the site collection to connect to the hub site
+
+`-i, --id <id>`
+: The ID of the hub site to which to connect the site collection
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+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.
+
+## Examples
+
+Connect a specific site collection to a hub site
+
+```sh
+m365 spo site hubsite connect --siteUrl https://contoso.sharepoint.com/sites/contoso-sales --id 255a50b2-527f-4413-8485-57f4c17a24d1
+```
+
+## 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/site/site-hubsite-disconnect.md

@@ -0,0 +1,37 @@
+# spo site hubsite disconnect
+
+Disconnects the specified site collection from its hub site
+
+## Usage
+
+```sh
+m365 spo site hubsite disconnect [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: URL of the site collection to disconnect from its hub site
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Disconnect a specific site collection from its hub site. Will prompt for confirmation before disconnecting from the hub site.
+
+```sh
+m365 spo site hubsite disconnect --siteUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Disconnect a specific site collection from its hub site without prompting for confirmation.
+
+```sh
+m365 spo site hubsite disconnect --siteUrl https://contoso.sharepoint.com/sites/sales --confirm
+```
+
+## 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/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/site/site-rename.md

@@ -10,13 +10,13 @@ m365 spo site rename [options]
 
 ## Options
 
-`-u, --siteUrl <siteUrl>`
+`-u, --url <url>`
 : The URL of the site to rename
 
-`--newSiteUrl <newSiteUrl>`
+`--newUrl <newUrl>`
 : New URL for the site collection
 
-`--newSiteTitle [newSiteTitle]`
+`--newTitle [newTitle]`
 : New title for the site
 
 `--suppressMarketplaceAppCheck`
@@ -42,17 +42,17 @@ Renaming site collections is by default asynchronous and depending on the curren
 Starts the rename of the site collection with name "samplesite" to "renamed" without modifying the title
 
 ```sh
-m365 spo site rename --siteUrl http://contoso.sharepoint.com/samplesite --newSiteUrl http://contoso.sharepoint.com/renamed
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed
 ```
 
 Starts the rename of the site collection with name "samplesite" to "renamed" modifying the title of the site to "New Title"
 
 ```sh
-m365 spo site rename --siteUrl http://contoso.sharepoint.com/samplesite --newSiteUrl http://contoso.sharepoint.com/renamed --newSiteTitle "New Title"
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title"
 ```
 
 Renames the specified site collection and waits for the operation to complete
 
 ```sh
-m365 spo site rename --siteUrl http://contoso.sharepoint.com/samplesite --newSiteUrl http://contoso.sharepoint.com/renamed --newSiteTitle "New Title" --wait
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title" --wait
 ```

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/sitedesign/sitedesign-rights-grant.md

@@ -10,7 +10,7 @@ m365 spo sitedesign rights grant [options]
 
 ## Options
 
-`-i, --id <id>`
+`-i, --siteDesignId <siteDesignId>`
 : The ID of the site design to grant rights on
 
 `-p, --principals <principals>`
@@ -26,19 +26,19 @@ m365 spo sitedesign rights grant [options]
 Grant user with alias _PattiF_ view permission to the specified site design
 
 ```sh
-m365 spo sitedesign rights grant --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF --rights View
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF --rights View
 ```
 
 Grant users with aliases _PattiF_ and _AdeleV_ view permission to the specified site design
 
 ```sh
-m365 spo sitedesign rights grant --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals "PattiF,AdeleV" --rights View
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals "PattiF,AdeleV" --rights View
 ```
 
 Grant user with email _PattiF@contoso.com_ view permission to the specified site design
 
 ```sh
-m365 spo sitedesign rights grant --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF@contoso.com --rights View
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF@contoso.com --rights View
 ```
 
 ## More information

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-list.md

@@ -10,14 +10,14 @@ m365 spo sitedesign rights list [options]
 
 ## Options
 
-`-i, --id <id>`
+`-i, --siteDesignId <siteDesignId>`
 : The ID of the site design to get rights information from
 
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-If the specified `id` doesn't refer to an existing site script, you will get a `File not found` error.
+If the specified `siteDesignId` doesn't refer to an existing site script, you will get a `File not found` error.
 
 If no permissions are listed, it means that the particular site design is visible to everyone.
 
@@ -26,7 +26,7 @@ If no permissions are listed, it means that the particular site design is visibl
 Get information about rights granted for the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
 
 ```sh
-m365 spo sitedesign rights list --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+m365 spo sitedesign rights list --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 ```
 
 ## More information

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-revoke.md

@@ -10,7 +10,7 @@ m365 spo sitedesign rights revoke [options]
 
 ## Options
 
-`-i, --id <id>`
+`-i, --siteDesignId <siteDesignId>`
 : The ID of the site design to revoke rights from
 
 `-p, --principals <principals>`
@@ -34,13 +34,13 @@ If you try to revoke access for a user that doesn't have access granted to the s
 Revoke access to the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from user with alias _PattiF_. Will prompt for confirmation before revoking the access
 
 ```sh
-m365 spo sitedesign rights revoke --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals PattiF
+m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals PattiF
 ```
 
 Revoke access to the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from users with aliases _PattiF_ and _AdeleV_ without prompting for confirmation
 
 ```sh
-m365 spo sitedesign rights revoke --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals "PattiF,AdeleV" --confirm
+m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals "PattiF,AdeleV" --confirm
 ```
 
 ## More information

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

@@ -10,7 +10,7 @@ m365 spo sitedesign task get [options]
 
 ## Options
 
-`-i, --taskId <taskId>`
+`-i, --id <id>`
 : The ID of the site design task to get information for
 
 --8<-- "docs/cmd/_global.md"
@@ -20,7 +20,7 @@ m365 spo sitedesign task get [options]
 Get information about the specified site design scheduled for execution
 
 ```sh
-m365 spo sitedesign task get --taskId 6ec3ca5b-d04b-4381-b169-61378556d76e
+m365 spo sitedesign task get --id 6ec3ca5b-d04b-4381-b169-61378556d76e
 ```
 
 ## More information

package/docs/docs/cmd/spo/sitedesign/sitedesign-task-remove.md

@@ -10,7 +10,7 @@ m365 spo sitedesign task remove [options]
 
 ## Options
 
-`-i, --taskId <taskId>`
+`-i, --id <id>`
 : The ID of the site design task to remove
 
 `--confirm`
@@ -20,16 +20,16 @@ m365 spo sitedesign task remove [options]
 
 ## Examples
 
-Removes the specified site design task with taskId _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution without prompting confirmation
+Removes the specified site design task with id _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution without prompting confirmation
 
 ```sh
-m365 spo sitedesign task remove --taskId 6ec3ca5b-d04b-4381-b169-61378556d76e --confirm
+m365 spo sitedesign task remove --id 6ec3ca5b-d04b-4381-b169-61378556d76e --confirm
 ```
 
-Removes the specified site design task with taskId _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution with prompt for confirmation before removing
+Removes the specified site design task with id _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution with prompt for confirmation before removing
 
 ```sh
-m365 spo sitedesign task remove --taskId 6ec3ca5b-d04b-4381-b169-61378556d76e
+m365 spo sitedesign task remove --id 6ec3ca5b-d04b-4381-b169-61378556d76e
 ```
 
 ## More information

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/tenant/tenant-recyclebinitem-remove.md

@@ -10,7 +10,7 @@ m365 spo tenant recyclebinitem remove [options]
 
 ## Options
 
-`-u, --url`
+`-u, --siteUrl <siteUrl>`
 : URL of the site to remove
 
 `--wait`
@@ -33,11 +33,11 @@ Removing a site collection is by default asynchronous and depending on the curre
 Removes the specified deleted site collection from tenant recycle bin
 
 ```sh
-m365 spo tenant recyclebinitem remove --url https://contoso.sharepoint.com/sites/team
+m365 spo tenant recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/team
 ```
 
 Removes the specified deleted site collection from tenant recycle bin and wait for the removing process to complete
 
 ```sh
-m365 spo tenant recyclebinitem remove --url https://contoso.sharepoint.com/sites/team --wait
+m365 spo tenant recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/team --wait
 ```

package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md

@@ -10,9 +10,12 @@ m365 spo tenant recyclebinitem restore [options]
 
 ## Options
 
-`-u, --url`
+`-u, --siteUrl <siteUrl>`
 : URL of the site to restore
 
+`--wait`
+: Wait for the site collection to be restored before completing the command
+
 --8<-- "docs/cmd/_global.md"
 
 !!! important
@@ -27,11 +30,11 @@ Restoring deleted site collections is by default asynchronous and depending on t
 Restore a deleted site collection from tenant recycle bin
 
 ```sh
-m365 spo tenant recyclebinitem restore --url https://contoso.sharepoint.com/sites/team
+m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/sites/team
 ```
 
 Restore a deleted site collection from tenant recycle bin and wait for completion
 
 ```sh
-m365 spo tenant recyclebinitem restore --url https://contoso.sharepoint.com/sites/team --wait
+m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/sites/team --wait
 ```

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)