@pnp/cli-microsoft365 9.1.0-beta.4ee36d4 → 9.1.0-beta.94ae9ed

package/dist/m365/spo/commands/user/user-get.js

@@ -3,8 +3,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SpoUserGetCommand_instances, _SpoUserGetCommand_initTelemetry, _SpoUserGetCommand_initOptions, _SpoUserGetCommand_initValidators, _SpoUserGetCommand_initOptionSets;
+var _SpoUserGetCommand_instances, _SpoUserGetCommand_initTelemetry, _SpoUserGetCommand_initOptions, _SpoUserGetCommand_initTypes, _SpoUserGetCommand_initValidators, _SpoUserGetCommand_initOptionSets;
 import request from '../../../../request.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
@@ -23,23 +24,38 @@ class SpoUserGetCommand extends SpoCommand {
         __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initValidators).call(this);
         __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initOptionSets).call(this);
+        __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initTypes).call(this);
     }
     async commandAction(logger, args) {
         if (this.verbose) {
             await logger.logToStderr(`Retrieving information for user in site '${args.options.webUrl}'...`);
         }
-        let requestUrl = '';
+        let requestUrl = `${args.options.webUrl}/_api/web/`;
         if (args.options.id) {
-            requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetById('${formatting.encodeQueryParameter(args.options.id.toString())}')`;
+            requestUrl += `siteusers/GetById('${formatting.encodeQueryParameter(args.options.id.toString())}')`;
         }
         else if (args.options.email) {
-            requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(args.options.email)}')`;
+            requestUrl += `siteusers/GetByEmail('${formatting.encodeQueryParameter(args.options.email)}')`;
         }
         else if (args.options.loginName) {
-            requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetByLoginName('${formatting.encodeQueryParameter(args.options.loginName)}')`;
+            requestUrl += `siteusers/GetByLoginName('${formatting.encodeQueryParameter(args.options.loginName)}')`;
+        }
+        else if (args.options.userName) {
+            const user = await this.getUser(requestUrl, args.options.userName);
+            requestUrl += `siteusers/GetById('${formatting.encodeQueryParameter(user.Id.toString())}')`;
+        }
+        else if (args.options.entraGroupId || args.options.entraGroupName) {
+            const entraGroup = await this.getEntraGroup(args.options.entraGroupId, args.options.entraGroupName);
+            // For entra groups, M365 groups have an associated email and security groups don't
+            if (entraGroup?.mail) {
+                requestUrl += `siteusers/GetByEmail('${formatting.encodeQueryParameter(entraGroup.mail)}')`;
+            }
+            else {
+                requestUrl += `siteusers/GetByLoginName('c:0t.c|tenant|${entraGroup?.id}')`;
+            }
         }
         else {
-            requestUrl = `${args.options.webUrl}/_api/web/currentuser`;
+            requestUrl += `currentuser`;
         }
         const requestOptions = {
             url: requestUrl,
@@ -57,13 +73,38 @@ class SpoUserGetCommand extends SpoCommand {
             this.handleRejectedODataJsonPromise(err);
         }
     }
+    async getUser(baseUrl, userName) {
+        const requestUrl = `${baseUrl}siteusers?$filter=UserPrincipalName eq ('${formatting.encodeQueryParameter(userName)}')`;
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const userInstance = await request.get(requestOptions);
+        const userInstanceValue = userInstance.value[0];
+        if (!userInstanceValue) {
+            throw `User not found: ${userName}`;
+        }
+        return userInstanceValue;
+    }
+    async getEntraGroup(entraGroupId, entraGroupName) {
+        if (entraGroupId) {
+            return entraGroup.getGroupById(entraGroupId);
+        }
+        return entraGroup.getGroupByDisplayName(entraGroupName);
+    }
 }
 _SpoUserGetCommand_instances = new WeakSet(), _SpoUserGetCommand_initTelemetry = function _SpoUserGetCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             id: typeof args.options.id !== 'undefined',
             email: typeof args.options.email !== 'undefined',
-            loginName: typeof args.options.loginName !== 'undefined'
+            loginName: typeof args.options.loginName !== 'undefined',
+            userName: typeof args.options.userName !== 'undefined',
+            entraGroupId: typeof args.options.entraGroupId !== 'undefined',
+            entraGroupName: typeof args.options.entraGroupName !== 'undefined'
         });
     });
 }, _SpoUserGetCommand_initOptions = function _SpoUserGetCommand_initOptions() {
@@ -75,19 +116,36 @@ _SpoUserGetCommand_instances = new WeakSet(), _SpoUserGetCommand_initTelemetry =
         option: '--email [email]'
     }, {
         option: '--loginName [loginName]'
+    }, {
+        option: '--userName [userName]'
+    }, {
+        option: '--entraGroupId [entraGroupId]'
+    }, {
+        option: '--entraGroupName [entraGroupName]'
     });
+}, _SpoUserGetCommand_initTypes = function _SpoUserGetCommand_initTypes() {
+    this.types.string.push('webUrl', 'id', 'email', 'loginName', 'userName', 'entraGroupId', 'entraGroupName');
 }, _SpoUserGetCommand_initValidators = function _SpoUserGetCommand_initValidators() {
     this.validators.push(async (args) => {
         if (args.options.id &&
             typeof args.options.id !== 'number') {
             return `Specified id ${args.options.id} is not a number`;
         }
+        if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
+            return `${args.options.entraGroupId} is not a valid GUID.`;
+        }
+        if (args.options.userName && !validation.isValidUserPrincipalName(args.options.userName)) {
+            return `${args.options.userName} is not a valid userName.`;
+        }
+        if (args.options.email && !validation.isValidUserPrincipalName(args.options.email)) {
+            return `${args.options.email} is not a valid email.`;
+        }
         return validation.isValidSharePointUrl(args.options.webUrl);
     });
 }, _SpoUserGetCommand_initOptionSets = function _SpoUserGetCommand_initOptionSets() {
     this.optionSets.push({
-        options: ['id', 'email', 'loginName'],
-        runsWhen: (args) => args.options.id || args.options.loginName || args.options.email
+        options: ['id', 'email', 'loginName', 'userName', 'entraGroupId', 'entraGroupName'],
+        runsWhen: (args) => args.options.id || args.options.email || args.options.loginName || args.options.userName || args.options.entraGroupId || args.options.entraGroupName
     });
 };
 export default new SpoUserGetCommand();

package/dist/m365/spo/commands.js

@@ -100,8 +100,11 @@ export default {
     FOLDER_ROLEASSIGNMENT_ADD: `${prefix} folder roleassignment add`,
     FOLDER_ROLEINHERITANCE_BREAK: `${prefix} folder roleinheritance break`,
     FOLDER_ROLEINHERITANCE_RESET: `${prefix} folder roleinheritance reset`,
+    FOLDER_SHARINGLINK_ADD: `${prefix} folder sharinglink add`,
+    FOLDER_SHARINGLINK_CLEAR: `${prefix} folder sharinglink clear`,
     FOLDER_SHARINGLINK_GET: `${prefix} folder sharinglink get`,
     FOLDER_SHARINGLINK_LIST: `${prefix} folder sharinglink list`,
+    FOLDER_SHARINGLINK_REMOVE: `${prefix} folder sharinglink remove`,
     GET: `${prefix} get`,
     GROUP_ADD: `${prefix} group add`,
     GROUP_GET: `${prefix} group get`,
@@ -242,6 +245,7 @@ export default {
     SERVICEPRINCIPAL_SET: `${prefix} serviceprincipal set`,
     SET: `${prefix} set`,
     SITE_ADD: `${prefix} site add`,
+    SITE_ADMIN_ADD: `${prefix} site admin add`,
     SITE_ADMIN_LIST: `${prefix} site admin list`,
     SITE_APPCATALOG_ADD: `${prefix} site appcatalog add`,
     SITE_APPCATALOG_LIST: `${prefix} site appcatalog list`,

package/dist/m365/spp/commands/contentcenter/contentcenter-list.js

@@ -0,0 +1,56 @@
+import config from '../../../../config.js';
+import request from '../../../../request.js';
+import { spo } from '../../../../utils/spo.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+class SppContentCenterListCommand extends SpoCommand {
+    get name() {
+        return commands.CONTENTCENTER_LIST;
+    }
+    get description() {
+        return 'Gets information about the SharePoint Premium content centers';
+    }
+    defaultProperties() {
+        return ['Title', 'Url'];
+    }
+    async commandAction(logger) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Retrieving list of content centers...`);
+            }
+            const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
+            const allContentCenters = await this.getContentCenters(spoAdminUrl, logger);
+            await logger.log(allContentCenters);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getContentCenters(spoAdminUrl, logger) {
+        const allSites = [];
+        let currentStartIndex = '0';
+        const res = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, this.debug);
+        do {
+            const requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String"></Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">0</Property><Property Name="StartIndex" Type="String">${currentStartIndex}</Property><Property Name="Template" Type="String">CONTENTCTR#0</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
+            const requestOptions = {
+                url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+                headers: {
+                    'X-RequestDigest': res.FormDigestValue
+                },
+                data: requestBody
+            };
+            const response = await request.post(requestOptions);
+            const json = JSON.parse(response);
+            const responseContent = json[0];
+            if (responseContent.ErrorInfo) {
+                throw responseContent.ErrorInfo.ErrorMessage;
+            }
+            const sites = json[json.length - 1];
+            allSites.push(...sites._Child_Items_);
+            currentStartIndex = sites.NextStartIndexFromSharePoint;
+        } while (currentStartIndex);
+        return allSites;
+    }
+}
+export default new SppContentCenterListCommand();
+//# sourceMappingURL=contentcenter-list.js.map

