Skip to content

New command: spo applicationcustomizer remove #4332

@martinlingstuyl

Description

@martinlingstuyl

Usage

spo applicationcustomizer remove

Description

Remove an application customizer that is added to a site.

Options

Option Description
-u, --webUrl <webUrl> The url of the site.
-t, --title [title] The title of the Application Customizer. Specify either title, id or clientSideComponentId.
-i, --id [id] The id of the Application Customizer. Specify either title, id or clientSideComponentId.
-c, --clientSideComponentId [clientSideComponentId] The Client Side Component Id (GUID) of the application customizer. Specify either title, id or clientSideComponentId.
-s, --scope [scope] Scope of the application customizer. Allowed values: Site, Web, All. Defaults to All.
--confirm Don't prompt for confirming removal of the application customizer

Examples

Remove an application customizer by title.

m365 spo applicationcustomizer remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales

Remove an application customizer by id.

m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales

Remove an application customizer by clientSideComponentId.

m365 spo applicationcustomizer remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales

Additional Info

While developing we want to reuse the getCustomActions and getCustomActionById functions of the spo util class.

  • If the found custom action is not an Application Customizer: throw an error.
  • If two or more Application Customizer custom actions are found: prompt the user to disambiguate.

We can use the shared code to only query the right type of customaction with a location value of ClientSideExtension.ApplicationCustomizer.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions