Skip to content

planner roster member add

Adds a user to a Microsoft Planner Roster

Usage

m365 planner roster member add [options]

Options

--rosterId <rosterId>
ID of the Planner Roster.
--userId [userId]
User's Azure AD ID. Specify either userId, userName but not both.
--userName [userName]
User's UPN (user principal name, e.g. johndoe@example.com). Specify either userId, userName 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

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

Adds a specific user by user name as member of the Planner Roster

m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com

Adds a specific user by ID as member of the Planner Roster

m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275

Response

{
  "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
  "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
  "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
  "roles": []
}

id      : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
roles   : []
tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
userId  : 2056d2f6-3257-4253-8cfc-b73393e414e5

id,userId,tenantId,roles
b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]

# planner roster member add --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"

Date: 6/2/2023

## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b

Property | Value
---------|-------
id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
roles | []