planner plan set¶

Updates a Microsoft Planner plan

Usage¶

m365 planner plan set [options]

Options¶

-i, --id [id]: ID of the plan. Specify either id, title or rosterId but not multiple.
-t, --title [title]: Title of the plan. Specify either id, title or rosterId but not multiple.
--rosterId [rosterId]: ID of the Planner Roster. Specify either id, title or rosterId but not multiple.
--ownerGroupId [ownerGroupId]: ID of the group to which the plan belongs. Specify either ownerGroupId or ownerGroupName when using title but not both.
--ownerGroupName [ownerGroupName]: Name of the Group to which the plan belongs. Specify either ownerGroupId or ownerGroupName when using title but not both.
--newTitle [newTitle]: New title of the plan.
--shareWithUserIds [shareWithUserIds]: The comma-separated IDs of the users with whom you want to share the plan. Specify either shareWithUserIds or shareWithUserNames but not both.
--shareWithUserNames [shareWithUserNames]: The comma-separated UPNs of the users with whom you want to share the plan. Specify either shareWithUserIds or shareWithUserNames but not both.
-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¶

This command allows using unknown options.

--category1 [category1]: New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., --category4, --category12.

Attention

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¶

Updates a Microsoft Planner plan title to New Title

m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --newTitle 'New Title'

Share a Microsoft Planner plan owned by the group, with the users

m365 planner plan set --title 'Plan Title' --ownerGroupName 'My Group' --shareWithUserNames 'user1@contoso.com,user2@contoso.com'

Updates a Microsoft Planner plan category labels

m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'

Response¶

Standard response¶

JSONTextCSVMarkdown

{
  "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"
  }
}

createdDateTime: 2015-03-30T18:36:49.2407981Z
id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
title          : My Planner Plan

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

# planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"

Date: 30/03/2015

## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)

Property | Value
---------|-------
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"}

`shareWithUserIds`, `shareWithUserNames` response¶

When we make use of the option shareWithUserIds or shareWithUserNames the response will differ.