@pnp/cli-microsoft365 6.0.0-beta.09b5216 → 6.0.0-beta.4d2402f

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

@@ -13,10 +13,8 @@ class SpoListItemListCommand extends SpoCommand_1.default {
     }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.id = typeof args.options.id !== 'undefined';
         telemetryProps.listId = typeof args.options.listId !== 'undefined';
         telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
-        telemetryProps.title = typeof args.options.title !== 'undefined';
         telemetryProps.fields = typeof args.options.fields !== 'undefined';
         telemetryProps.filter = typeof args.options.filter !== 'undefined';
         telemetryProps.pageNumber = typeof args.options.pageNumber !== 'undefined';
@@ -25,17 +23,14 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
-        if (args.options.id) {
-            this.warn(logger, `Option 'id' is deprecated. Please use 'listId' instead.`);
-        }
-        if (args.options.title) {
-            this.warn(logger, `Option 'title' is deprecated. Please use 'listTitle' instead.`);
-        }
-        const listIdArgument = args.options.listId || args.options.id || '';
-        const listTitleArgument = args.options.listTitle || args.options.title || '';
+        const listIdArgument = args.options.listId || '';
+        const listTitleArgument = args.options.listTitle || '';
         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 +70,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 ?
                 {
@@ -107,12 +103,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
             {
                 option: '-u, --webUrl <webUrl>'
             },
-            {
-                option: '--id [id]'
-            },
-            {
-                option: '--title [title]'
-            },
             {
                 option: '-i, --listId [listId]'
             },
@@ -157,14 +147,10 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (!args.options.id && !args.options.title && !args.options.listId && !args.options.listTitle) {
+        if (!args.options.listId && !args.options.listTitle) {
             return `Specify listId or listTitle`;
         }
-        if (args.options.id && args.options.title) {
-            return `Specify list id or title but not both`;
-        }
-        // Check if only one of the 4 options is specified
-        if ([args.options.id, args.options.title, args.options.listId, args.options.listTitle].filter(o => o).length > 1) {
+        if (args.options.listId && args.options.listTitle) {
             return 'Specify listId or listTitle but not both';
         }
         if (args.options.camlQuery && args.options.fields) {
@@ -188,9 +174,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
             return `${args.options.listId} is not a valid GUID`;
         }
-        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
-            return `${args.options.id} in option id is not a valid GUID`;
-        }
         return true;
     }
 }

package/dist/m365/spo/commands/roledefinition/RoleDefinition.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RoleDefinition.js.map

