New command: spo applicationcustomizer get

[martinlingstuyl]

Usage

spo applicationcustomizer get

Description

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

Examples

Retrieves an application customizer by title.

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

Retrieves an application customizer by id.

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

Retrieves an application customizer by clientSideComponentId.

m365 spo applicationcustomizer get --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.

[waldekmastykarz]

We should extend the spec with the logic to determine that the retrieved custom action actually represents an app customizer rather than something else.

[nanddeepn]

Can I work on this?

[milanholemans]

Yes please!

[nanddeepn]

Hi @martinlingstuyl
The filter with clientSideComponentId does not seem to work.

For e.g. below request does not return the expected result.
https://contoso.sharepoint.com/sites/spdemo/_api/Web/UserCustomActions?$filter=ClientSideComponentId eq '27799883f5-7962-4384-a10a-105adaec6ffc'

Please correct, if I misunderstood the spec.

[martinlingstuyl]

Hi @nanddeepn, because the value is a guid, you need to compare with a guid value. Try prefixing the word 'guid':

https://contoso.sharepoint.com/sites/spdemo/_api/Web/UserCustomActions?$filter=ClientSideComponentId eq guid'27799883f5-7962-4384-a10a-105adaec6ffc'

[nanddeepn]

Thanks @martinlingstuyl
Oops! My bad. Missing the guid part. Thanks for correcting 😊

[martinlingstuyl]

It's easy to miss :)