package/dist/m365/spp/commands.js

@@ -0,0 +1,5 @@
+const prefix = 'spp';
+export default {
+    CONTENTCENTER_LIST: `${prefix} contentcenter list`
+};
+//# sourceMappingURL=commands.js.map

package/dist/utils/spo.js

@@ -490,10 +490,10 @@ export const spo = {
    * @param webUrl Web url
    * @param email The email of the user
    * @param logger the Logger object
-   * @param verbose set if verbose logging should be logged
+   * @param verbose set for verbose logging
    */
     async getUserByEmail(webUrl, email, logger, verbose) {
-        if (verbose) {
+        if (verbose && logger) {
             await logger.logToStderr(`Retrieving the spo user by email ${email}`);
         }
         const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
@@ -564,10 +564,10 @@ export const spo = {
     * @param webUrl Web url
     * @param name The name of the group
     * @param logger the Logger object
-    * @param verbose set if verbose logging should be logged
+    * @param verbose set for verbose logging
     */
     async getGroupByName(webUrl, name, logger, verbose) {
-        if (verbose) {
+        if (verbose && logger) {
             await logger.logToStderr(`Retrieving the group by name ${name}`);
         }
         const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;
@@ -586,10 +586,10 @@ export const spo = {
     * @param webUrl Web url
     * @param name the name of the role definition
     * @param logger the Logger object
-    * @param debug set if debug logging should be logged
+    * @param verbose set for verbose logging
     */
-    async getRoleDefinitionByName(webUrl, name, logger, debug) {
-        if (debug) {
+    async getRoleDefinitionByName(webUrl, name, logger, verbose) {
+        if (verbose && logger) {
             await logger.logToStderr(`Retrieving the role definitions for ${name}`);
         }
         const roledefinitions = await odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
@@ -1516,6 +1516,74 @@ export const spo = {
         };
         const itemsResponse = await request.get(requestOptionsItems);
         return (itemsResponse);
+    },
+    /**
+    * Retrieves the file by id.
+    * Returns a FileProperties object
+    * @param webUrl Web url
+    * @param id the id of the file
+    * @param logger the Logger object
+    * @param verbose set for verbose logging
+    */
+    async getFileById(webUrl, id, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Retrieving the file with id ${id}`);
+        }
+        const requestUrl = `${webUrl}/_api/web/GetFileById('${formatting.encodeQueryParameter(id)}')`;
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const file = await request.get(requestOptions);
+        return file;
+    },
+    /**
+     * Gets the site collection URL for a given web URL using SP Admin site.
+     * @param adminUrl The SharePoint admin URL
+     * @param siteId The site ID
+     * @param logger The logger object
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'application/json;charset=utf-8'
+            }
+        };
+        const response = await request.get(requestOptions);
+        const responseContent = JSON.parse(response);
+        return responseContent.OwnerLoginName;
+    },
+    /**
+     * Gets the primary owner login from a site.
+     * @param siteUrl The site URL
+     * @param logger The logger object
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryOwnerLoginFromSite(siteUrl, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${siteUrl}/_api/site/owner`,
+            method: 'GET',
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const responseContent = await request.get(requestOptions);
+        return responseContent?.LoginName;
     }
 };
 //# sourceMappingURL=spo.js.map

package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow recyclebinitem list
+
+Lists all soft-deleted Power Automate flows within an environment
+
+## Usage
+
+```sh
+m365 flow recyclebinitem list [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+```
+
+<Global />
+
+## Remarks
+
+:::warning
+
+This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
+
+:::
+
+:::info
+
+To use this command, you must be a Global or Power Platform administrator.
+
+:::
+
+A Power Automate flow is soft-deleted when:
+- It's a non-solution flow.
+- It's been deleted less than 21 days ago.
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+## Examples
+
+List all soft-deleted flows within a specific environment
+
+```sh
+m365 flow recyclebinitem list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "name": "26a9a283-af42-4c09-aa3e-60c3cc166b90",
+      "id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90",
+      "type": "Microsoft.ProcessSimple/environments/flows",
+      "properties": {
+        "apiId": "/providers/Microsoft.PowerApps/apis/shared_logicflows",
+        "displayName": "Invoicing flow",
+        "state": "Deleted",
+        "createdTime": "2024-08-05T23:13:54Z",
+        "lastModifiedTime": "2024-08-05T23:14:00Z",
+        "flowSuspensionReason": "None",
+        "environment": {
+          "name": "Default-d87a7535-dd31-4437-bfe1-95340acd55c5",
+          "type": "Microsoft.ProcessSimple/environments",
+          "id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+        },
+        "definitionSummary": {
+          "triggers": [],
+          "actions": []
+        },
+        "creator": {
+          "tenantId": "a16e76a1-837f-4bf9-82dc-78874d18e434",
+          "objectId": "bd51c64d-c262-4184-ba3f-5361ea553820",
+          "userId": "bd51c64d-c262-4184-ba3f-5361ea553820",
+          "userType": "ActiveDirectory"
+        },
+        "flowFailureAlertSubscribed": false,
+        "isManaged": false,
+        "machineDescriptionData": {},
+        "flowOpenAiData": {
+          "isConsequential": false,
+          "isConsequentialFlagOverwritten": false
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  name                                  displayName
+  ------------------------------------  --------------
+  26a9a283-af42-4c09-aa3e-60c3cc166b90  Invoicing flow
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  name,id,type
+  26a9a283-af42-4c09-aa3e-60c3cc166b90,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90,Microsoft.ProcessSimple/environments/flows
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # flow recyclebinitem list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+
+  Date: 06/08/2024
+
+  ## 26a9a283-af42-4c09-aa3e-60c3cc166b90 (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90)
+
+  Property | Value
+  ---------|-------
+  name | 26a9a283-af42-4c09-aa3e-60c3cc166b90
+  id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90
+  type | Microsoft.ProcessSimple/environments/flows
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow recyclebinitem restore
+
+Restores a soft-deleted Power Automate flow
+
+## Usage
+
+```sh
+m365 flow recyclebinitem restore [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --environmentName <environmentName>`
+: The name of the environment where the flow is located.
+
+`-n, --flowName <flowName>`
+: The name of the Power Automate flow.
+```
+
+<Global />
+
+## Remarks
+
+:::warning
+
+This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
+
+:::
+
+:::info
+
+To use this command, you must be a Global or Power Platform administrator.
+
+:::
+
+When a Power Automate flow is restored, it will be automatically disabled. To make it operational again, you must [enable](../flow-enable.mdx) it.
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+## Examples
+
+Restores a soft-deleted flow within a specific environment
+
+```sh
+m365 flow recyclebinitem restore --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a
+```
+
+## Response
+
+The command won't return a response on success.

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>
+