spo sitedesign rights revoke¶
Revokes access from a site design for one or more principals
Usage¶
m365 spo sitedesign rights revoke [options]
Options¶
-i, --siteDesignId <siteDesignId>
- The ID of the site design to revoke rights from
-p, --principals <principals>
- Comma-separated list of principals to revoke view rights from. Principals can be users or mail-enabled security groups in the form of
alias
oralias@<domain name>.com
--confirm
- Don't prompt for confirming removing the site design
-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¶
If the specified id doesn't refer to an existing site design, you will get a File not found
error.
If all principals have rights revoked on the site design, the site design becomes viewable to everyone.
If you try to revoke access for a user that doesn't have access granted to the specified site design you will get a The specified user or domain group was not found error
.
Examples¶
Revoke access to the site design with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a from user with alias PattiF. Will prompt for confirmation before revoking the access
m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals PattiF
Revoke access to the site design with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a from users with aliases PattiF and AdeleV without prompting for confirmation
m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals "PattiF,AdeleV" --confirm
More information¶
- SharePoint site design and site script overview: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview