@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388

package/docs/docs/cmd/spo/customaction/customaction-add.mdx

@@ -0,0 +1,146 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo customaction add
+
+Adds a user custom action for site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to add the custom action
+
+`-n, --name <name>`
+: The name of the custom action
+
+`-t, --title <title>`
+: The title of the custom action
+
+`-l, --location <location>`
+: The actual location where this custom action need to be added like `CommandUI.Ribbon`
+
+`-g, --group [group]`
+: The group where this custom action needs to be added like `SiteActions`
+
+`-d, --description [description]`
+: The description of the custom action
+
+`--sequence [sequence]`
+: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page
+
+`--actionUrl [actionUrl]`
+: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx`
+
+`--imageUrl [imageUrl]`
+: The URL of the image associated with the custom action
+
+`-e, --commandUIExtension [commandUIExtension]`
+: XML fragment that determines user interface properties of the custom action
+
+`--registrationId [registrationId]`
+: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier
+
+`--registrationType [registrationType]`
+: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Default `None`
+
+`--rights [rights]`
+: A case sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `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`, `FullMask`. Default `EmptyMask`
+
+`-s, --scope [scope]`
+: Scope of the custom action. Allowed values `Site`, `Web`. Default `Web`
+
+`--scriptBlock [scriptBlock]`
+: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
+
+`--scriptSrc [scriptSrc]`
+: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the custom action
+
+`-p, --clientSideComponentProperties [clientSideComponentProperties]`
+: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'`
+```
+
+<Global />
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+The `--rights` option accepts **case sensitive** values.
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{"testMessage":"Test message"}'
+```
+
+Adds tenant-wide SharePoint Framework **modern List View** Command Set extension in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourCommandSet" --name "YourName" --location "ClientSideExtension.ListViewCommandSet" --clientSideComponentId db3e6e35-363c-42b9-a254-ca661e437848 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --registrationId 100 --registrationType List
+```
+
+Creates url custom action in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --sequence 100
+```
+
+Creates custom action in **classic** Document Library edit context menu in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "EditControlBlock" --actionUrl "javascript:(function(){ return console.log('CLI for Microsoft 365 rocks!'); })();" --registrationId 101 --registrationType List
+```
+
+Creates ScriptLink custom action with script source in **classic pages** in site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptSrc "~sitecollection/SiteAssets/YourScript.js" --sequence 101 --scope Site
+```
+
+Creates ScriptLink custom action with script block in **classic pages** in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptBlock "(function(){ return console.log('Hello CLI for Microsoft 365!'); })();" --sequence 102
+```
+
+Creates **classic List View** custom action located in the Ribbon in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "CommandUI.Ribbon" --commandUIExtension '<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location="Ribbon.List.Share.Controls._children"><Button Id="Ribbon.List.Share.GetItemsCountButton" Alt="Get list items count" Sequence="11" Command="Invoke_GetItemsCountButtonRequest" LabelText="Get Items Count" TemplateAlias="o1" Image32by32="_layouts/15/images/placeholder32x32.png" Image16by16="_layouts/15/images/placeholder16x16.png" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command="Invoke_GetItemsCountButtonRequest" CommandAction="javascript: alert(ctx.TotalListItems);" EnabledScript="javascript: function checkEnable() { return (true);} checkEnable();"/></CommandUIHandlers></CommandUIExtension>'
+```
+
+Creates custom action with delegated rights in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --rights "AddListItems,DeleteListItems,ManageLists"
+```
+
+## More information
+
+- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
+- UserCustomAction Locations and Group IDs: [https://msdn.microsoft.com/en-us/library/office/bb802730.aspx](https://msdn.microsoft.com/en-us/library/office/bb802730.aspx)
+- UserCustomAction Element: [https://msdn.microsoft.com/en-us/library/office/ms460194.aspx](https://msdn.microsoft.com/en-us/library/office/ms460194.aspx)
+- UserCustomAction Rights: [https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx)

package/docs/docs/cmd/spo/customaction/customaction-clear.mdx

@@ -0,0 +1,47 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo customaction clear
+
+Deletes all custom actions from site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction clear [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to clear the custom actions from
+
+`-s, --scope [scope]`
+: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`
+
+`--confirm`
+: Don't prompt for confirming removing all custom actions
+```
+
+<Global />
+
+## Examples
+
+Clears all user custom actions for both site and site collection _https://contoso.sharepoint.com/sites/test_.
+Skips the confirmation prompt message.
+
+```sh
+m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --confirm
+```
+
+Clears all user custom actions for site _https://contoso.sharepoint.com/sites/test_. 
+
+```sh
+m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+Clears all user custom actions for site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Site
+```

package/docs/docs/cmd/spo/customaction/customaction-get.mdx

@@ -0,0 +1,175 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo customaction get
+
+Gets information about a user custom action for site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction get [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id [id]`
+: ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
+
+`-t, --title [title]`
+: Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
+
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to retrieve the custom action from
+
+`-s, --scope [scope]`
+: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`
+```
+
+<Global />
+
+## Remarks
+
+If the command finds multiple user custom actions with the specified `title` or `clientSideComponentId`, it will prompt you to disambiguate which user custom action it should get, listing the discovered IDs.
+
+## Examples
+
+Return details about the user custom action based on the id and a given url
+
+```sh
+m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Return details about the user custom action based on the title and a given url
+
+```sh
+m365 spo customaction get --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Return details about the user custom action based on the clientSideComponentId and a given url
+
+```sh
+m365 spo customaction get --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Return details about the user custom action based on the id and a given url and the scope
+
+```sh
+m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
+```
+
+Return details about the user custom action based on the id and a given url and the scope
+
+```sh
+m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+Return details about the user custom action based on the id and a given url and the scope
+
+```sh
+m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "ClientSideComponentId": "34a019f9-6198-4053-a3b6-fbdea9a107fd",
+    "ClientSideComponentProperties": "{\"sampleTextOne\":\"One item is selected in the list.\", \"sampleTextTwo\":\"This command is always visible.\"}",
+    "CommandUIExtension": null,
+    "Description": null,
+    "Group": null,
+    "Id": "158cb0d1-8703-4a36-866d-84aed8233bd3",
+    "ImageUrl": null,
+    "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
+    "Name": "{158cb0d1-8703-4a36-866d-84aed8233bd3}",
+    "RegistrationId": "100",
+    "RegistrationType": 1,
+    "Rights": "{\"High\":0,\"Low\":0}",
+    "Scope": "Web",
+    "ScriptBlock": null,
+    "ScriptSrc": null,
+    "Sequence": 65536,
+    "Title": "ExtensionTraining",
+    "Url": null,
+    "VersionOfUserCustomAction": "1.0.1.0"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ClientSideComponentId        : 34a019f9-6198-4053-a3b6-fbdea9a107fd
+  ClientSideComponentProperties: {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
+  CommandUIExtension           : null
+  Description                  : null
+  Group                        : null
+  Id                           : 158cb0d1-8703-4a36-866d-84aed8233bd3
+  ImageUrl                     : null
+  Location                     : ClientSideExtension.ListViewCommandSet.CommandBar
+  Name                         : {158cb0d1-8703-4a36-866d-84aed8233bd3}
+  RegistrationId               : 100
+  RegistrationType             : 1
+  Rights                       : {"High":0,"Low":0}
+  Scope                        : Web
+  ScriptBlock                  : null
+  ScriptSrc                    : null
+  Sequence                     : 65536
+  Title                        : ExtensionTraining
+  Url                          : null
+  VersionOfUserCustomAction    : 1.0.1.0
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
+  34a019f9-6198-4053-a3b6-fbdea9a107fd,"{""sampleTextOne"":""One item is selected in the list."", ""sampleTextTwo"":""This command is always visible.""}",,,,158cb0d1-8703-4a36-866d-84aed8233bd3,,ClientSideExtension.ListViewCommandSet.CommandBar,{158cb0d1-8703-4a36-866d-84aed8233bd3},100,1,"{""High"":0,""Low"":0}",Web,,,65536,ExtensionTraining,,1.0.1.0
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo customaction get --webUrl "https://contoso.sharepoint.com" --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --scope "Web"
+
+  Date: 27/1/2023
+
+  ## ExtensionTraining (158cb0d1-8703-4a36-866d-84aed8233bd3)
+
+  Property | Value
+  ---------|-------
+  ClientSideComponentId | 34a019f9-6198-4053-a3b6-fbdea9a107fd
+  ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
+  CommandUIExtension | null
+  Description | null
+  Group | null
+  Id | 158cb0d1-8703-4a36-866d-84aed8233bd3
+  ImageUrl | null
+  Location | ClientSideExtension.ListViewCommandSet.CommandBar
+  Name | {158cb0d1-8703-4a36-866d-84aed8233bd3}
+  RegistrationId | 100
+  RegistrationType | 1
+  Rights | {"High":0,"Low":0}
+  Scope | Web
+  ScriptBlock | null
+  ScriptSrc | null
+  Sequence | 65536
+  Title | ExtensionTraining
+  Url | null
+  VersionOfUserCustomAction | 1.0.1.0
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/customaction/customaction-list.mdx

@@ -0,0 +1,51 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo customaction list
+
+Lists user custom actions for site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to retrieve the custom action from
+
+`-s, --scope [scope]`
+: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`
+```
+
+<Global />
+
+## Remarks
+
+When using the text output type (default), the command lists only the values of the `Name`, `Location`, `Scope` and `Id` properties of the custom action. When setting the output type to JSON, all available properties are included in the command output.
+
+## Examples
+
+Return details about all user custom actions located in site or site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Return details about all user custom actions located in site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site
+```
+
+Return details about all user custom actions located in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+## More information
+
+- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)

