@pnp/cli-microsoft365 10.0.0-beta.7dfc31a → 10.0.0-beta.a0367997

package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx

@@ -0,0 +1,125 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo folder sharinglink add
+
+Creates a new sharing link to a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--type <type>`
+: The type of sharing link to create. Either `view` or `edit`.
+
+`--expirationDateTime [expirationDateTime]`
+: The date and time to set the expiration. This should be defined as a valid ISO 8601 string.
+
+`--scope [scope]`
+: The scope of link to create. Either `anonymous`, `organization` or `users`. If not specified, the default of the organization will be used.
+
+`--retainInheritedPermissions [retainInheritedPermissions]`
+: If `true`, any existing inherited permissions are retained on the shared item when sharing this item for the first time. If `false`, all existing permissions are removed when sharing for the first time.
+
+`--recipients [recipients]`
+: Comma separated list of users with whom we wish to share the item with. Required when using scope `users`.
+```
+
+<Global />
+
+## Examples
+
+Creates a view-only anonymous sharing link of a folder by id.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --type view --scope anonymous
+```
+
+Creates an edit organization sharing link of a folder by url with a specific expiration date.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl /sites/demo/shared%20documents/Folder --type edit --scope organization --expirationDateTime '2022-11-30T00:00:00Z'
+```
+
+Creates a user sharing link of a folder by id.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --type view --scope users --recipients john@contoso.com,doe@contoso.com
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "4fe11ccb-6c83-4927-8072-95642422b8ae",
+    "roles": [
+      "read"
+    ],
+    "shareId": "u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE",
+    "hasPassword": false,
+    "link": {
+      "scope": "anonymous",
+      "type": "view",
+      "webUrl": "https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcB3GZDQ6UaCup4HVxZbGnfFA",
+      "preventsDownload": false
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  hasPassword: false
+  id         : 4fe11ccb-6c83-4927-8072-95642422b8ae
+  link       : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcB3GZDQ6UaCup4HVxZbGnfFA","preventsDownload":false}
+  roles      : ["read"]
+  shareId    : u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,shareId,hasPassword
+  4fe11ccb-6c83-4927-8072-95642422b8ae,u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo folder sharinglink add --webUrl "https://contoso.sharepoint.com" --folderUrl "/shared documents/folder1" --type "view" --scope "anonymous"
+
+  Date: 29/04/2024
+
+  ## 4fe11ccb-6c83-4927-8072-95642422b8ae
+
+  Property | Value
+  ---------|-------
+  id | 4fe11ccb-6c83-4927-8072-95642422b8ae
+  shareId | u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE
+  hasPassword | false
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder sharinglink clear
+
+Removes sharing links of a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink clear [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The Unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`-s, --scope [scope]`
+: Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes all sharing links from a folder specified by id without prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --force
+```
+
+Removes sharing links of type anonymous from a folder specified by url with prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl '/sites/demo/Shared Documents/folder1' --scope anonymous
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder sharinglink remove
+
+Removes a specific sharing link of a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`-i, --id <id>`
+: The ID of the sharing link.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes a specific sharing link from a folder by id without prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --force
+```
+
+Removes a specific sharing link from a folder by url with prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl /sites/demo/shared%20documents/Folder --id c391b57d-5783-4c53-9236-cefb5c6ef323
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -20,7 +20,7 @@ m365 spo hidedefaultthemes 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/hidedefaultthemes/hidedefaultthemes-set.mdx

@@ -23,7 +23,7 @@ m365 spo hidedefaultthemes set [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/homesite/homesite-remove.mdx

@@ -25,7 +25,7 @@ m365 spo homesite remove [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/knowledgehub/knowledgehub-get.mdx

@@ -20,7 +20,7 @@ m365 spo knowledgehub 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/knowledgehub/knowledgehub-remove.mdx

@@ -25,7 +25,7 @@ m365 spo knowledgehub remove [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/knowledgehub/knowledgehub-set.mdx

@@ -27,7 +27,7 @@ If the specified url doesn't refer to an existing site collection, you will get
 
 :::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/orgassetslibrary/orgassetslibrary-add.mdx

@@ -32,7 +32,7 @@ m365 spo orgassetslibrary 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/orgassetslibrary/orgassetslibrary-list.mdx

@@ -20,7 +20,7 @@ m365 spo orgassetslibrary 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/orgassetslibrary/orgassetslibrary-remove.mdx

@@ -28,7 +28,7 @@ m365 spo orgassetslibrary remove [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/orgnewssite/orgnewssite-list.mdx

@@ -20,7 +20,7 @@ m365 spo orgnewssite 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/orgnewssite/orgnewssite-remove.mdx

@@ -26,7 +26,7 @@ m365 spo orgnewssite remove [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/orgnewssite/orgnewssite-set.mdx

@@ -25,7 +25,7 @@ Using the `-u, --url` option you can specify which site to add to the list of or
 
 :::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/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>