@pnp/cli-microsoft365 10.0.0-beta.e925c1c → 10.0.0

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

@@ -13,36 +13,54 @@ m365 spo page remove [options]
 ## Options
 
 ```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page is located.
+
 `-n, --name <name>`
-: Name of the page to remove.
+: Name of the page.
 
-`-u, --webUrl <webUrl>`
-: URL of the site from which the page should be removed.
+`--recycle`
+: Send the page to the recycle bin instead of permanently deleting it.
+
+`--bypassSharedLock`
+: Remove the page even if it is locked for shared use.
 
 `-f, --force`
-: Do not prompt for confirmation before removing the page.
+: Do not prompt for confirmation.
 ```
 
 <Global />
 
-## Remarks
-
-If you try to remove a page with that does not exist, you will get a `The file does not exist` error.
-
-If you set the `-f, --force` flag, you will not be prompted for confirmation before the page is actually removed.
-
 ## Examples
 
 Remove a modern page
 
 ```sh
-m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing
 ```
 
 Remove a modern page without a confirmation prompt
 
 ```sh
-m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --force
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --force
+```
+
+Send a page to the recycle bin
+
+```sh
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --recycle
+```
+
+Remove a page that is locked
+
+```sh
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --bypassSharedLock
+```
+
+Remove a page that is located in a subfolder
+
+```sh
+m365 spo page remove --name /Departments/People/HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing
 ```
 
 ## Response

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

@@ -26,10 +26,46 @@ m365 spo page section add [options]
 : Order of the section to add.
 
 `--zoneEmphasis [zoneEmphasis]`
-: Section background shading. Allowed values `None`, `Neutral`, `Soft`, `Strong`
+: Section background shading. Allowed values `None`, `Neutral`, `Soft`, `Strong`, `Image`,`Gradient`
 
 `--isLayoutReflowOnTop`
-: The position of the Vertical section for smaller screens. Applied only for Vertical section.
+: The position of the Vertical section for smaller screens. Applied only for `Vertical` section.
+
+`--isCollapsibleSection`
+: Set section to be collapsible.
+
+`--showDivider`
+: Shows a divider line between sections.
+
+`--iconAlignment [iconAlignment]`
+: Specifies the alignment of the expand/collapse icon. Sets `Left` alignment if not specified.
+
+`--isExpanded`
+: Sets the default display state of the collapsible section. Sets `false` if not specified.
+
+`--gradientText [gradientText]`
+: Sets the gradient setting of the background of a section. Required when `zoneEmphasis` is `Gradient`.
+
+`--imageUrl [imageUrl]`
+: The background image URL. Required when `zoneEmphasis` is `Image`.
+
+`--imageHeight [imageHeight]`
+: The height of the background image. Applied only when when `zoneEmphasis` is `Image`. Sets `955` value if not specified.
+
+`--imageWidth [imageWidth]`
+: The width of the background image. Applied only when `zoneEmphasis` is `Image`. Sets `555` value if not specified.
+
+`--fillMode [fillMode]`
+: The fill mode of the background image. Applied only when `zoneEmphasis` is `Image`. Possible values are `ScaleToFill`, `ScaleToFit`, `Tile`, `OriginalSize`. Sets `ScaleToFill` value if not specified.
+
+`--useLightText`
+: Specifies whether to use light text for the background. Applied only when `zoneEmphasis` is `Image`.
+
+`--overlayColor [overlayColor]`
+:	The overlay color for the background in #RRGGBB format. Applied only when `zoneEmphasis` is `Image` or `Gradient`. Sets `#ffffff` value if not specified.
+
+`--overlayOpacity [overlayOpacity]`	
+: The overlay opacity for the background. Applied only when `zoneEmphasis` is `Image` or `Gradient`. Sets `60` value if not specified.
 ```
 
 <Global />
@@ -64,6 +100,25 @@ Add Vertical section with background shading to the modern page with adjusting t
 m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate Vertical --zoneEmphasis Neutral --isLayoutReflowOnTop
 ```
 
