planner roster remove

Removes a Microsoft Planner Roster

Usage

m365 planner roster remove [options]

Options

--id <id>

ID of the Planner Roster.

-f, --force

Don't prompt for confirmation.

-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

Deleting a Planner Roster will also delete the plan within the Roster.

caution

This command is based on an API that is currently in preview and is subject to change once the API reached general availability.

Examples

Removes a Planner Roster

m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd

Removes a Planner Roster without confirmation prompt

m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd --force

Response

The command won't return a response on success.

More information

Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.