Bug Report: BackgroundImageUrl PropertyBagEntry Not Working in PnP Provisioning

[nirav-raval]

I'm trying to set a custom header background image for a SharePoint site using the PnP provisioning template by adding a PropertyBagEntry with the key BackgroundImageUrl. However, after provisioning, the image is not being applied or used by the site as expected.

PnP Template Snippet Used:

<pnp:PropertyBagEntries>
  <pnp:PropertyBagEntry Key="BackgroundImageUrl" Value="/sites/branding/SiteAssets/bg.jpg" Overwrite="true" />
</pnp:PropertyBagEntries>

Notes

• Image URL is accessible and tested
• tested on multiple tenants
• Behavior is the same across all communication sites
• No visual change is observed on the site after provisioning
• Used invoke-PnPSiteTemplate -Path '' to apply template

Environment Info

• PnP PowerShell : 3.1.0
• Applied on: Communication site
• Used Windows 11 and used
• PowerShell version - 7.5.1

Related Context

There's an ongoing issue in the PnP PowerShell repo (#4959) regarding the Set-PnPWebHeader command, which could be related to or impact similar customization attempts.

Request

Please confirm:

• Is BackgroundImageUrl still a supported property for a provisioning?

• If not, what is the recommended approach to apply a custom background header using provisioning or scripting?

[vilmarci]

I can confirm this issue. Is there anyone working on it?

[nirav-raval]

@vilmarci - I think this is already been fixed in Pnp PowerShell nightly 3.1.64 or other latest one. Can you try that version? But there's no major release after 3.1.0 :(

[vilmarci]

@nirav-raval I am using the 3.1.230 nightly build. Reproduce is ismple, download the PropertyBagEntries handler, change the background image (upload a new image), then invoke the template. Nothing happens.

[nirav-raval]

@vilmarci can you please try v3.1.64 ? Someone already mentioned about it here

[vilmarci]

@nirav-raval version 3.1.64 is not available in the repository.
edit: Even though not listed, I could install the 3.1.64-nightly build. The issue with invoke-template is the same.
The Set-PnPWebHeader command returns with this error, and this error appears in the last nightly build too.

Trying to get a token for a different endpoint while being connected through an ACS token is not possible. Please connect differently.