+Add OneColumn section as a collapsible section as expanded with icon alligned to the left
+
+```sh
+m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate OneColumn --isCollapsibleSection --isExpanded --iconAlignment Left
+```
+
+Add TwoColumn section with Image background
+
+```sh
+m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate TwoColumn --imageUrl "https://contoso.com/image.jpg" --zoneEmphasis Image --fillMode Tile
+```
+
+Add OneColumn section with Gradient background
+
+```sh
+m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate TwoColumn --zoneEmphasis Gradient --gradientText "linear-gradient(72.44deg, #E6FBFE 0%, #EDDDFB 100%)"
+```
+
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/spo/site/site-admin-add.mdx

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo site admin add 
+
+Adds a user or group as a site collection administrator
+
+## Usage
+
+```sh
+m365 spo site admin add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the SharePoint site
+
+`--userId [userId]`
+: The ID of the user to add as a site collection admin
+
+`--userName [userName]`
+: The user principal name of the user to add as a site collection admin
+
+`--groupId [groupId]`
+: The ID of the Microsoft Entra ID group to add as a site collection admin
+
+`--groupName [groupName]`
+: The name of the Microsoft Entra ID group to add as a site collection admin
+
+`--primary`
+: If set, will add the user as primary site collection admin. The old primary site collection admin will be replaced and set as secondary site collection admin
+
+`--asAdmin`
+: If specified, we will use the SharePoint admin center to execute the command
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command with the `--asAdmin` mode, you have to have permissions to access the tenant admin site.
+
+Without this parameter, you have to have site collection admin permissions for the requested site.
+
+:::
+
+## Examples
+
+Add user as primary site collection administrator
+
+```sh
+m365 spo site admin add --siteUrl https://contoso.sharepoint.com --userId 600713c5-53c6-4f24-b454-3c35e22b2639 --primary
+```
+
+Adds group as secondary site collection administrator as SharePoint admin
+
+```sh
+m365 spo site admin add --siteUrl https://contoso.sharepoint.com --groupName SP_Administrators --asAdmin
+```
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/site/site-admin-list.mdx

@@ -28,12 +28,10 @@ m365 spo site admin list [options]
 
 :::info
 
-To use this command with the `--asAdmin` mode, you must have permission to access the tenant admin site.
+To use this command with the `--asAdmin` mode, you must be at least SharePoint administrator.
 
 Without this parameter, you must have site collection admin permissions for the requested site.
 
-In `--asAdmin` mode, the Id, PrincipalType, and PrincipalTypeString properties are not exported.
-
 :::
 
 ## Examples
@@ -52,6 +50,8 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
 
 ## Response
 
+### Standard response
+
 <Tabs>
   <TabItem value="JSON">
 
@@ -73,13 +73,9 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
   <TabItem value="Text">
 
   ```text
-  Email               : user@contoso.com
-  Id                  : 6
-  LoginName           : i:0#.f|membership|user@contoso.com
-  PrincipalType       : 1
-  PrincipalTypeString : User
-  Title               : User Example
-  IsPrimaryAdmin      : true
+  Id  LoginName                                                                    Title    PrincipalTypeString
+  --  ---------------------------------------------------------------------------  -------  -------------------
+  15  c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a  Members  SecurityGroup
   ```
 
   </TabItem>
@@ -98,7 +94,7 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
 
   Date: 20/03/2024
 
-  ## User
+  ## User Example
 
   Property | Value
   ---------|-------
@@ -112,4 +108,60 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
   ```
 
   </TabItem>
