@pnp/cli-microsoft365 6.0.0-beta.e9e0f02 → 6.0.0-beta.eb11cbe

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md

@@ -21,11 +21,11 @@ m365 spo sp grant revoke
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
+!!! important
+    To use this command you must be a Global administrator.
+
 The permission grant you want to revoke is denoted using its `ObjectId`. You can retrieve it using the [spo serviceprincipal grant list](./serviceprincipal-grant-list.md) command.
 
 ## Examples

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md

@@ -21,11 +21,11 @@ m365 spo sp permissionrequest approve
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
+!!! important
+    The admin role that's required to approve permissions depends on the API. To approve permissions to any of the third-party APIs registered in the tenant, the application administrator role is sufficient. To approve permissions for Microsoft Graph or any other Microsoft API, the Global Administrator role is required.
+
 The permission request you want to approve is denoted using its `ID`. You can retrieve it using the [spo serviceprincipal permissionrequest list](./serviceprincipal-permissionrequest-list.md) command.
 
 ## Examples

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md

@@ -21,11 +21,11 @@ m365 spo sp permissionrequest deny
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
+!!! important
+    The admin role that's required to deny permissions depends on the API. To approve permissions to any of the third-party APIs registered in the tenant, the application administrator role is sufficient. To approve permissions for Microsoft Graph or any other Microsoft API, the Global Administrator role is required.
+
 The permission request you want to approve is denoted using its `ID`. You can retrieve it using the [spo serviceprincipal permissionrequest list](./serviceprincipal-permissionrequest-list.md) command.
 
 ## Examples

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md

@@ -18,8 +18,10 @@ m365 spo sp permissionrequest list
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
 !!! important
-    To use this command you have to have permissions to access the tenant admin site.
+    The admin role that's required to list permissions depends on the API. To approve permissions to any of the third-party APIs registered in the tenant, the application administrator role is sufficient. To approve permissions for Microsoft Graph or any other Microsoft API, the Global Administrator role is required.
 
 ## Examples
 

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

@@ -24,11 +24,11 @@ m365 spo sp set
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
+!!! important
+    To use this command you must be a Global administrator.
+
 Using the `-e, --enabled` option you can specify whether the service principal should be enabled or disabled. Use `true` to enable the service principal and `false` to disable it.
 
 ## Examples

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

@@ -46,9 +46,6 @@ m365 spo site add [options]
 `--siteDesignId [siteDesignId]`
 : Id of the custom site design to use to create the site. When creating a communication site, specify either `siteDesign` or `siteDesignId` (applies to type CommunicationSite)
 
-`--allowFileSharingForGuestUsers`
-: (deprecated. Use `shareByEmailEnabled` instead) Determines whether it's allowed to share file with guests (applies to type CommunicationSite)
-
 `--shareByEmailEnabled`
 : Determines whether it's allowed to share file with guests (applies to type CommunicationSite)
 
@@ -87,9 +84,9 @@ The value of the `--storageQuota` option must not exceed the company's available
 
 The value of the `--storageQuotaWarningLevel` option must not exceed the the value of the `--storageQuota` option.
 
-If you try to create a site with the same URL as a site that has been previously moved to the recycle bin, you will get an error. To avoid this error, you can use the `--removeDeletedSite` option. Prior to creating the site, the spo site classic add command will check if the site with the specified URL has been previously moved to the recycle bin and if so, will remove it. Because removing sites from the recycle bin might take a moment, it should be used in conjunction with the `--wait` option so that the new site is not created before the old site is fully removed.
+If you try to create a site with the same URL as a site that has been previously moved to the recycle bin, you will get an error. To avoid this error, you can use the `--removeDeletedSite` option. Prior to creating the site, the spo site add command will check if the site with the specified URL has been previously moved to the recycle bin and if so, will remove it. Because removing sites from the recycle bin might take a moment, it should be used in conjunction with the `--wait` option so that the new site is not created before the old site is fully removed.
 
-Deleting and creating classic site collections is by default asynchronous and depending on the current state of Office 365, might take up to few minutes. If you're building a script with steps that require the site to be fully provisioned, you should use the `--wait` flag. When using this flag, the spo site classic add command will keep running until it received confirmation from Office 365 that the site has been fully provisioned.
+Deleting and creating classic site collections is by default asynchronous and depending on the current state of Office 365, might take up to few minutes. If you're building a script with steps that require the site to be fully provisioned, you should use the `--wait` flag. When using this flag, the spo site add command will keep running until it received confirmation from Office 365 that the site has been fully provisioned.
 
 ## Remarks for modern sites
 

package/docs/docs/cmd/spo/site/site-apppermission-add.md

@@ -14,7 +14,7 @@ m365 spo site apppermission add [options]
 : URL of the site collection to add the permission
 
 `-p, --permission <permission>`
-: Permission to site (`read`, `write`, or `owner`)
+: Permission to site (`read`, `write`, `manage` or `fullcontrol`)
 
 `-i, --appId [appId]`
 : Client ID of the Azure AD app for which to grant permissions

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

@@ -23,7 +23,7 @@ m365 spo site apppermission set [options]
 : Display name of the Azure AD app for which to update permissions. Specify `id`, `appId` or `appDisplayName`
 
 `-p, --permission <permission>`
-: Permission to site (`read`, `write`, or `owner`)
+: Permission to site (`read`, `write`, `manage` or `fullcontrol`)
 
 --8<-- "docs/cmd/_global.md"
 

package/docs/docs/cmd/spo/site/site-groupify.md

@@ -11,12 +11,6 @@ Connects site collection to an Microsoft 365 Group
 m365 spo site groupify [options]
 ```
 
-## Alias
-
-```sh
-m365 spo site groupify
-```
-
 ## Options
 
 `-u, --url <url>`

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/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)