Skip to content

plan-list.mdx

Latest commit

 

History

History
144 lines (105 loc) · 3.47 KB

plan-list.mdx

File metadata and controls

144 lines (105 loc) · 3.47 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

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

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.

:::

Permissions

Resource Permissions
Microsoft Graph Tasks.Read, GroupMember.Read.All
Resource Permissions
Microsoft Graph Tasks.Read.All, GroupMember.Read.All

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"
    }
  }
]
id                            title            createdDateTime               owner
----------------------------  ---------------  ----------------------------  ------------------------------------
xqQg5FS2LkCp935s-FIFm2QAFkHM  My Planner Plan  2015-03-30T18:36:49.2407981Z  ebf3b108-5234-4e22-b93d-656d7dae5874

id,title,createdDateTime,owner
xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
# planner plan list --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"

Date: 27/12/2022

## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)

Property | Value
---------|-------
createdDateTime | 2021-12-12T14:00:50.4522129Z
owner | ebf3b108-5234-4e22-b93d-656d7dae5874
title | My Planner Plan
id | xqQg5FS2LkCp935s-FIFm2QAFkHM