-</Tabs>
+</Tabs>
+
+### `asAdmin` response
+
+When we make use of the option `asAdmin` the response will differ. 
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Email": "user@contoso.com",
+      "LoginName": "i:0#.f|membership|user@contoso.com",
+      "Title": "User Example",
+      "IsPrimaryAdmin": true
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  LoginName                                                                    Title          
+  ---------------------------------------------------------------------------  ---------------
+  c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a  Members        
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Email,LoginName,Title,IsPrimaryAdmin
+  user@contoso.com,i:0#.f|membership|user@contoso.com,User Example,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo site admin list --siteUrl "https://contoso.sharepoint.com/sites/Test" --asAdmin
+
+  Date: 20/03/2024
+
+  ## User Example
+
+  Property | Value
+  ---------|-------
+  Email | user@contoso.com
+  LoginName | i:0#.f\|membership\|user@contoso.com
+  Title | User Example
+  IsPrimaryAdmin | true
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spo/site/site-admin-remove.mdx

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo site admin remove
+
+Removes a user or group as site collection administrator
+
+## Usage
+
+```sh
+m365 spo site admin remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the SharePoint site
+
+`--userId [userId]`
+: The ID of the user to remove as a site collection admin
+
+`--userName [userName]`
+: The user principal name of the user to remove as a site collection admin
+
+`--groupId [groupId]`
+: The ID of the Microsoft Entra ID group to remove as a site collection admin
+
+`--groupName [groupName]`
+: The name of the Microsoft Entra ID group to remove as a site collection admin
+
+`--asAdmin`
+: If specified, we will use the SharePoint admin center to execute the command
+
+`-f, --force`
+: Don't prompt for confirmation
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command with the `--asAdmin` mode, you have to have permissions to access the tenant admin site.
+
+Without this parameter, you have to have site collection admin permissions for the requested site.
+
+:::
+
+## Examples
+
+Removes user as site collection admin
+
+```sh
+m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --userId 600713c5-53c6-4f24-b454-3c35e22b2639
+```
+
+Removes group as site collection admin without prompting for confirmation as SharePoint Admin
+
+```sh
+m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --groupName SP_Administrators --force --asAdmin
+```
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx

@@ -23,7 +23,7 @@ m365 spo site appcatalog add [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx

@@ -28,7 +28,7 @@ While the command uses the term *'remove'*, like its equivalent PowerShell cmdle
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/site/site-commsite-enable.mdx

@@ -29,7 +29,7 @@ m365 spo site commsite enable [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/site/site-set.mdx

@@ -103,7 +103,7 @@ Setting site properties is by default asynchronous and depending on the current
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/site/site-sharingpermission-set.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site sharingpermission set
+
+Controls how a site and its components can be shared
+
+## Usage
+
+```sh
+m365 spo site sharingpermission set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site.
+
+`--capability <capability>`
+: Define how the site is shared. Possible values: `full`, `limited`, `ownersOnly`.
+```
+
+<Global />
+
+## Remarks
+
+When specifying `capability`, consider the following:
+- `full`: Site owners and members can share files, folders, and the site. People with Edit permissions can share files and folders.
+- `limited`: Site owners and members, and people with Edit permissions can share files and folders, but only site owners can share the site.
+- `ownersOnly`: Only site owners can share files, folders, and the site.
+
+## Examples
+
+Update the sharing permissions for a site so only owners can share files and the site
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename  --capability ownersOnly
+```
+
+Update the sharing permissions for a site where so both owners and members can share files and the site
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename  --capability full
+```
+
+Update the sharing permissions for a site where so owners can share the site, but members can only share files
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename --capability limited
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Sharing a SharePoint site: [https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658](https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658)

package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx

@@ -51,7 +51,20 @@ m365 spo sitescript get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --content
 
   ```json
   {
-    "Content": "{\"$schema\":\"https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json\",\"actions\":[{\"verb\":\"activateSPFeature\",\"name\":\"SiteNotebook feature\",\"title\":\"SiteNotebook feature\",\"featureId\":\"f151bb39-7c3b-414f-bb36-6bf18872052f\",\"scope\":\"web\"}],\"bindata\":{},\"version\":1}",
+    "Content": { 
+      "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json",
+      "actions": [ 
+        {
+          "verb":"activateSPFeature",
+          "name": "SiteNotebook feature", 
+          "title": "SiteNotebook feature",
+          "featureId": "f151bb39-7c3b-414f-bb36-6bf18872052f", 
+          "scope": "web"
+        }
+      ], 
+      "bindata":{},
+      "version":1
+    },
     "ContentByteArray": null,
     "Description": "Contoso site script",
     "Id": "43d4ffa0-c7ee-4a97-91d7-db27e5b62de5",

package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx

@@ -31,7 +31,7 @@ Tenant properties are stored in the app catalog site associated with that tenant
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx

@@ -39,7 +39,7 @@ If you specify the URL of a site different than the app catalog, you will get an
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx

@@ -41,7 +41,7 @@ Creating an app catalog site might take a while. If you need to wait for the sit
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx

@@ -20,7 +20,7 @@ m365 spo tenant appcatalogurl get [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx

@@ -20,7 +20,7 @@ m365 spo tenant recyclebinitem list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx

@@ -31,7 +31,7 @@ Removing a site collection is by default asynchronous and depending on the curre
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx

@@ -20,7 +20,7 @@ m365 spo tenant settings list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::