Skip to content

planner roster get

Gets information about the specific Microsoft Planner Roster.

Usage

m365 planner roster get [options]

Options

--id <id>
ID of the Planner Roster.
-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

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

Examples

Gets information about a specific Planner Roster.

m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd

Response

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

assignedSensitivityLabel: null
id                      : tYqYlNd6eECmsNhN_fcq85cAGAnd

id,assignedSensitivityLabel
tYqYlNd6eECmsNhN_fcq85cAGAnd,

# planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"

Date: 1/30/2023

## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)

Property | Value
---------|-------
id | tYqYlNd6eECmsNhN_fcq85cAGAnd
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.