@pnp/cli-microsoft365 6.0.0-beta.27b9708 → 6.0.0-beta.291f17c

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md

@@ -26,14 +26,13 @@ Specify either `listTitle`, `listId` or `listUrl`.
 Specify either `listTitle`, `listId` or `listUrl`.
 
 `-n, --name [name]`
-The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
+: The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
 
 `-i, --id [id]`
-The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
+: The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
 
 `-s, --scope [scope]`
-: The scope of which to retrieve the Event Receivers.
-Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+: The scope of which to retrieve the event receivers. Can be either `site` or `web`. Defaults to `web`. Only applicable when not specifying any of the list properties.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -68,3 +67,44 @@ Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ i
 ```sh
 m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ReceiverAssembly": "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",
+      "ReceiverClass": "Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver",
+      "ReceiverId": "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec",
+      "ReceiverName": "PnP Test Receiver",
+      "SequenceNumber": 10000,
+      "Synchronization": 2,
+      "EventType": 10204,
+      "ReceiverUrl": "https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    EventType       : 10204
+    ReceiverAssembly: Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
+    ReceiverClass   : Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver
+    ReceiverId      : c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+    ReceiverName    : PnP Test Receiver
+    ReceiverUrl     : https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
+    SequenceNumber  : 10000
+    Synchronization : 2
+    ```
+
+=== "CSV"
+
+    ```csv
+    ReceiverAssembly,ReceiverClass,ReceiverId,ReceiverName,SequenceNumber,Synchronization,EventType,ReceiverUrl
+    "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver,c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec,PnP Test Receiver,10000,2,10204,https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
+    ```
+
+
+
+

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md

@@ -0,0 +1,74 @@
+# spo eventreceiver remove
+
+Removes event receivers for the specified web, site, or list.
+
+## Usage
+
+```sh
+m365 spo eventreceiver remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web.
+
+`--listTitle [listTitle]`
+: The title of the list, _if the event receiver should be removed from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`-n, --name [name]`
+: The name. Specify either `name` or `id` but not both.
+
+`-i, --id [id]`
+: The id. Specify either `name` or `id` but not both.
+
+`-s, --scope [scope]`
+: The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    You can only remove an event receiver if it has been registered by an app with the same ID.
+
+## Examples
+
+Remove event receiver in a specific web by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific site by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by title by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific list retrieved by list id by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by list url by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
+```

package/docs/docs/cmd/spo/field/field-add.md

@@ -14,7 +14,13 @@ m365 spo field add [options]
 : Absolute URL of the site where the field should be created
 
 `-l, --listTitle [listTitle]`
-: Title of the list where the field should be created (if it should be created as a list column)
+: Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listId [listId]`
+: ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `-x, --xml <xml>`
 : CAML field definition
@@ -36,7 +42,7 @@ Create a date time site column
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
 ```
 
-Create a URL list column
+Create a URL list column to a list retrieved by Title
 
 ```sh
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
 ```
 
+Create a URL list column to a list retrieved by ID
+
+```sh
+m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
+```
+
+Create a date time list column to a list retrieved by URL
+
+```sh
+m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
+```
+
 ## More information
 
 - AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)

package/docs/docs/cmd/spo/field/field-set.md

@@ -14,10 +14,13 @@ m365 spo field set [options]
 : Absolute URL of the site where the field is located
 
 `--listId [listId]`
-: ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `--listTitle [listTitle]`
-: Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `-i, --id [id]`
 : ID of the field to update. Specify `id` or `title` but not both
@@ -25,9 +28,6 @@ m365 spo field set [options]
 `-t, --title [title]`
 : Title or internal name of the field to update. Specify `id` or `title` but not both
 
-`-n, --name [name]`
-: (deprecated. Use `title` instead) Title or internal name of the field to update. Specify `id` or `name` but not both
-
 `--updateExistingLists`
 : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
 
@@ -37,6 +37,9 @@ m365 spo field set [options]
 
 Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
 
+!!! warning "Escaping JSON in PowerShell"
+    When updating column formatting for a field with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
 ## Examples
 
 Update the title of the site column specified by its internal name and push changes to existing lists
