spo file roleassignment add¶
Adds a role assignment to the specified file.
Usage¶
m365 spo file roleassignment add [options]
Options¶
-u, --webUrl <webUrl>
- URL of the site where the file is located.
--fileUrl [fileUrl]
- The server-relative URL of the file to retrieve. Specify either
fileUrl
orfileId
but not both. i, --fileId [fileId]
- The UniqueId (GUID) of the file to retrieve. Specify either
fileUrl
orfileId
but not both. --principalId [principalId]
- The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either
upn
,groupName
, orprincipalId
but not multiple. --upn [upn]
- upn/email of user to assign role to. Specify either
upn
,groupName
, orprincipalId
but not multiple. --groupName [groupName]
- The group name of Azure AD or SharePoint group. Specify either
upn
,groupName
, orprincipalId
but not multiple. --roleDefinitionId [roleDefinitionId]
- ID of role definition. Specify either
roleDefinitionId
orroleDefinitionName
but not both. --roleDefinitionName [roleDefinitionName]
- Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either
roleDefinitionId
orroleDefinitionName
but not both. -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
Examples¶
Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
Adds a role assignment to a file with a specified server-relative URL the for a specific group and a role definition name.
m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"