planner roster add¶

Creates a new Microsoft Planner Roster

Usage¶

m365 planner roster add [options]

Options¶

-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,md. Default json
--verbose: Runs command with verbose logging
--debug: Runs command with debug logging

Remarks¶

Attention

The Roster will be automatically deleted when it doesn't contain a plan 24 hours after its creation. Membership information will be completely erased within 30 days of this deletion.

Attention

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

Important

To be able to create a new Roster, the Planner Roster creation tenant setting should be enabled. Use the planner tenant settings list command to check if this setting is enabled for your tenant.

Examples¶

Creates a new Microsoft Planner Roster

m365 planner roster add

Response¶

JSONTextCSVMarkdown

{
  "id": "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
  "assignedSensitivityLabel": null
}

assignedSensitivityLabel: null
id                      : e6fmvM_yi0OJgvmepE5uj5cAE6qX

id,assignedSensitivityLabel
e6fmvM_yi0OJgvmepE5uj5cAE6qX,

# planner roster add

Date: 7/2/2023

## e6fmvM_yi0OJgvmepE5uj5cAE6qX

Property | Value
---------|-------
id | e6fmvM_yi0OJgvmepE5uj5cAE6qX
assignedSensitivityLabel | null

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