Skip to main content

planner bucket add

Adds a new Microsoft Planner bucket

Usage​

m365 planner bucket add [options]

Options​

-n, --name <name>

Name of the bucket to add.

--planId [planId]

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

--orderHint [orderHint]

Hint used to order items of this type in a list view. The format is defined as outlined here.

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

Adds a Microsoft Planner bucket for a plan based on its ID with an order hint

m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"

Adds a Microsoft Planner bucket for a plan based on its title and owner group name

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

m365 planner bucket add --name "My Planner Bucket" --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"

Response​

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