Skip to main content

planner plan list

Returns a list of plans associated with a specified group

Usage

m365 planner plan list [options]

Options

--ownerGroupId [ownerGroupId]

ID of the Group that owns the plan. Specify either ownerGroupId, ownerGroupName or rosterId.

--ownerGroupName [ownerGroupName]

Name of the Group that owns the plan. Specify either ownerGroupId, ownerGroupName or rosterId.

--rosterId [rosterId]

ID of the Planner Roster. Specify either ownerGroupId, ownerGroupName or rosterId.

-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

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

Returns a list of Microsoft Planner plans for the specified Group by id.

m365 planner plan list --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"

Returns a list of Microsoft Planner plans for the specified Group by name.

m365 planner plan list --ownerGroupName "My Planner Group"

Returns a list of Microsoft Planner plans for the specified Roster.

m365 planner plan list --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"

Response

[
{
"createdDateTime": "2015-03-30T18:36:49.2407981Z",
"owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
"title": "My Planner Plan",
"id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
"createdBy": {
"user": {
"displayName": null,
"id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
},
"application": {
"displayName": null,
"id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
}
},
"container": {
"containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
"type": "group",
"url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
}
}
]
CTRL + M