planner bucket list

Lists the Microsoft Planner buckets in a plan

Usage

m365 planner bucket list [options]

Options

--planId [planId]

ID of the plan to list the buckets of. Specify either planId, planTitle, or rosterId but not multiple.

--planTitle [planTitle]

Title of the plan to list the buckets of. 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.

--ownerGroupName [ownerGroupName]

Name of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planTitle.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks

warning

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.

Permissions

Delegated

Resource	Permissions
Microsoft Graph	Tasks.Read, GroupMember.Read.All

Application

Resource	Permissions
Microsoft Graph	Tasks.Read.All, GroupMember.Read.All

Examples

Lists the Microsoft Planner buckets based on its plan ID

m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"

Lists the Microsoft Planner buckets based on its plan title and owner group name

m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"

Lists the Microsoft Planner buckets based on its Roster ID

m365 planner bucket list --planTitle "My Plan" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"

Response

JSON

[
  {
    "name": "My Planner Bucket",
    "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
    "orderHint": "8585363889524958496",
    "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
  }
]

Text

id                            name               planId                        orderHint
----------------------------  -----------------  ----------------------------  -------------------
ttEB_Uj690STdR3GC1MIDZgANq1U  My Planner Bucket  xqQg5FS2LkCp935s-FIFm2QAFkHM  8585363889524958496

CSV

id,name,planId,orderHint
ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496

Markdown

# planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"

Date: 27/12/2022

## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)

Property | Value
---------|-------
name | My Planner Bucket
planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
orderHint | 8585363889524958496
id | ttEB_Uj690STdR3GC1MIDZgANq1U