Skip to main content

spo tenant applicationcustomizer add

Add an application customizer as a tenant-wide extension

Usage​

m365 spo tenant applicationcustomizer add [options]

Options​

-t, --title <title>

The title of the Application Customizer.

-i, --clientSideComponentId <clientSideComponentId>

The Client Side Component Id (GUID) of the application customizer.

-p, --clientSideComponentProperties [clientSideComponentProperties]

The Client Side Component properties of the application customizer.

-w, --webTemplate [webTemplate]

Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the application customizer is registered on.

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

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:

m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'

Note, how the clientSideComponentProperties option has escaped double quotes '{\"testMessage\":\"Test message\"}' compared to execution from bash '{"testMessage":"Test message"}'.

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 apply due to an issue. Remember that you can also use file tokens instead.

info

To use this command, you need to be a SharePoint Admin.

This command can be used for configuring a tenant-wide application customizer. To configure an application customizer on a specific site, view our dedicated spo applicationcustomizer add command.

Examples​

Adds an application customizer that's deployed tenant wide

m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc

Adds an application customizer that is configured for all communication sites.

m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0"

Response​

The command won't return a response on success.

CTRL + M