Skip to content

New command: planner roster member remove #4394

@milanholemans

Description

@milanholemans

Usage

m365 planner roster member remove [options]

Description

Removes a member from a Microsoft Planner Roster

Options

Option Description
--rosterId <rosterId> ID of the Planner Roster.
--userId [userId] User's Azure AD ID. Specify either userId or userName but not both.
--userName [userName] User's UPN (user principal name, e.g. [email protected]). Specify either userId or userName but not both.
--confirm Don't prompt for confirmation.

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 [email protected]

Default properties

No response

Additional Info

API request: https://learn.microsoft.com/en-us/graph/api/plannerrostermember-delete?view=graph-rest-beta&tabs=http

Let's add this to the docs:

  • 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.
  • Remarks: We will show an additional prompt if you want to remove the last user of a Roster. This prompt is also suppressed when specifying --confirm

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions