Skip to content

spo web roleinheritance break

Break role inheritance of subsite

Usage

m365 spo web roleinheritance break [options]

Options

-u, --webUrl <webUrl>
URL of the site.
-c, --clearExistingPermissions
Clears all existing permissions from the web.
--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 is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Remarks

By default, when breaking permissions inheritance, the web will retain existing permissions. To remove existing permissions, use the --clearExistingPermissions option.

Examples

Break role inheritance of a web and keep the existing permissions

m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x

Break role inheritance of a web and clear the existing permissions

m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --clearExistingPermissions

Response

The command won't return a response on success.