Skip to main content

spo customaction list

Lists user custom actions for site or site collection

Usage​

m365 spo customaction list [options]

Options​

-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.

-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 options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

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 the specified site or site collection.

m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test

Return details about all user custom actions located in the specified site collection.

m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site

Return details about all user custom actions located in the specified site.

m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web

Response​

[
  {
    "ClientSideComponentId": "b41916e7-e69d-467f-b37f-ff8ecf8f99f2",
    "ClientSideComponentProperties": "'{testMessage:Test message}'",
    "CommandUIExtension": null,
    "Description": null,
    "Group": null,
    "HostProperties": "",
    "Id": "a70d8013-3b9f-4601-93a5-0e453ab9a1f3",
    "ImageUrl": null,
    "Location": "ClientSideExtension.ApplicationCustomizer",
    "Name": "YourName",
    "RegistrationId": null,
    "RegistrationType": 0,
    "Rights": {
      "High": 0,
      "Low": 0
    },
    "Scope": 3,
    "ScriptBlock": null,
    "ScriptSrc": null,
    "Sequence": 0,
    "Title": "YourAppCustomizer",
    "Url": null,
    "VersionOfUserCustomAction": "16.0.1.0"
  }
]

More information​

CTRL + M