2023-05-25 11:32:49 -04:00

8.7 KiB

title, description, author, manager, ms.author, ms.date, ms.localizationpriority, ms.prod, ms.technology, ms.topic
title description author manager ms.author ms.date ms.localizationpriority ms.prod ms.technology ms.topic
Personalization CSP Learn more about the Personalization CSP. vinaypamnani-msft aaroncz vinpa 05/10/2023 medium windows-client itpro-manage reference

Personalization CSP

The Personalization CSP can set the lock screen and desktop background images. Setting these policies also prevents the user from changing the image. You can also use the Personalization settings in a provisioning package.

Important

Personalization CSP is supported in Windows Enterprise and Education SKUs. It works in Windows Professional only when SetEduPolicies in SharedPC CSP is set.

The following list shows the Personalization configuration service provider nodes:

DesktopImageStatus

Scope Editions Applicable OS
Device
User
Pro
Enterprise
Education
Windows SE
Windows 10, version 1709 [10.0.16299] and later
./Vendor/MSFT/Personalization/DesktopImageStatus

This represents the status of the DesktopImage. 1 - Successfully downloaded or copied. 2 - Download/Copy in progress. 3 - Download/Copy failed. 4 - Unknown file type. 5 - Unsupported Url scheme. 6 - Max retry failed.

Description framework properties:

Property name Property value
Format int
Access Type Get

DesktopImageUrl

Scope Editions Applicable OS
Device
User
Pro
Enterprise
Education
Windows SE
Windows 10, version 1709 [10.0.16299] and later
./Vendor/MSFT/Personalization/DesktopImageUrl

A http or https Url to a jpg, jpeg or png image that needs to be downloaded and used as the Desktop Image or a file Url to a local image on the file system that needs to be used as the Desktop Image.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

LockScreenImageStatus

Scope Editions Applicable OS
Device
User
Pro
Enterprise
Education
Windows SE
Windows 10, version 1709 [10.0.16299] and later
./Vendor/MSFT/Personalization/LockScreenImageStatus

This represents the status of the LockScreenImage. 1 - Successfully downloaded or copied. 2 - Download/Copy in progress. 3 - Download/Copy failed. 4 - Unknown file type. 5 - Unsupported Url scheme. 6 - Max retry failed.

Description framework properties:

Property name Property value
Format int
Access Type Get

LockScreenImageUrl

Scope Editions Applicable OS
Device
User
Pro
Enterprise
Education
Windows SE
Windows 10, version 1709 [10.0.16299] and later
./Vendor/MSFT/Personalization/LockScreenImageUrl

A http or https Url to a jpg, jpeg or png image that neeeds to be downloaded and used as the Lock Screen Image or a file Url to a local image on the file system that needs to be used as the Lock Screen Image.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

Example

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
    <Replace>
      <CmdID>1</CmdID>
      <Item>
        <Target>
          <LocURI>
            ./Vendor/MSFT/Personalization/LockScreenImageUrl
          </LocURI>
        </Target>
        <Meta>
          <Format xmlns="syncml:metinf">chr</Format>
          <Type>text/plain</Type>
        </Meta>
        <Data>https://www.contoso.com/desktopimage.jpeg</Data>
      </Item>
    </Replace>
    <Replace>
      <CmdID>2</CmdID>
      <Item>
        <Target>
          <LocURI>
            ./Vendor/MSFT/Personalization/DesktopImageUrl
          </LocURI>
        </Target>
        <Meta>
          <Format xmlns="syncml:metinf">chr</Format>
          <Type>text/plain</Type>
        </Meta>
        <Data>https://www.contoso.com/lockscreenimage.JPG</Data>
      </Item>
    </Replace>
    <Final/>
  </SyncBody>
</SyncML>

Configuration service provider reference