@pnp/cli-microsoft365 6.0.0-beta.f73c4f8 → 6.0.0-beta.fe4e66d

package/dist/m365/spo/commands/group/group-set.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AadUserGetCommand = require("../../../aad/commands/user/user-get");
+const cli_1 = require("../../../../cli");
+const utils_1 = require("../../../../utils");
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoGroupSetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.GROUP_SET;
+    }
+    get description() {
+        return 'Updates a group in the specified site';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        telemetryProps.newName = typeof args.options.newName !== 'undefined';
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.allowMembersEditMembership = typeof args.options.allowMembersEditMembership !== 'undefined';
+        telemetryProps.onlyAllowMembersViewMembership = typeof args.options.onlyAllowMembersViewMembership !== 'undefined';
+        telemetryProps.allowRequestToJoinLeave = typeof args.options.allowRequestToJoinLeave !== 'undefined';
+        telemetryProps.autoAcceptRequestToJoinLeave = typeof args.options.autoAcceptRequestToJoinLeave !== 'undefined';
+        telemetryProps.requestToJoinLeaveEmailSetting = typeof args.options.requestToJoinLeaveEmailSetting !== 'undefined';
+        telemetryProps.ownerEmail = typeof args.options.ownerEmail !== 'undefined';
+        telemetryProps.ownerUserName = typeof args.options.ownerUserName !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/${args.options.id ? `GetById(${args.options.id})` : `GetByName('${args.options.name}')`}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none',
+                'content-type': 'application/json'
+            },
+            responseType: 'json',
+            data: {
+                Title: args.options.newName,
+                Description: args.options.description,
+                AllowMembersEditMembership: args.options.allowMembersEditMembership,
+                OnlyAllowMembersViewMembership: args.options.onlyAllowMembersViewMembership,
+                AllowRequestToJoinLeave: args.options.allowRequestToJoinLeave,
+                AutoAcceptRequestToJoinLeave: args.options.autoAcceptRequestToJoinLeave,
+                RequestToJoinLeaveEmailSetting: args.options.requestToJoinLeaveEmailSetting
+            }
+        };
+        request_1.default
+            .patch(requestOptions)
+            .then(() => this.setGroupOwner(args.options))
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    setGroupOwner(options) {
+        if (!options.ownerEmail && !options.ownerUserName) {
+            return Promise.resolve();
+        }
+        return this
+            .getOwnerId(options)
+            .then((ownerId) => {
+            const requestOptions = {
+                url: `${options.webUrl}/_api/web/sitegroups/${options.id ? `GetById(${options.id})` : `GetByName('${options.name}')`}/SetUserAsOwner(${ownerId})`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        });
+    }
+    getOwnerId(options) {
+        const cmdOptions = {
+            userName: options.ownerUserName,
+            email: options.ownerEmail,
+            output: 'json',
+            debug: options.debug,
+            verbose: options.verbose
+        };
+        return cli_1.Cli
+            .executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) })
+            .then((output) => {
+            const getUserOutput = JSON.parse(output.stdout);
+            const requestOptions = {
+                url: `${options.webUrl}/_api/web/ensureUser('${getUserOutput.userPrincipalName}')?$select=Id`,
+                headers: {
+                    accept: 'application/json',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then((response) => response.Id);
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-n, --name [name]'
+            },
+            {
+                option: '--newName [newName]'
+            },
+            {
+                option: '--description [description]'
+            },
+            {
+                option: '--allowMembersEditMembership [allowMembersEditMembership]'
+            },
+            {
+                option: '--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]'
+            },
+            {
+                option: '--allowRequestToJoinLeave [allowRequestToJoinLeave]'
+            },
+            {
+                option: '--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]'
+            },
+            {
+                option: '--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]'
+            },
+            {
+                option: '--ownerEmail [ownerEmail]'
+            },
+            {
+                option: '--ownerUserName [ownerUserName]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    optionSets() {
+        return [
+            ['id', 'name']
+        ];
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.id && isNaN(args.options.id)) {
+            return `Specified id ${args.options.id} is not a number`;
+        }
+        if (args.options.ownerEmail && args.options.ownerUserName) {
+            return 'Specify either ownerEmail or ownerUserName but not both';
+        }
+        const booleanOptions = [
+            args.options.allowMembersEditMembership, args.options.onlyAllowMembersViewMembership,
+            args.options.allowRequestToJoinLeave, args.options.autoAcceptRequestToJoinLeave
+        ];
+        for (const option of booleanOptions) {
+            if (typeof option !== 'undefined' && !utils_1.validation.isValidBoolean(option)) {
+                return `Value '${option}' is not a valid boolean`;
+            }
+        }
+        return true;
+    }
+}
+module.exports = new SpoGroupSetCommand();
+//# sourceMappingURL=group-set.js.map

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
+const SpoListItemListCommand = require("../listitem/listitem-list");
 class SpoHubSiteGetCommand extends SpoCommand_1.default {
     get name() {
         return commands_1.default.HUBSITE_GET;
@@ -16,9 +18,24 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
         telemetryProps.id = typeof args.options.id !== 'undefined';
         telemetryProps.title = typeof args.options.title !== 'undefined';
         telemetryProps.url = typeof args.options.url !== 'undefined';
+        telemetryProps.includeAssociatedSites = args.options.includeAssociatedSites === true;
         return telemetryProps;
     }
+    getAssociatedSites(spoAdminUrl, hubSiteId, logger, args) {
+        const options = {
+            output: 'json',
+            debug: args.options.debug,
+            verbose: args.options.verbose,
+            listTitle: 'DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS',
+            webUrl: spoAdminUrl,
+            filter: `HubSiteId eq '${hubSiteId}'`,
+            fields: 'Title,SiteUrl,SiteId'
+        };
+        return cli_1.Cli
+            .executeCommandWithOutput(SpoListItemListCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
+    }
     commandAction(logger, args, cb) {
+        let hubSite;
         utils_1.spo
             .getSpoUrl(logger, this.debug)
             .then((spoUrl) => {
@@ -30,7 +47,25 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
             }
         })
             .then((res) => {
-            logger.log(res);
+            hubSite = res;
+            if (args.options.includeAssociatedSites && (args.options.output && args.options.output !== 'json')) {
+                throw Error('includeAssociatedSites option is only allowed with json output mode');
+            }
+            if (args.options.includeAssociatedSites !== true || args.options.output && args.options.output !== 'json') {
+                return Promise.resolve();
+            }
+            return utils_1.spo
+                .getSpoAdminUrl(logger, this.debug)
+                .then((spoAdminUrl) => {
+                return this.getAssociatedSites(spoAdminUrl, hubSite.SiteId, logger, args);
+            });
+        })
+            .then((associatedSitesCommandOutput) => {
+            if (args.options.includeAssociatedSites) {
+                const associatedSites = JSON.parse(associatedSitesCommandOutput.stdout);
+                hubSite.AssociatedSites = associatedSites.filter(s => s.SiteId !== hubSite.SiteId);
+            }
+            logger.log(hubSite);
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
@@ -75,7 +110,8 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
         const options = [
             { option: '-i, --id [id]' },
             { option: '-t, --title [title]' },
-            { option: '-u, --url [url]' }
+            { option: '-u, --url [url]' },
+            { option: '--includeAssociatedSites' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);

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

@@ -24,15 +24,15 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
         const listIdArgument = args.options.listId || '';
         const listTitleArgument = args.options.listTitle || '';
         const listRestUrl = (args.options.listId ?
-            `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
-            : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
-        const propertiesSelect = args.options.properties ?
-            `?$select=${encodeURIComponent(args.options.properties)}` :
-            ((!args.options.output || args.options.output === 'text') ?
-                `?$select=Id,Title` :
-                ``);
+            `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')` :
+            `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
+        const propertiesSelect = args.options.properties ? args.options.properties.split(',') : [];
+        const propertiesWithSlash = propertiesSelect.filter(item => item.includes('/'));
+        const propertiesToExpand = propertiesWithSlash.map(e => e.split('/')[0]);
+        const expandPropertiesArray = propertiesToExpand.filter((item, pos) => propertiesToExpand.indexOf(item) === pos);
+        const fieldExpand = expandPropertiesArray.length > 0 ? `&$expand=${expandPropertiesArray.join(",")}` : ``;
         const requestOptions = {
-            url: `${listRestUrl}/items(${args.options.id})${propertiesSelect}`,
+            url: `${listRestUrl}/items(${args.options.id})?$select=${encodeURIComponent(propertiesSelect.join(","))}${fieldExpand}`,
             headers: {
                 'accept': 'application/json;odata=nometadata'
             },
@@ -41,7 +41,7 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
         request_1.default
             .get(requestOptions)
             .then((response) => {
-            delete response["ID"];
+            delete response['ID'];
             logger.log(response);
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));

package/dist/m365/spo/commands/listitem/listitem-list.js

@@ -36,6 +36,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         let formDigestValue = '';
         const fieldsArray = args.options.fields ? args.options.fields.split(",")
             : (!args.options.output || args.options.output === "text") ? ["Title", "Id"] : [];
+        const fieldsWithSlash = fieldsArray.filter(item => item.includes('/'));
+        const fieldsToExpand = fieldsWithSlash.map(e => e.split('/')[0]);
+        const expandFieldsArray = fieldsToExpand.filter((item, pos) => fieldsToExpand.indexOf(item) === pos);
         const listRestUrl = listIdArgument ?
             `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
             : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`;
@@ -75,8 +78,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
             const skipToken = (args.options.pageNumber && Number(args.options.pageNumber) > 0 && skipTokenId > 0) ? `$skiptoken=Paged=TRUE%26p_ID=${res.value[res.value.length - 1].Id}` : ``;
             const rowLimit = args.options.pageSize ? `$top=${args.options.pageSize}` : ``;
             const filter = args.options.filter ? `$filter=${encodeURIComponent(args.options.filter)}` : ``;
+            const fieldExpand = expandFieldsArray.length > 0 ? `&$expand=${expandFieldsArray.join(",")}` : ``;
             const fieldSelect = fieldsArray.length > 0 ?
-                `?$select=${encodeURIComponent(fieldsArray.join(","))}&${rowLimit}&${skipToken}&${filter}` :
+                `?$select=${encodeURIComponent(fieldsArray.join(","))}${fieldExpand}&${rowLimit}&${skipToken}&${filter}` :
                 `?${rowLimit}&${skipToken}&${filter}`;
             const requestBody = args.options.camlQuery ?
                 {

package/dist/m365/spo/commands.js

@@ -63,9 +63,11 @@ exports.default = {
     FOLDER_REMOVE: `${prefix} folder remove`,
     FOLDER_RENAME: `${prefix} folder rename`,
     GET: `${prefix} get`,
+    GROUP_ADD: `${prefix} group add`,
     GROUP_GET: `${prefix} group get`,
     GROUP_LIST: `${prefix} group list`,
     GROUP_REMOVE: `${prefix} group remove`,
+    GROUP_SET: `${prefix} group set`,
     GROUP_USER_ADD: `${prefix} group user add`,
     GROUP_USER_LIST: `${prefix} group user list`,
     GROUP_USER_REMOVE: `${prefix} group user remove`,

package/dist/m365/teams/commands/team/team-archive.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
+const aadGroup_1 = require("../../../../utils/aadGroup");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
 class TeamsTeamArchiveCommand extends GraphCommand_1.default {
@@ -16,27 +17,53 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
         telemetryProps.shouldSetSpoSiteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
         return telemetryProps;
     }
+    getTeamId(args) {
+        if (args.options.id) {
+            return Promise.resolve(args.options.id);
+        }
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(args.options.name)
+            .then(group => {
+            if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
+                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+            }
+            return group.id;
+        });
+    }
     commandAction(logger, args, cb) {
+        if (args.options.teamId) {
+            args.options.id = args.options.teamId;
+            this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
+        }
         const siteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
-        const requestOptions = {
-            url: `${this.resource}/v1.0/teams/${encodeURIComponent(args.options.teamId)}/archive`,
-            headers: {
-                'content-type': 'application/json;odata=nometadata',
-                'accept': 'application/json;odata.metadata=none'
-            },
-            responseType: 'json',
-            data: {
-                shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
-            }
-        };
-        request_1.default
-            .post(requestOptions)
+        this
+            .getTeamId(args)
+            .then((teamId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/teams/${encodeURIComponent(teamId)}/archive`,
+                headers: {
+                    'content-type': 'application/json;odata=nometadata',
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json',
+                data: {
+                    shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
+                }
+            };
+            return request_1.default.post(requestOptions);
+        })
             .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
     }
     options() {
         const options = [
             {
-                option: '-i, --teamId <teamId>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-n, --name [name]'
+            },
+            {
+                option: '--teamId [teamId]'
             },
             {
                 option: '--shouldSetSpoSiteReadOnlyForMembers'
@@ -46,9 +73,18 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!utils_1.validation.isValidGuid(args.options.teamId)) {
+        if (!args.options.id && !args.options.name && !args.options.teamId) {
+            return 'Specify either id or name';
+        }
+        if (args.options.name && (args.options.id || args.options.teamId)) {
+            return 'Specify either id or name but not both';
+        }
+        if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
             return `${args.options.teamId} is not a valid GUID`;
         }
+        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
+        }
         return true;
     }
 }

package/dist/m365/teams/commands/team/team-remove.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
+const aadGroup_1 = require("../../../../utils/aadGroup");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
 class TeamsTeamRemoveCommand extends GraphCommand_1.default {
@@ -17,17 +18,37 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
         telemetryProps.confirm = (!(!args.options.confirm)).toString();
         return telemetryProps;
     }
+    getTeamId(args) {
+        if (args.options.id) {
+            return Promise.resolve(args.options.id);
+        }
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(args.options.name)
+            .then(group => {
+            if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
+                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+            }
+            return group.id;
+        });
+    }
     commandAction(logger, args, cb) {
+        if (args.options.teamId) {
+            args.options.id = args.options.teamId;
+            this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
+        }
         const removeTeam = () => {
-            const requestOptions = {
-                url: `${this.resource}/v1.0/groups/${encodeURIComponent(args.options.teamId)}`,
-                headers: {
-                    accept: 'application/json;odata.metadata=none'
-                },
-                responseType: 'json'
-            };
-            request_1.default
-                .delete(requestOptions)
+            this
+                .getTeamId(args)
+                .then((teamId) => {
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/groups/${encodeURIComponent(teamId)}`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    },
+                    responseType: 'json'
+                };
+                return request_1.default.delete(requestOptions);
+            })
                 .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
         };
         if (args.options.confirm) {
@@ -52,7 +73,13 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
     options() {
         const options = [
             {
-                option: '-i, --teamId <teamId>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-n, --name [name]'
+            },
+            {
+                option: '--teamId [teamId]'
             },
             {
                 option: '--confirm'
@@ -62,9 +89,18 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!utils_1.validation.isValidGuid(args.options.teamId)) {
+        if (!args.options.id && !args.options.name && !args.options.teamId) {
+            return 'Specify either id or name';
+        }
+        if (args.options.name && (args.options.id || args.options.teamId)) {
+            return 'Specify either id or name but not both';
+        }
+        if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
             return `${args.options.teamId} is not a valid GUID`;
         }
+        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
+        }
         return true;
     }
 }

package/dist/m365/teams/commands/team/team-unarchive.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
+const aadGroup_1 = require("../../../../utils/aadGroup");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
 class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
@@ -11,33 +12,68 @@ class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
     get description() {
         return 'Restores an archived Microsoft Teams team';
     }
+    getTeamId(args) {
+        if (args.options.id) {
+            return Promise.resolve(args.options.id);
+        }
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(args.options.name)
+            .then(group => {
+            if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
+                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+            }
+            return group.id;
+        });
+    }
     commandAction(logger, args, cb) {
+        if (args.options.teamId) {
+            args.options.id = args.options.teamId;
+            this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
+        }
         const endpoint = `${this.resource}/v1.0`;
-        const requestOptions = {
-            url: `${endpoint}/teams/${encodeURIComponent(args.options.teamId)}/unarchive`,
-            headers: {
-                'content-type': 'application/json;odata=nometadata',
-                'accept': 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        request_1.default
-            .post(requestOptions)
+        this
+            .getTeamId(args)
+            .then((teamId) => {
+            const requestOptions = {
+                url: `${endpoint}/teams/${encodeURIComponent(teamId)}/unarchive`,
+                headers: {
+                    'content-type': 'application/json;odata=nometadata',
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
             .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
     }
     options() {
         const options = [
             {
-                option: '-i, --teamId <teamId>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-n, --name [name]'
+            },
+            {
+                option: '--teamId [teamId]'
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!utils_1.validation.isValidGuid(args.options.teamId)) {
+        if (!args.options.id && !args.options.name && !args.options.teamId) {
+            return 'Specify either id or name';
+        }
+        if (args.options.name && (args.options.id || args.options.teamId)) {
+            return 'Specify either id or name but not both';
+        }
+        if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
             return `${args.options.teamId} is not a valid GUID`;
         }
+        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
+        }
         return true;
     }
 }

package/docs/docs/cmd/planner/plan/plan-add.md

@@ -19,18 +19,34 @@ m365 planner plan add [options]
 `--ownerGroupName [ownerGroupName]`
 : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
 
+`--shareWithUserIds [shareWithUserIds]`
+: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+`--shareWithUserNames [shareWithUserNames]`
+: The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
+
 ## Examples
 
 Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
 
 ```sh
-m365 planner plan add --title "My Planner Plan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
+m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
 ```
 
 Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
 
 ```sh
-m365 planner plan add --title "My Planner Plan" --ownerGroupName "My Planner Group"
+m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
+```
+
+Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
+
+```sh
+m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
 ```

package/docs/docs/cmd/planner/task/task-get.md

@@ -8,6 +8,12 @@ Retrieve the specified planner task
 m365 planner task get [options]
 ```
 
+## Alias
+
+```sh
+m365 planner task details get [options]
+```
+
 ## Options
 
 `-i, --id  [id]`