mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-12 05:17:22 +00:00
355 lines
14 KiB
Markdown
355 lines
14 KiB
Markdown
---
|
|
title: Personalization CSP
|
|
description: Learn more about the Personalization CSP.
|
|
ms.date: 08/06/2024
|
|
---
|
|
|
|
<!-- Auto-Generated CSP Document -->
|
|
|
|
<!-- Personalization-Begin -->
|
|
# Personalization CSP
|
|
|
|
<!-- Personalization-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
The Personalization CSP can set the lock screen, desktop background images and company branding on sign-in screen ([BootToCloud mode](policy-csp-clouddesktop.md#boottocloudmode) only). 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](sharedpc-csp.md) is set, or when the device is configured in [Shared PC mode with BootToCloudPCEnhanced policy](clouddesktop-csp.md#deviceboottocloudpcenhanced).
|
|
<!-- Personalization-Editable-End -->
|
|
|
|
<!-- Personalization-Tree-Begin -->
|
|
The following list shows the Personalization configuration service provider nodes:
|
|
|
|
- ./Vendor/MSFT/Personalization
|
|
- [CompanyLogoStatus](#companylogostatus)
|
|
- [CompanyLogoUrl](#companylogourl)
|
|
- [CompanyName](#companyname)
|
|
- [DesktopImageStatus](#desktopimagestatus)
|
|
- [DesktopImageUrl](#desktopimageurl)
|
|
- [LockScreenImageStatus](#lockscreenimagestatus)
|
|
- [LockScreenImageUrl](#lockscreenimageurl)
|
|
<!-- Personalization-Tree-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-Begin -->
|
|
## CompanyLogoStatus
|
|
|
|
<!-- Device-CompanyLogoStatus-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 22H2 with [KB5035942](https://support.microsoft.com/help/5035942) [10.0.22621.3374] and later |
|
|
<!-- Device-CompanyLogoStatus-Applicability-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/CompanyLogoStatus
|
|
```
|
|
<!-- Device-CompanyLogoStatus-OmaUri-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
This represents the status of the Company Logo. 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. This setting is currently available for boot to cloud shared pc mode only.
|
|
<!-- Device-CompanyLogoStatus-Description-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-CompanyLogoStatus-Editable-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `int` |
|
|
| Access Type | Get |
|
|
<!-- Device-CompanyLogoStatus-DFProperties-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-CompanyLogoStatus-Examples-End -->
|
|
|
|
<!-- Device-CompanyLogoStatus-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-Begin -->
|
|
## CompanyLogoUrl
|
|
|
|
<!-- Device-CompanyLogoUrl-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 22H2 with [KB5035942](https://support.microsoft.com/help/5035942) [10.0.22621.3374] and later |
|
|
<!-- Device-CompanyLogoUrl-Applicability-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/CompanyLogoUrl
|
|
```
|
|
<!-- Device-CompanyLogoUrl-OmaUri-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
An http or https Url to a jpg, jpeg or png image that needs to be downloaded and used as the Company Logo or a file Url to a local image on the file system that needs to be used as the Company Logo. This setting is currently available for boot to cloud shared pc mode only.
|
|
<!-- Device-CompanyLogoUrl-Description-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-CompanyLogoUrl-Editable-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `chr` (string) |
|
|
| Access Type | Add, Delete, Get, Replace |
|
|
<!-- Device-CompanyLogoUrl-DFProperties-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-CompanyLogoUrl-Examples-End -->
|
|
|
|
<!-- Device-CompanyLogoUrl-End -->
|
|
|
|
<!-- Device-CompanyName-Begin -->
|
|
## CompanyName
|
|
|
|
<!-- Device-CompanyName-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 11, version 22H2 with [KB5035942](https://support.microsoft.com/help/5035942) [10.0.22621.3374] and later |
|
|
<!-- Device-CompanyName-Applicability-End -->
|
|
|
|
<!-- Device-CompanyName-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/CompanyName
|
|
```
|
|
<!-- Device-CompanyName-OmaUri-End -->
|
|
|
|
<!-- Device-CompanyName-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
This represents the name of the company. It can be at most 30 characters long. This setting is currently available only for boot to cloud shared pc mode to display the company name on sign-in screen.
|
|
<!-- Device-CompanyName-Description-End -->
|
|
|
|
<!-- Device-CompanyName-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-CompanyName-Editable-End -->
|
|
|
|
<!-- Device-CompanyName-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `chr` (string) |
|
|
| Access Type | Add, Delete, Get, Replace |
|
|
| Allowed Values | Regular Expression: `^.{1,30}$` |
|
|
<!-- Device-CompanyName-DFProperties-End -->
|
|
|
|
<!-- Device-CompanyName-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-CompanyName-Examples-End -->
|
|
|
|
<!-- Device-CompanyName-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-Begin -->
|
|
## DesktopImageStatus
|
|
|
|
<!-- Device-DesktopImageStatus-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 10, version 1709 [10.0.16299] and later |
|
|
<!-- Device-DesktopImageStatus-Applicability-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/DesktopImageStatus
|
|
```
|
|
<!-- Device-DesktopImageStatus-OmaUri-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
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.
|
|
<!-- Device-DesktopImageStatus-Description-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-DesktopImageStatus-Editable-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `int` |
|
|
| Access Type | Get |
|
|
<!-- Device-DesktopImageStatus-DFProperties-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-DesktopImageStatus-Examples-End -->
|
|
|
|
<!-- Device-DesktopImageStatus-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-Begin -->
|
|
## DesktopImageUrl
|
|
|
|
<!-- Device-DesktopImageUrl-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 10, version 1709 [10.0.16299] and later |
|
|
<!-- Device-DesktopImageUrl-Applicability-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/DesktopImageUrl
|
|
```
|
|
<!-- Device-DesktopImageUrl-OmaUri-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
An 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.
|
|
<!-- Device-DesktopImageUrl-Description-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-DesktopImageUrl-Editable-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `chr` (string) |
|
|
| Access Type | Add, Delete, Get, Replace |
|
|
<!-- Device-DesktopImageUrl-DFProperties-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-DesktopImageUrl-Examples-End -->
|
|
|
|
<!-- Device-DesktopImageUrl-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-Begin -->
|
|
## LockScreenImageStatus
|
|
|
|
<!-- Device-LockScreenImageStatus-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 10, version 1709 [10.0.16299] and later |
|
|
<!-- Device-LockScreenImageStatus-Applicability-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/LockScreenImageStatus
|
|
```
|
|
<!-- Device-LockScreenImageStatus-OmaUri-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
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.
|
|
<!-- Device-LockScreenImageStatus-Description-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-LockScreenImageStatus-Editable-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `int` |
|
|
| Access Type | Get |
|
|
<!-- Device-LockScreenImageStatus-DFProperties-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-LockScreenImageStatus-Examples-End -->
|
|
|
|
<!-- Device-LockScreenImageStatus-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-Begin -->
|
|
## LockScreenImageUrl
|
|
|
|
<!-- Device-LockScreenImageUrl-Applicability-Begin -->
|
|
| Scope | Editions | Applicable OS |
|
|
|:--|:--|:--|
|
|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 10, version 1709 [10.0.16299] and later |
|
|
<!-- Device-LockScreenImageUrl-Applicability-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-OmaUri-Begin -->
|
|
```Device
|
|
./Vendor/MSFT/Personalization/LockScreenImageUrl
|
|
```
|
|
<!-- Device-LockScreenImageUrl-OmaUri-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-Description-Begin -->
|
|
<!-- Description-Source-DDF -->
|
|
An http or https Url to a jpg, jpeg or png image that needs 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.
|
|
<!-- Device-LockScreenImageUrl-Description-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-Editable-Begin -->
|
|
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
|
<!-- Device-LockScreenImageUrl-Editable-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-DFProperties-Begin -->
|
|
**Description framework properties**:
|
|
|
|
| Property name | Property value |
|
|
|:--|:--|
|
|
| Format | `chr` (string) |
|
|
| Access Type | Add, Delete, Get, Replace |
|
|
<!-- Device-LockScreenImageUrl-DFProperties-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-Examples-Begin -->
|
|
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
|
<!-- Device-LockScreenImageUrl-Examples-End -->
|
|
|
|
<!-- Device-LockScreenImageUrl-End -->
|
|
|
|
<!-- Personalization-CspMoreInfo-Begin -->
|
|
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
|
|
## Example
|
|
|
|
```xml
|
|
<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>
|
|
```
|
|
<!-- Personalization-CspMoreInfo-End -->
|
|
|
|
<!-- Personalization-End -->
|
|
|
|
## Related articles
|
|
|
|
[Configuration service provider reference](configuration-service-provider-reference.md)
|