package/dist/m365/spo/commands/roledefinition/RoleType.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleType = void 0;
+var RoleType;
+(function (RoleType) {
+    RoleType[RoleType["None"] = 0] = "None";
+    RoleType[RoleType["Guest"] = 1] = "Guest";
+    RoleType[RoleType["Reader"] = 2] = "Reader";
+    RoleType[RoleType["Contributor"] = 3] = "Contributor";
+    RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
+    RoleType[RoleType["Administrator"] = 5] = "Administrator";
+    RoleType[RoleType["Editor"] = 6] = "Editor";
+    RoleType[RoleType["Reviewer"] = 7] = "Reviewer";
+    RoleType[RoleType["System"] = 8] = "System";
+})(RoleType = exports.RoleType || (exports.RoleType = {}));
+//# sourceMappingURL=RoleType.js.map

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

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const base_permissions_1 = require("../../base-permissions");
+const commands_1 = require("../../commands");
+const RoleType_1 = require("./RoleType");
+class SpoRoleDefinitionGetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.ROLEDEFINITION_GET;
+    }
+    get description() {
+        return 'Gets specified role definition from web by id';
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Getting role definition from ${args.options.webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/roledefinitions(${args.options.id})`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const permissions = new base_permissions_1.BasePermissions();
+            permissions.high = response.BasePermissions.High;
+            permissions.low = response.BasePermissions.Low;
+            response.BasePermissionsValue = permissions.parse();
+            response.RoleTypeKindValue = RoleType_1.RoleType[response.RoleTypeKind];
+            logger.log(response);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (isNaN(args.options.id)) {
+            return `${args.options.id} is not a number`;
+        }
+        return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoRoleDefinitionGetCommand();
+//# sourceMappingURL=roledefinition-get.js.map

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`,
@@ -167,6 +169,7 @@ exports.default = {
     REPORT_SITEUSAGEPAGES: `${prefix} report siteusagepages`,
     REPORT_SITEUSAGESITECOUNTS: `${prefix} report siteusagesitecounts`,
     REPORT_SITEUSAGESTORAGE: `${prefix} report siteusagestorage`,
+    ROLEDEFINITION_GET: `${prefix} roledefinition get`,
     ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
     ROLEDEFINITION_REMOVE: `${prefix} roledefinition remove`,
     SEARCH: `${prefix} search`,

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/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js

@@ -34,15 +34,7 @@ class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
             },
             responseType: 'json'
         };
-        return request_1.default
-            .get(requestOptions)
-            .then(response => {
-            const serviceHealth = response;
-            if (!serviceHealth) {
-                return Promise.reject(`Error fetching service health`);
-            }
-            return Promise.resolve(serviceHealth);
-        });
+        return request_1.default.get(requestOptions);
     }
     options() {
         const options = [

package/dist/utils/accessToken.js

@@ -57,6 +57,24 @@ exports.accessToken = {
         catch (_a) {
         }
         return userName;
+    },
+    getUserIdFromAccessToken(accessToken) {
+        let userId = '';
+        if (!accessToken || accessToken.length === 0) {
+            return userId;
+        }
+        const chunks = accessToken.split('.');
+        if (chunks.length !== 3) {
+            return userId;
+        }
+        const tokenString = Buffer.from(chunks[1], 'base64').toString();
+        try {
+            const token = JSON.parse(tokenString);
+            userId = token.oid;
+        }
+        catch (_a) {
+        }
+        return userId;
     }
 };
 //# sourceMappingURL=accessToken.js.map

package/dist/utils/planner.js

@@ -45,19 +45,19 @@ exports.planner = {
         return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
     },
     /**
-     * Get Planner plan by name in a specific group.
-     * @param name Name of the Planner plan. Case insensitive.
+     * Get Planner plan by title in a specific group.
+     * @param title Title of the Planner plan. Case insensitive.
      * @param groupId Owner group ID .
      */
-    getPlanByName(name, groupId) {
+    getPlanByTitle(title, groupId) {
         return __awaiter(this, void 0, void 0, function* () {
             const plans = yield this.getPlansByGroupId(groupId);
-            const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
+            const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
             if (!filteredPlans.length) {
-                throw Error(`The specified plan '${name}' does not exist.`);
+                throw Error(`The specified plan '${title}' does not exist.`);
             }
             if (filteredPlans.length > 1) {
-                throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
+                throw Error(`Multiple plans with title '${title}' found: ${filteredPlans.map(x => x.id)}.`);
             }
             return filteredPlans[0];
         });

package/dist/utils/validation.js

@@ -6,8 +6,12 @@ exports.validation = {
         return guids.every(guid => this.isValidGuid(guid));
     },
     isValidGuid(guid) {
+        if (!guid) {
+            return false;
+        }
         const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
-        return guidRegEx.test(guid);
+        // verify if the guid is a valid guid. @meid will be replaced in a later stage with the actual user id of the logged in user
+        return guidRegEx.test(guid) || guid.toLocaleLowerCase().trim() === "@meid";
     },
     isValidTeamsChannelId(guid) {
         const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);

package/docs/docs/cmd/aad/app/app-remove.md

@@ -8,12 +8,6 @@ Removes an Azure AD app registration
 m365 aad app remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad app delete [options]
-```
-
 ## Options
 
 `--appId [appId]`

package/docs/docs/cmd/aad/app/app-role-remove.md

@@ -8,12 +8,6 @@ Removes role from the specified Azure AD app registration
 m365 aad app role remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad app role delete [options]
-```
-
 ## Options
 
 `--appId [appId]`

package/docs/docs/cmd/aad/user/user-get.md

@@ -56,6 +56,18 @@ For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user na
 m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
 ```
 
+Get information about the currently logged user using the Id token
+
+```sh
+m365 aad user get --id "@meId"
+```
+
+Get information about the currently logged in user using the UserName token
+
+```sh
+m365 aad user get --userName "@meUserName"
+```
+
 ## More information
 
 - Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)

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

@@ -14,16 +14,19 @@ m365 planner bucket add [options]
 : Name of the bucket to add.
 
 `--planId [planId]`
-: Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
+: ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
+
+`--planTitle [planTitle]`
+: Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
 
 `--planName [planName]`
-: Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
+: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
 
 `--ownerGroupId [ownerGroupId]`
-: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 `--orderHint [orderHint]`
 : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
 m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
 ```
 
-Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
+Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
 
 ```sh
-m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```