Skip to main content

planner bucket get

Gets the Microsoft Planner bucket in a plan

Usage​

m365 planner bucket get [options]

Options​

-i, --id [id]

ID of the bucket to retrieve details. Specify either id or name but not both.

-n, --name [name]

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, planTitle, or rosterId but not multiple when using name.

--planTitle [planTitle]

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.

--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, 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​

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 

m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"

Gets the Microsoft Planner bucket based on its plan ID

m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"

Gets the Microsoft Planner bucket based on its plan title and owner group name

m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"

Gets the Microsoft Planner bucket based on its plan title and owner group ID

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

m365 planner bucket get --name "Planner Bucket A" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"

Response​

{
  "name": "My Planner Bucket",
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "orderHint": "8585363889524958496",
  "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
}
CTRL + M