Post
Ask Question

PnP PowerShell Commands for SPFx Extension Application Customizer

Introduction

 
This blog would help in adding, updating, deleting, fetching all the SPFx Extension application customizer using PnP PowerShell commands.
 
Prerequisite 
 
To install PnP PowerShell for the Current User, use the below command if you are using Windows 10 and SharePoint Online as SharePoint Environment. Open Windows PowerShell and run all the below commands.
  1. Install-Module SharePointPnPPowerShellOnline -Scope CurrentUser   
Connect to site
 
To connect to the SharePoint Online Site collection, use the below command:
  1. Connect-PnPOnline –Url https://yoursite.sharepoint.com  
Get

Get all the SPFx Extension application customizers present in the site collection
  1. Get-PnPApplicationCustomizer   
 
 
Add

Add an SPFx Extension application customizer
  1. Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId 87b7c035-6112-4ad2-b33a-f302211976e7 -ClientSideComponentProperties "{`"testMessage`":`"Test message`",`"Bottom`":`"ThisisforTesting`"}"   
Note
We can get ClientSideComponentId from the .manifest.json file as displayed in the screenshot below
 
 
 
Update
 
Updated the Properties of the SPFx application customizer. This is very helpful if we want to change the properties value
 
For example, if we create a footer for all the site collection in our tenant and we have a requirement of having different text in footer then we can run this command to update the value  
  1. Set-PnPApplicationCustomizer -ClientSideComponentId 87b7c035-6112-4ad2-b33a-f302211976e7 -Scope web -ClientSideComponentProperties "{`"testMessage`":`"Test message`",`"Bottom`":`"Thistextisupdated`"}"    
 
 
 
Remove
 
To remove the SPFx application customizers, use the below command:
  1. Remove-PnPApplicationCustomizer -ClientSideComponentId 87b7c035-6112-4ad2-b33a-f302211976e7 -Scope web