Skip to main content

viva engage community remove

Removes a Viva Engage community

Usage​

m365 viva engage community remove [options]

Options​

-i, --id [id]

The id of the community. Specify either id, displayName or entraGroupId, but not multiple.

-n, --displayName [displayName]

The name of the community. Specify either id, displayName or entraGroupId, but not multiple.

--entraGroupId [entraGroupId]

The id of the Microsoft 365 group associated with the community. Specify either id, displayName or entraGroupId, but not multiple.

-f, --force

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, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks​

info

When the Viva Engage community is removed, all the associated Microsoft 365 content, including the M365 group, the document library, OneNote notebook, and Planner plan is deleted.

Examples​

Remove a community specified by id without prompting

m365 viva engage community remove --id eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9 --force

Remove a community specified by name and prompt for confirmation

m365 viva engage community remove --displayName 'Software Engineers'

Remove a community specified by Entra group id and prompt for confirmation

m365 viva engage community remove --entraGroupId '0bed8b86-5026-4a93-ac7d-56750cc099f1'

Response​

The command won't return a response on success