@pnp/cli-microsoft365 6.9.0 → 6.10.0-beta.1d7c557

package/dist/utils/spo.js

@@ -19,6 +19,7 @@ const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
 const formatting_1 = require("./formatting");
 const odata_1 = require("./odata");
+const RoleType_1 = require("../m365/spo/commands/roledefinition/RoleType");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -569,6 +570,30 @@ exports.spo = {
             return res.AadObjectId.NameId;
         });
     },
+    /**
+   * Retrieves the spo user by email.
+   * @param webUrl Web url
+   * @param email The email of the user
+   * @param logger the Logger object
+   * @param debug set if debug logging should be logged
+   */
+    getUserByEmail(webUrl, email, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the spo user by email ${email}`);
+            }
+            const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting_1.formatting.encodeQueryParameter(email)}')`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const userInstance = yield request_1.default.get(requestOptions);
+            return userInstance;
+        });
+    },
     /**
      * Retrieves the menu state for the quick launch.
      * @param webUrl Web url
@@ -628,6 +653,55 @@ exports.spo = {
             };
             return request_1.default.post(requestOptions);
         });
+    },
+    /**
+  * Retrieves the spo group by name.
+  * @param webUrl Web url
+  * @param name The name of the group
+  * @param logger the Logger object
+  * @param debug set if debug logging should be logged
+  */
+    getGroupByName(webUrl, name, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the group by name ${name}`);
+            }
+            const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting_1.formatting.encodeQueryParameter(name)}')`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const groupInstance = yield request_1.default.get(requestOptions);
+            return groupInstance;
+        });
+    },
+    /**
+  * Retrieves the role definition by name.
+  * @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
+  */
+    getRoleDefinitionByName(webUrl, name, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the role definitions for ${name}`);
+            }
+            const roledefinitions = yield odata_1.odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
+            const roledefinition = roledefinitions.find((role) => role.Name === name);
+            if (!roledefinition) {
+                throw `No roledefinition is found for ${name}`;
+            }
+            const permissions = new base_permissions_1.BasePermissions();
+            permissions.high = roledefinition.BasePermissions.High;
+            permissions.low = roledefinition.BasePermissions.Low;
+            roledefinition.BasePermissionsValue = permissions.parse();
+            roledefinition.RoleTypeKindValue = RoleType_1.RoleType[roledefinition.RoleTypeKind];
+            return roledefinition;
+        });
     }
 };
 //# sourceMappingURL=spo.js.map

package/docs/docs/_clisettings.mdx

@@ -0,0 +1,17 @@
+Setting name|Definition|Default value
+------------|----------|-------------
+`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode.|`false`
+`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
+`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
+`csvHeader`|Display the column names on the first line|`true`
+`csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
+`csvQuoted`|Quote all the non-empty fields even if not required|`false`
+`csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`disableTelemetry`|Disables sending of telemetry data|`false`
+`errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
+`helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
+`output`|Defines the default output when issuing a command. Allowed values are `json`, `text`, `csv`, `md`, `none`|`json`
+`printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
+`prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`false`
+`showHelpOnFailure`|Automatically display help when executing a command failed|`true`
+`showSpinner`|Display spinner when executing commands|`true`

package/docs/docs/cmd/_global.mdx

@@ -6,7 +6,7 @@
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
 
 `-o, --output [output]`
-: Output type. `json`, `text`, `csv`, `md`. Default `json`.
+: Output type. `json`, `text`, `csv`, `md`, `none`. Default `json`.
 
 `--verbose`
 : Runs command with verbose logging.

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

@@ -25,7 +25,10 @@ m365 aad user get [options]
 : The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
 
 `-p, --properties [properties]`
-: Comma-separated list of properties to retrieve
+: Comma-separated list of properties to retrieve.
+
+`--withManager`
+: Retrieve the direct manager of the user.
 ```
 
 <Global />
@@ -74,24 +77,113 @@ Get information about the currently logged in user using the UserName token
 m365 aad user get --userName "@meUserName"
 ```
 
+Get information about a user with the manager's details
+
+```sh
+m365 aad user get --userName AarifS@contoso.onmicrosoft.com --withManager
+```
+
 ## Response
 
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "businessPhones": ["+32499-99-99-99"],
+    "displayName": "John Doe",
+    "givenName": "John",
+    "jobTitle": "Sales Manager",
+    "mail": "john.doe@contoso.com",
+    "mobilePhone": "+32499-99-99-99",
+    "officeLocation": "Vosselaar",
+    "preferredLanguage": "nl-BE",
+    "surname": "Doe",
+    "userPrincipalName": "john.doe@contoso.com",
+    "id": "990e2425-f595-43bc-85ed-b89a44093793"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  businessPhones   : ["+32499-99-99-99"]
+  displayName      : John Doe
+  givenName        : John
+  id               : 990e2425-f595-43bc-85ed-b89a44093793
+  jobTitle         : Sales Manager
+  mail             : john.doe@contoso.com
+  mobilePhone      : +32499-99-99-99
+  officeLocation   : Vosselaar
+  preferredLanguage: nl-BE
+  surname          : Doe
+  userPrincipalName: john.doe@contoso.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
+  John Doe,John,Sales Manager,john.doe@contoso.com,+32499-99-99-99,Vosselaar,nl-BE,Doe,john.doe@contoso.com,990e2425-f595-43bc-85ed-b89a44093793
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad user get --userName "john.doe@contoso.com"
+
+  Date: 16/02/2023
+
+  ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
+
+  Property | Value
+  ---------|-------
+  displayName | John Doe
+  givenName | John
+  jobTitle | Sales Manager
+  mail | john.doe@contoso.com
+  mobilePhone | +32499-99-99-99
+  officeLocation | Vosselaar
+  preferredLanguage | nl-BE
+  surname | Doe
+  userPrincipalName | john.doe@contoso.com
+  id | 990e2425-f595-43bc-85ed-b89a44093793
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `withManager` response
+
+When we make use of the option `withManager` the response will differ. 
+
 <Tabs>
   <TabItem value="JSON">
 
   ```json
   {
-    "businessPhones": [],
+    "businessPhones": ["+32499-99-99-99"],
     "displayName": "John Doe",
-    "givenName": null,
-    "jobTitle": null,
-    "mail": null,
-    "mobilePhone": null,
-    "officeLocation": null,
-    "preferredLanguage": null,
-    "surname": null,
+    "givenName": "John",
+    "jobTitle": "Sales Manager",
+    "mail": "john.doe@contoso.com",
+    "mobilePhone": "+32499-99-99-99",
+    "officeLocation": "Vosselaar",
+    "preferredLanguage": "nl-BE",
+    "surname": "Doe",
     "userPrincipalName": "john.doe@contoso.com",
-    "id": "74a3b772-3122-447b-b9da-10895e238219"
+    "id": "990e2425-f595-43bc-85ed-b89a44093793",
+    "manager": {
+      "displayName": "Jane Doe",
+      "userPrincipalName": "jane.doe@contoso.com",
+      "id": "eb77fbcf-6fe8-458b-985d-1747284793bc",
+      "mail": "jane.doe@contoso.com"
+    }
   }
   ```
 
@@ -99,16 +191,17 @@ m365 aad user get --userName "@meUserName"
   <TabItem value="Text">
 
   ```text
-  businessPhones   : []
+  businessPhones   : ["+32499-99-99-99"]
   displayName      : John Doe
-  givenName        : null
-  id               : 74a3b772-3122-447b-b9da-10895e238219
-  jobTitle         : null
-  mail             : null
-  mobilePhone      : null
-  officeLocation   : null
-  preferredLanguage: null
-  surname          : null
+  givenName        : John
+  id               : 990e2425-f595-43bc-85ed-b89a44093793
+  jobTitle         : Sales Manager
+  mail             : john.doe@contoso.com
+  manager          : {"displayName":"Jane Doe","userPrincipalName":"jane.doe@contoso.com","id":"eb77fbcf-6fe8-458b-985d-1747284793bc","mail":"jane.doe@contoso.com"}
+  mobilePhone      : +32499-99-99-99
+  officeLocation   : Vosselaar
+  preferredLanguage: nl-BE
+  surname          : Doe
   userPrincipalName: john.doe@contoso.com
   ```
 
@@ -116,15 +209,15 @@ m365 aad user get --userName "@meUserName"
   <TabItem value="CSV">
 
   ```csv
-  displayName,userPrincipalName,id
-  John Doe,john.doe@contoso.com,74a3b772-3122-447b-b9da-10895e238219
+  displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
+  John Doe,John,Sales Manager,john.doe@contoso.com,+32499-99-99-99,Vosselaar,nl-BE,Doe,john.doe@contoso.com,990e2425-f595-43bc-85ed-b89a44093793
   ```
 
   </TabItem>
   <TabItem value="Markdown">
 
   ```md
-  # aad user get --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName "John" --lastName "Doe" --jobTitle "Sales Manager" --officeLocation "Vosselaar" --preferredLanguage "nl-BE"
+  # aad user get --userName "john.doe@contoso.com" --withManager
 
   Date: 16/02/2023
 
@@ -135,13 +228,13 @@ m365 aad user get --userName "@meUserName"
   displayName | John Doe
   givenName | John
   jobTitle | Sales Manager
-  mail | null
-  mobilePhone | null
+  mail | john.doe@contoso.com
+  mobilePhone | +32499-99-99-99
   officeLocation | Vosselaar
   preferredLanguage | nl-BE
   surname | Doe
   userPrincipalName | john.doe@contoso.com
-  id | 0649d0bd-53dc-4e1d-a357-76f1d92d447b
+  id | 990e2425-f595-43bc-85ed-b89a44093793
   ```
 
   </TabItem>

package/docs/docs/cmd/pa/app/app-get.mdx

@@ -9,7 +9,7 @@ Gets information about the specified Microsoft Power App
 ## Usage
 
 ```sh
-pa app get [options]
+m365 pa app get [options]
 ```
 
 ## Options

package/docs/docs/cmd/pa/app/app-list.mdx

@@ -9,7 +9,7 @@ Lists all Power Apps apps
 ## Usage
 
 ```sh
-pa app list [options]
+m365 pa app list [options]
 ```
 
 ## Options

package/docs/docs/cmd/pa/app/app-owner-set.mdx

@@ -0,0 +1,60 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# pa app owner set
+
+Sets a new owner for a Power Apps app
+
+## Usage
+
+```sh
+m365 pa app owner set [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`--appName <appName>`
+: The name (GUID) of the Microsoft Power App.
+
+`--userId [userId]`
+: The Azure AD ID of the new owner. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: The user principal name of the new owner. Specify either `userId` or `userName` but not both.
+
+`--roleForOldAppOwner [roleForOldAppOwner]`
+: Grant permissions for the previous owner. Allowed values: `CanView`, `CanEdit`. Don't specify a value to remove the previous owner from the app.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global or Power Platform admin.
+
+:::
+
+## Examples
+
+Set a new owner for a Power Apps app and make the previous owner co-owner
+
+```sh
+m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userId c6ee6ed4-0172-4fdc-87a3-cfd9c324de1d --roleForOldAppOwner CanEdit
+```
+
+Set a new owner for a Power Apps app and remove the previous owner
+
+```sh
+m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userName john.doe@contoso.com
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pa/app/app-permission-list.mdx

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# pa app permission list
+
+Lists all permissions of a Power Apps app
+
+## Usage
+
+```sh
+m365 pa app permission list [options]
+```
+
+## Options
+
+```md definition-list
+`--appName <appName>`
+: The name (GUID) of the Microsoft Power App.
+
+`--roleName [roleName]`
+: Filter the results to only a given role: `Owner`, `CanEdit`, `CanView`.
+
+`--asAdmin`
+: Run the command as admin for apps you don't own.
+
+`-e, --environmentName [environmentName]`
+: The name of the environment. Required when using `asAdmin`.
+```
+
+<Global />
+
+## Remarks
+
+When you specify a value for `roleName`, consider the following:
+
+- `Owner` shows all the owners of the application.
+- `CanEdit` shows all the co-owners of the application.
+- `CanView` shows all the users with run only permissions.
+
+## Examples
+
+List all permissions for an app you have access to
+
+```sh
+m365 pa app permission list --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0
+```
+
+List all permissions as admin for an app you don't have access to
+
+```sh
+m365 pa app permission list --environmentName "Default-e448e34a-40cc-441a-94c6-ec701a9a9ec2" --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --asAdmin
+```
+
+List all co-owners for an app you have access to
+
+```sh
+m365 pa app permission list --appName bc9f0a7e-53df-46af-b669-5888bb2f63d0 --roleName CanEdit
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "name": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+      "id": "/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+      "type": "Microsoft.PowerApps/apps/permissions",
+      "properties": {
+        "roleName": "Owner",
+        "principal": {
+          "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+          "displayName": "John Doe",
+          "email": "john@contoso.com",
+          "type": "User",
+          "tenantId": "e1dd4023-a656-480a-8a0e-c1b1eec51e1d"
+        },
+        "scope": "/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb",
+        "notifyShareTargetOption": "NotSpecified",
+        "inviteGuestToTenant": false,
+        "createdOn": "2022-10-25T21:28:14.2122305Z",
+        "createdBy": "f0db9c91-3dae-49c8-98fa-8059b8909d45"
+      },
+      "roleName": "Owner",
+      "principalId": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+      "principalType": "User"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  roleName  principalId                           principalType
+  --------  ------------------------------------  -------------
+  Owner     fe36f75e-c103-410b-a18a-2bf6df06ac3a  User
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  name,id,type,roleName,principalId,principalType
+  fe36f75e-c103-410b-a18a-2bf6df06ac3a,/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a,Microsoft.PowerApps/apps/permissions,Owner,fe36f75e-c103-410b-a18a-2bf6df06ac3a,User
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # pa app permission list --appName "37ea6004-f07b-46ca-8ef3-a256b67b4dbb"
+
+  Date: 25/06/2023
+
+  ## fe36f75e-c103-410b-a18a-2bf6df06ac3a (/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
+
+  Property | Value
+  ---------|-------
+  name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
+  id | /providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a
+  type | Microsoft.PowerApps/apps/permissions
+  roleName | Owner
+  principalId | fe36f75e-c103-410b-a18a-2bf6df06ac3a
+  principalType | User
+  ```
+
+  </TabItem>
+</Tabs>

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

@@ -19,10 +19,13 @@ m365 planner bucket add [options]
 : Name of the bucket to add.
 
 `--planId [planId]`
-: ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
+: ID of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
 
 `--planTitle [planTitle]`
-: Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
+: Title of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
 
 `--ownerGroupId [ownerGroupId]`
 : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -36,20 +39,34 @@ m365 planner bucket add [options]
 
 <Global />
 
+## Remarks
+
+:::caution
+
+When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
 ## Examples
 
-Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the ID _xqQg5FS2LkCp935s-FIFm2QAFkHM_ with order hint
+Adds a Microsoft Planner bucket for a plan based on its ID with an order hint
 
 ```sh
 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 title _My Planner Plan_ owned by group _My Planner Group_
+Adds a Microsoft Planner bucket for a plan based on its title and owner group name
 
 ```sh
 m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
 
+Adds a Microsoft Planner bucket for a plan based on its Planner Roster ID
+
+```sh
+m365 planner bucket add --name "My Planner Bucket" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
+```
+
 ## Response
 
 <Tabs>

package/docs/docs/cmd/planner/bucket/bucket-get.mdx

@@ -22,10 +22,13 @@ m365 planner bucket get [options]
 : Name of the bucket to retrieve details. Specify either `id` or `name` but not both. 
 
 `--planId [planId]`
-: ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
+: ID of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
 
 `--planTitle [planTitle]`
-: Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
+: Title of the plan to which the bucket belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple when using `name`.
 
 `--ownerGroupId [ownerGroupId]`
 : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -36,6 +39,14 @@ m365 planner bucket get [options]
 
 <Global />
 
+## Remarks
+
+:::caution
+
+When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
 ## Examples
 
 Gets the specified Microsoft Planner bucket 
@@ -44,24 +55,30 @@ Gets the specified Microsoft Planner bucket
 m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
 ```
 
-Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
+Gets the Microsoft Planner bucket based on its plan ID
 
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
 ```
 
-Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
+Gets the Microsoft Planner bucket based on its plan title and owner group name
 
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
 ```
 
-Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
+Gets the Microsoft Planner bucket based on its plan title and owner group ID
 
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
 ```
 
+Gets the Microsoft Planner bucket based on its Roster ID
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
+```
+
 ## Response
 
 <Tabs>