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 or planTitle when using name.
--planTitle [planTitle]: Title of the plan to which the bucket belongs. Specify either planId or planTitle 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 full.
--query [query]: JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]: Output type. json,text,csv. Default json
--verbose: Runs command with verbose logging
--debug: Runs command with debug logging

Examples¶

Gets the specified Microsoft Planner bucket

m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"

Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM

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

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

m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"

Response¶

JSONTextCSV

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

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

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