@@ -51,8 +54,14 @@ Update the title of the list column specified by its ID
 m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
 ```
 
+Update the description of a column specified by the ID on a list retrieved by the URL
+
+```sh
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
+```
+
 Update column formatting of the specified list column
 
 ```sh
-m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
 ```

package/docs/docs/cmd/spo/file/file-get.md

@@ -31,54 +31,265 @@ m365 spo file get [options]
 `-p, --path [path]`
 : The local path where to save the retrieved file. Must be specified when the `--asFile` option is used
 
+`--withPermissions`
+: Set if you want to return associated roles and permissions
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Get file properties for file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Get file properties for a file with id (UniqueId) parameter located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
 ```
 
-Get contents of the file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Get contents of the file with id (UniqueId) parameter located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString
 ```
 
-Get list item properties for file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Get list item properties for a file with id (UniqueId) parameter located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem
 ```
 
-Save file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_ to local file _/Users/user/documents/SavedAsTest1.docx_
+Saves the file with id (UniqueId) parameter located in a site to a local file
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx
 ```
 
-Return file properties for file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Return file properties for a file with server-relative url located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
 ```
 
-Return file as string for file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Returns a file as string for a file with server-relative url located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asString
 ```
 
-Return list item properties for file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Returna the list item properties for a file with the server-relative url located in a site
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asListItem
 ```
 
-Save file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_ to local file _/Users/user/documentsSavedAsTest1.docx_
+Saves a file with the server-relative url located in a site to a local file
 
 ```sh
 m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx
 ```