package/docs/docs/cmd/spo/customaction/customaction-remove.mdx

@@ -0,0 +1,90 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo customaction remove
+
+Removes specified custom action from site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id [id]`
+: Id (GUID) of the custom action to remove. Specify either `id` or `title`
+
+`-t, --title [title]`
+: Title of the user custom action to retrieve information for. Specify either `id` or `title`
+
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to remove the custom action from
+
+`-s, --scope [scope]`
+: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`
+
+`--confirm`
+: Don't prompt for confirming removal of a user custom action
+```
+
+<Global />
+
+## Remarks
+
+If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
+
+## Examples
+
+Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
+```
+
+Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message.
+
+```sh
+m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --confirm
+```
+
+Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message.
+
+```sh
+m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --confirm
+```
+
+Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Site
+```
+
+Removes user custom action with Title _YourAppCustomizer_ located in site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
+```
+
+Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+Removes user custom action with Title _YourAppCustomizer_ located in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
+```
+
+## More information
+
+- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)

package/docs/docs/cmd/spo/customaction/customaction-set.mdx

@@ -0,0 +1,131 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo customaction set
+
+Updates a user custom action for site or site collection
+
+## Usage
+
+```sh
+m365 spo customaction set [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: Url of the site or site collection to update the custom action
+
+`-i, --id <id>`
+: ID of the custom action to update
+
+`-n, --name [name]`
+: The name of the custom action
+
+`-t, --title [title]`
+: The title of the custom action
+
+`-l, --location [location]`
+: The actual location where this custom action need to be added like `CommandUI.Ribbon`
+
+`-g, --group [group]`
+: The group of the custom action like `SiteActions`
+
+`-d, --description [description]`
+: The description of the custom action
+
+`--sequence [sequence]`
+: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page
+
+`--actionUrl [actionUrl]`
+: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx`
+
+`--imageUrl [imageUrl]`
+: The URL of the image associated with the custom action
+
+`-e, --commandUIExtension [commandUIExtension]`
+: XML fragment that determines user interface properties of the custom action
+
+`--registrationId [registrationId]`
+: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier
+
+`--registrationType [registrationType]`
+: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Default `None`
+
+`--rights [rights]`
+: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `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`, `FullMask`. Default `EmptyMask`
+
+`-s, --scope [scope]`
+: Scope of the existing custom action. Allowed values `Site`, `Web`, `All`. Default `All`. Note, this would not update the scope, but might speed up the execution of the scope of the custom action is known.
+
+`--scriptBlock [scriptBlock]`
+: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
+
+`--scriptSrc [scriptSrc]`
+: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the custom action
+
+`-p, --clientSideComponentProperties [clientSideComponentProperties]`
+: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'`
+```
+
+<Global />
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+The `--rights` option accepts **case-sensitive** values.
+
+Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"testMessage":"Test message"}'
+```
+
+Updates tenant-wide SharePoint Framework **modern List View** Command Set extension in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --sequence 100
+```
+
+Updates url custom action in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --actionUrl "~site/SitePages/Home.aspx"
+```
+
+Updates ScriptLink custom action with script source in **classic pages** in site collection _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --scriptSrc "~sitecollection/SiteAssets/YourScript.js"
+```
+
+Creates custom action with delegated rights in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
+
+```sh
+m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --rights "AddListItems,DeleteListItems,ManageLists"
+```
+
+## More information
+
+- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
+- UserCustomAction Locations and Group IDs: [https://msdn.microsoft.com/en-us/library/office/bb802730.aspx](https://msdn.microsoft.com/en-us/library/office/bb802730.aspx)
+- UserCustomAction Element: [https://msdn.microsoft.com/en-us/library/office/ms460194.aspx](https://msdn.microsoft.com/en-us/library/office/ms460194.aspx)
+- UserCustomAction Rights: [https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx)