Skip to main content

spo tenant applicationcustomizer set

Updates an Application Customizer that is deployed as a tenant-wide extension

Usage​

m365 spo tenant applicationcustomizer set [options]

Options​

-t, --title [title]

The title of the Application Customizer to update. Specify either title, id or clientSideComponentId.

-i, --id [id]

The id of the Application Customizer to update. Specify either title, id or clientSideComponentId.

-c, --clientSideComponentId [clientSideComponentId]

The Client Side Component Id (GUID) of the Application Customizer to update. Specify either title, id or clientSideComponentId.

--newTitle [newTitle]

The updated title of the Application Customizer.

--newClientSideComponentId [newClientSideComponentId]

The new 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 clientSideComponentProperties option that has JSON value because the command shell treats quotes differently. For example, this is how Application Customizer can be updated from the Windows cmd.exe:

m365 spo tenant applicationcustomizer set --id 3 --clientSideComponentProperties '{\"someProperty\":\"Some value\"}'

Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes '{\"someProperty\":\"Some value\"}' compared to execution from bash '{"someProperty": "Some value"}'.

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.

This command can be used for updating an application customizer that's installed tenant-wide. To update an application customizer from a specific site, view our dedicated spo applicationcustomizer set command.

Examples​

Updates the title of an Application Customizer that is deployed as a tenant-wide extension by its id

m365 spo tenant applicationcustomizer set --id 3 --newTitle "Some customizer"

Updates the Client Side Component Id of an Application Customizer that is deployed as a tenant-wide extension by its id

m365 spo tenant applicationcustomizer set --id 3 --newClientSideComponentId "b44a5182-9877-4029-baec-0181c70dacbc"

Updates the properties of an Application Customizer that is deployed as a tenant-wide extension by its id

m365 spo tenant applicationcustomizer set --id 3 --clientSideComponentProperties '{ "someProperty": "Some value" }'

Updates the title of an Application Customizer that is deployed as a tenant-wide extension by its title

m365 spo tenant applicationcustomizer set --title "Some customizer" --newTitle "Updated customizer"

Updates the title of an Application Customizer that is deployed as a tenant-wide extension by its clientSideComponentId

m365 spo tenant applicationcustomizer set --clientSideComponentId "7f8fd1f2-9d26-4a4a-a607-bf4622d7ec11" --newTitle "Some customizer"

Response​

The command won't return a response on success.

CTRL + M