+
+Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions
+
+```sh
+m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "CheckInComment": "",
+      "CheckOutType": 2,
+      "ContentTag": "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",
+      "CustomizedPageStatus": 0,
+      "ETag": "\"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1\"",
+      "Exists": true,
+      "IrmEnabled": false,
+      "Length": "5987",
+      "Level": 1,
+      "LinkingUri": null,
+      "LinkingUrl": "",
+      "MajorVersion": 1,
+      "MinorVersion": 0,
+      "Name": "Test1.docx",
+      "ServerRelativeUrl": "/sites/project-x/documents/Test1.docx",
+      "TimeCreated": "2022-10-30T10:16:18Z",
+      "TimeLastModified": "2022-10-30T10:16:18Z",
+      "Title": null,
+      "UIVersion": 512,
+      "UIVersionLabel": "1.0",
+      "UniqueId": "b2307a39-e878-458b-bc90-03bc578531d6"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    CheckInComment      :
+    CheckOutType        : 2
+    ContentTag          : {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
+    CustomizedPageStatus: 0
+    ETag                : "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
+    Exists              : true
+    IrmEnabled          : false
+    Length              : 5987
+    Level               : 1
+    LinkingUri          : null
+    LinkingUrl          :
+    MajorVersion        : 1
+    MinorVersion        : 0
+    Name                : Test1.docx
+    ServerRelativeUrl   : /sites/project-x/documents/Test1.docx
+    TimeCreated         : 2022-10-30T10:16:18Z
+    TimeLastModified    : 2022-10-30T10:16:18Z
+    Title               : null
+    UIVersion           : 512
+    UIVersionLabel      : 1.0
+    UniqueId            : b2307a39-e878-458b-bc90-03bc578531d6
+    ```
+
+=== "CSV"
+
+    ```csv
+    CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,IrmEnabled,Length,Level,LinkingUri,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId
+    ,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6
+    ```
+
+### `withPermissions` response
+
+When we make use of the option `withPermissions` the response will differ.
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "CheckInComment": "",
+      "CheckOutType": 2,
+      "ContentTag": "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",
+      "CustomizedPageStatus": 0,
+      "ETag": "\"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1\"",
+      "Exists": true,
+      "IrmEnabled": false,
+      "Length": "5987",
+      "Level": 1,
+      "LinkingUri": null,
+      "LinkingUrl": "",
+      "MajorVersion": 1,
+      "MinorVersion": 0,
+      "Name": "Test1.docx",
+      "ServerRelativeUrl": "/sites/project-x/documents/Test1.docx",
+      "TimeCreated": "2022-10-30T10:16:18Z",
+      "TimeLastModified": "2022-10-30T10:16:18Z",
+      "Title": null,
+      "UIVersion": 512,
+      "UIVersionLabel": "1.0",
+      "UniqueId": "b2307a39-e878-458b-bc90-03bc578531d6",
+      "RoleAssignments": [
+        {
+          "Member": {
+            "Id": 3,
+            "IsHiddenInUI": false,
+            "LoginName": "Communication site Owners",
+            "Title": "Communication site Owners",
+            "PrincipalType": 8,
+            "AllowMembersEditMembership": false,
+            "AllowRequestToJoinLeave": false,
+            "AutoAcceptRequestToJoinLeave": false,
+            "Description": null,
+            "OnlyAllowMembersViewMembership": false,
+            "OwnerTitle": "Communication site Owners",
+            "RequestToJoinLeaveEmailSetting": ""
+          },
+          "RoleDefinitionBindings": [
+            {
+              "BasePermissions": {
+                "High": "2147483647",
+                "Low": "4294967295"
+              },
+              "Description": "Has full control.",
+              "Hidden": false,
+              "Id": 1073741829,
+              "Name": "Full Control",
+              "Order": 1,
+              "RoleTypeKind": 5,
+              "BasePermissionsValue": [
+                "ViewListItems",
+                "AddListItems",
+                "EditListItems",
+                "DeleteListItems",
+                "ApproveItems",
+                "OpenItems",
+                "ViewVersions",
+                "DeleteVersions",
+                "CancelCheckout",
+                "ManagePersonalViews",
+                "ManageLists",
+                "ViewFormPages",
+                "AnonymousSearchAccessList",
+                "Open",
+                "ViewPages",
+                "AddAndCustomizePages",
+                "ApplyThemeAndBorder",
+                "ApplyStyleSheets",
+                "ViewUsageData",
+                "CreateSSCSite",
+                "ManageSubwebs",
+                "CreateGroups",
+                "ManagePermissions",
+                "BrowseDirectories",
+                "BrowseUserInfo",
+                "AddDelPrivateWebParts",
+                "UpdatePersonalWebParts",
+                "ManageWeb",
+                "AnonymousSearchAccessWebLists",
+                "UseClientIntegration",
+                "UseRemoteAPIs",
+                "ManageAlerts",
+                "CreateAlerts",
+                "EditMyUserInfo",
+                "EnumeratePermissions"
+              ],
+              "RoleTypeKindValue": "Administrator"
+            }
+          ],
+          "PrincipalId": 3
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    CheckInComment      :
+    CheckOutType        : 2
+    ContentTag          : {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
+    CustomizedPageStatus: 0
+    ETag                : "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
+    Exists              : true
+    IrmEnabled          : false
+    Length              : 5987
+    Level               : 1
+    LinkingUri          : null
+    LinkingUrl          :
+    MajorVersion        : 1
+    MinorVersion        : 0
+    Name                : Test1.docx
+    ServerRelativeUrl   : /sites/project-x/documents/Test1.docx
+    TimeCreated         : 2022-10-30T10:16:18Z
+    TimeLastModified    : 2022-10-30T10:16:18Z
+    Title               : null
+    UIVersion           : 512
+    UIVersionLabel      : 1.0
+    UniqueId            : b2307a39-e878-458b-bc90-03bc578531d6
+    RoleAssignments     : [{"Member":{"Id":3,"IsHiddenInUI":false,"LoginName":"Communication site Owners","Title":"Communication site Owners","PrincipalType":8,"AllowMembersEditMembership":false,"AllowRequestToJoinLeave":false,"AutoAcceptRequestToJoinLeave":false,"Description":null,"OnlyAllowMembersViewMembership":false,"OwnerTitle":"Communication site Owners","RequestToJoinLeaveEmailSetting":""},"RoleDefinitionBindings":[{"BasePermissions":{"High":"2147483647","Low":"4294967295"},"Description":"Has full control.","Hidden":false,"Id":1073741829,"Name":"Full Control","Order":1,"RoleTypeKind":5,"BasePermissionsValue":["ViewListItems","AddListItems","EditListItems","DeleteListItems","ApproveItems","OpenItems","ViewVersions","DeleteVersions","CancelCheckout","ManagePersonalViews","ManageLists","ViewFormPages","AnonymousSearchAccessList","Open","ViewPages","AddAndCustomizePages","ApplyThemeAndBorder","ApplyStyleSheets","ViewUsageData","CreateSSCSite","ManageSubwebs","CreateGroups","ManagePermissions","BrowseDirectories","BrowseUserInfo","AddDelPrivateWebParts","UpdatePersonalWebParts","ManageWeb","AnonymousSearchAccessWebLists","UseClientIntegration","UseRemoteAPIs","ManageAlerts","CreateAlerts","EditMyUserInfo","EnumeratePermissions"],"RoleTypeKindValue":"Administrator"}],"PrincipalId":3}]
+    ```
+
+=== "CSV"
+
+    ```csv
+    CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,IrmEnabled,Length,Level,LinkingUri,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId,RoleAssignments
+    ,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6,"[{""Member"":{""Id"":3,""IsHiddenInUI"":false,""LoginName"":""Communication site Owners"",""Title"":""Communication site Owners"",""PrincipalType"":8,""AllowMembersEditMembership"":false,""AllowRequestToJoinLeave"":false,""AutoAcceptRequestToJoinLeave"":false,""Description"":null,""OnlyAllowMembersViewMembership"":false,""OwnerTitle"":""Communication site Owners"",""RequestToJoinLeaveEmailSetting"":""""},""RoleDefinitionBindings"":[{""BasePermissions"":{""High"":""2147483647"",""Low"":""4294967295""},""Description"":""Has full control."",""Hidden"":false,""Id"":1073741829,""Name"":""Full Control"",""Order"":1,""RoleTypeKind"":5,""BasePermissionsValue"":[""ViewListItems"",""AddListItems"",""EditListItems"",""DeleteListItems"",""ApproveItems"",""OpenItems"",""ViewVersions"",""DeleteVersions"",""CancelCheckout"",""ManagePersonalViews"",""ManageLists"",""ViewFormPages"",""AnonymousSearchAccessList"",""Open"",""ViewPages"",""AddAndCustomizePages"",""ApplyThemeAndBorder"",""ApplyStyleSheets"",""ViewUsageData"",""CreateSSCSite"",""ManageSubwebs"",""CreateGroups"",""ManagePermissions"",""BrowseDirectories"",""BrowseUserInfo"",""AddDelPrivateWebParts"",""UpdatePersonalWebParts"",""ManageWeb"",""AnonymousSearchAccessWebLists"",""UseClientIntegration"",""UseRemoteAPIs"",""ManageAlerts"",""CreateAlerts"",""EditMyUserInfo"",""EnumeratePermissions""],""RoleTypeKindValue"":""Administrator""}],""PrincipalId"":3}]"
+    ```

package/docs/docs/cmd/spo/file/file-roleassignment-add.md

@@ -0,0 +1,57 @@
+# spo file roleassignment add
+
+Adds a role assignment to the specified file.
+
+## Usage
+
+```sh
+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` or `fileId` but not both.
+
+`i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` 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`, or `principalId` but not multiple.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
+
+`--groupName [groupName]`
+: The group name of Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
+
+`--roleDefinitionName [roleDefinitionName]`
+: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
+
+```sh
+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.
+
+```sh
+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.
+
+```sh
+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"
+```

package/docs/docs/cmd/spo/file/file-roleassignment-remove.md

@@ -0,0 +1,54 @@
+# spo file roleassignment remove
+
+Removes a role assignment from a file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId` but not multiple.
+
+`--upn [upn]`
+: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
+
+`--groupName [groupName]`
+: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a role assignment by principal id from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
+```
+
+Remove a role assignment by upn from a file by url
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
+```
+
+Remove a role assignment by group name from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
+```