Skip to main content

planner roster plan list

Lists all Microsoft Planner Roster plans for a specific user

Usage

m365 planner roster plan list [options]

Options

--userId [userId]

User's Microsoft Entra ID. Specify either userId or userName but not both. Specify this option only when using application permissions.

--userName [userName]

User's UPN (user principal name, e.g. johndoe@example.com). Specify either userId or userName but not both. Specify this option only when using application permissions.

-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

warning

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

Examples

List all Planner plans contained in a Roster where the current logged in user is member of.

m365 planner roster plan list

List all Planner plans contained in a Roster where specific user is member of by its UPN.

m365 planner roster plan list --userName john.doe@contoso.com

List all Planner plans contained in a Roster where specific user is member of by its Id.

m365 planner roster plan list --userId 59f80e08-24b1-41f8-8586-16765fd830d3

Response

[
{
"createdDateTime": "2023-04-06T14:41:49.8676617Z",
"owner": "59f80e08-24b1-41f8-8586-16765fd830d3",
"title": "My Planner Plan",
"creationSource": null,
"id": "_5GY9MJpZU2vb3DC46CP3MkACr8m",
"createdBy": {
"user": {
"displayName": null,
"id": "59f80e08-24b1-41f8-8586-16765fd830d3"
},
"application": {
"displayName": null,
"id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
}
},
"container": {
"containerId": "_5GY9MJpZU2vb3DC46CP3MkACr8m",
"type": "unknownFutureValue",
"url": "https://graph.microsoft.com/beta/planner/rosters/_5GY9MJpZU2vb3DC46CP3MkACr8m"
},
"contexts": {},
"sharedWithContainers": []
}
]
CTRL + M