planner roster member remove¶
Removes a member from a Microsoft Planner Roster
Usage¶
m365 planner roster member remove [options]
Options¶
--rosterId <rosterId>
- ID of the Planner Roster.
--userId [userId]
- User's Azure AD ID. Specify either
userId
oruserName
but not both. --userName [userName]
- User's UPN (user principal name, e.g. johndoe@example.com). Specify either
userId
oruserName
but not both. --confirm
- Don't prompt for confirmation.
-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 isfull
. --query [query]
- JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
- Output type.
json,text,csv,md
. Defaultjson
--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.
Attention
The Planner Roster will be deleted when it doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation. We will show an extra prompt when this happens. This prompt is also suppressed when specifying --confirm
.
Examples¶
Remove a Roster member by its Azure AD ID
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
Remove a Roster member by its UPN
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
Response¶
The command won't return a response on success.