deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-06-19 12:23:37 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Personalization CSP

Browse Source
This commit is contained in:
Vinay Pamnani
2023-02-17 17:04:20 -05:00
parent e49b885226
commit 7caa82300c
2 changed files with 330 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

256
windows/client-management/mdm/personalization-csp.md
View File

@ -1,91 +1,213 @@
--- ---
title: Personalization CSP title: Personalization CSP
description: Use the Personalization CSP to lock screen and desktop background images, prevent users from changing the image, and use the settings in a provisioning package. description: Learn more about the Personalization CSP.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 06/28/2022
ms.reviewer:
manager: aaroncz
--- ---
<!-- Auto-Generated CSP Document -->
<!-- Personalization-Begin -->
# Personalization CSP # Personalization CSP
The table below shows the applicability of Windows: <!-- Personalization-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|No|No|
|Windows SE|No|Yes|
|Business|No|No|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
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. 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.
<!-- Personalization-Editable-End -->
This CSP was added in Windows 10, version 1703. <!-- Personalization-Tree-Begin -->
> [!Note]
> Personalization CSP is supported in Windows Enterprise and Education SKUs. It works in Windows Professional if SetEduPolicies in [SharedPC CSP](sharedpc-csp.md) is set.
The following example shows the Personalization configuration service provider in tree format. The following example shows the Personalization configuration service provider in tree format.
```text
./Vendor/MSFT/Personalization
--- DesktopImageStatus
--- DesktopImageUrl
--- LockScreenImageStatus
--- LockScreenImageUrl
``` ```
./Vendor/MSFT <!-- Personalization-Tree-End -->
Personalization
----DesktopImageUrl <!-- Device-DesktopImageStatus-Begin -->
----DesktopImageStatus ## DesktopImageStatus
----LockScreenImageUrl
----LockScreenImageStatus <!-- Device-DesktopImageStatus-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
<!-- Device-DesktopImageStatus-Applicability-End -->
<!-- Device-DesktopImageStatus-OmaUri-Begin -->
```Device
./Vendor/MSFT/Personalization/DesktopImageStatus
``` ```
<a href="" id="personalization"></a>**./Vendor/MSFT/Personalization** <!-- Device-DesktopImageStatus-OmaUri-End -->
<p>Defines the root node for the Personalization configuration service provider.</p>
<a href="" id="desktopimageurl"></a>**DesktopImageUrl** <!-- Device-DesktopImageStatus-Description-Begin -->
<p>Specify a jpg, jpeg or png image to be used as Desktop Image. This setting can take an http or https Url to a remote image to be downloaded, a file Url to a local image.</p> <!-- Description-Source-DDF -->
<p>Value type is string. Supported operations are Add, Get, Delete, and Replace.</p> This represents the status of the DesktopImage.
<a href="" id="desktopimagestatus"></a>**DesktopImageStatus** 1 - Successfully downloaded or copied.
<p>Represents the status of the desktop image. Valid values:</p> 2 - Download/Copy in progress.
<ul> 3 - Download/Copy failed.
<li>1 - Successfully downloaded or copied.</li> 4 - Unknown file type.
<li>2 - Download or copy in progress.</li> 5 - Unsupported Url scheme.
<li>3 - Download or copy failed.</li> 6 - Max retry failed.
<li>4 - Unknown file type.</li>
<li>5 - Unsupported URL scheme.</li>
<li>6 - Max retry failed.</li>
<li>7 - Blocked, SKU not allowed</li>
</ul>
<p>Supporter operation is Get.</p>
> [!Note] <!-- Device-DesktopImageStatus-Description-End -->
> This setting is only used to query status. To set the image, use the DesktopImageUrl setting.
<a href="" id="lockscreenimageurl"></a>**LockScreenImageUrl** <!-- Device-DesktopImageStatus-Editable-Begin -->
<p>Specify a jpg, jpeg or png image to be used as Lock Screen Image. This setting can take an http or https Url to a remote image to be downloaded, a file Url to a local image.</p> <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<p>Value type is string. Supported operations are Add, Get, Delete, and Replace.</p> <!-- Device-DesktopImageStatus-Editable-End -->
<!-- Device-DesktopImageStatus-DFProperties-Begin -->
**Description framework properties**:
<a href="" id="lockscreenimagestatus"></a>**LockScreenImageStatus** | Property name | Property value |
<p>Represents the status of the lock screen image. Valid values:</p> |:--|:--|
<ul> | Format | int |
<li>1 - Successfully downloaded or copied.</li> | Access Type | Get |
<li>2 - Download or copy in progress.</li> <!-- Device-DesktopImageStatus-DFProperties-End -->
<li>3 - Download or copy failed.</li>
<li>4 - Unknown file type.</li>
<li>5 - Unsupported URL scheme.</li>
<li>6 - Max retry failed.</li>
<li>7 - Blocked, SKU not allowed</li>
</ul>
<p>Supporter operation is Get.</p>
> [!Note] <!-- Device-DesktopImageStatus-Examples-Begin -->
> This setting is only used to query status. To set the image, use the LockScreenImageUrl setting. <!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-DesktopImageStatus-Examples-End -->
<!-- Device-DesktopImageStatus-End -->
## Example SyncML <!-- Device-DesktopImageUrl-Begin -->
## DesktopImageUrl
<!-- Device-DesktopImageUrl-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: 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 -->
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.
<!-- 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 |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: 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 |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: 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 -->
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.
<!-- 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 ```xml
<SyncML xmlns="SYNCML:SYNCML1.2"> <SyncML xmlns="SYNCML:SYNCML1.2">
@ -124,6 +246,10 @@ Personalization
</SyncBody> </SyncBody>
</SyncML> </SyncML>
``` ```
<!-- Personalization-CspMoreInfo-End -->
<!-- Personalization-End -->
## Related articles
[Configuration service provider reference](configuration-service-provider-reference.md)

265
windows/client-management/mdm/personalization-ddf.md
View File

@ -1,142 +1,155 @@
--- ---
title: Personalization DDF file title: Personalization DDF file
description: Learn how to set the OMA DM device description framework (DDF) for the Personalization configuration service provider (CSP). description: View the XML file containing the device description framework (DDF) for the Personalization configuration service provider.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 12/05/2017
ms.reviewer:
manager: aaroncz
--- ---
<!-- Auto-Generated CSP Document -->
# Personalization DDF file # Personalization DDF file
This topic shows the OMA DM device description framework (DDF) for the **Personalization** configuration service provider. The following XML file contains the device description framework (DDF) for the Personalization configuration service provider.
Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md).
The XML below is the current version for this CSP.
```xml ```xml
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" <!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"[<?oma-dm-ddf-ver supported-versions="1.2"?>]>
"http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"
[<?oma-dm-ddf-ver supported-versions="1.2"?>]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM"> <MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD> <VerDTD>1.2</VerDTD>
<Node> <MSFT:Diagnostics>
<NodeName>Personalization</NodeName> </MSFT:Diagnostics>
<Path>./Vendor/MSFT</Path> <Node>
<DFProperties> <NodeName>Personalization</NodeName>
<AccessType> <Path>./Vendor/MSFT</Path>
<Get /> <DFProperties>
</AccessType> <AccessType>
<Description>Configure a PC's personalization settings such as Desktop Image and Lock Screen Image.</Description> <Add />
<DFFormat> <Delete />
<node /> <Get />
</DFFormat> </AccessType>
<Occurrence> <Description>Configure a PC's personalization settings such as Desktop Image and Lock Screen Image.</Description>
<One /> <DFFormat>
</Occurrence> <node />
<Scope> </DFFormat>
<Permanent /> <Occurrence>
</Scope> <One />
<DFType> </Occurrence>
<MIME>com.microsoft/1.0/MDM/Personalization</MIME> <Scope>
</DFType> <Permanent />
</DFProperties> </Scope>
<Node> <DFType>
<NodeName>DesktopImageUrl</NodeName> <MIME />
<DFProperties> </DFType>
<AccessType> <MSFT:Applicability>
<Get /> <MSFT:OsBuildVersion>10.0.16299</MSFT:OsBuildVersion>
<Add /> <MSFT:CspVersion>1.0</MSFT:CspVersion>
<Delete /> <MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
<Replace /> </MSFT:Applicability>
</AccessType> </DFProperties>
<Description>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 used as the Desktop Image.</Description> <Node>
<DFFormat> <NodeName>DesktopImageUrl</NodeName>
<chr /> <DFProperties>
</DFFormat> <AccessType>
<Occurrence> <Add />
<One /> <Delete />
</Occurrence> <Get />
<Scope> <Replace />
<Dynamic /> </AccessType>
</Scope> <Description>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>
<DFType> <DFFormat>
<MIME>text/plain</MIME> <chr />
</DFType> </DFFormat>
</DFProperties> <Occurrence>
</Node> <One />
<Node> </Occurrence>
<NodeName>DesktopImageStatus</NodeName> <Scope>
<DFProperties> <Dynamic />
<AccessType> </Scope>
<Get /> <DFType>
</AccessType> <MIME />
<Description>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> </DFType>
<DFFormat> <MSFT:AllowedValues ValueType="None">
<int /> </MSFT:AllowedValues>
</DFFormat> </DFProperties>
<Occurrence> </Node>
<One /> <Node>
</Occurrence> <NodeName>DesktopImageStatus</NodeName>
<Scope> <DFProperties>
<Dynamic /> <AccessType>
</Scope> <Get />
<DFType> </AccessType>
<MIME>text/plain</MIME> <Description>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>
</DFType> <DFFormat>
</DFProperties> <int />
</Node> </DFFormat>
<Node> <Occurrence>
<NodeName>LockScreenImageUrl</NodeName> <One />
<DFProperties> </Occurrence>
<AccessType> <Scope>
<Get /> <Dynamic />
<Add /> </Scope>
<Delete /> <DFType>
<Replace /> <MIME />
</AccessType> </DFType>
<Description>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> </DFProperties>
<DFFormat> </Node>
<chr /> <Node>
</DFFormat> <NodeName>LockScreenImageUrl</NodeName>
<Occurrence> <DFProperties>
<One /> <AccessType>
</Occurrence> <Add />
<Scope> <Delete />
<Dynamic /> <Get />
</Scope> <Replace />
<DFType> </AccessType>
<MIME>text/plain</MIME> <Description>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>
</DFType> <DFFormat>
</DFProperties> <chr />
</Node> </DFFormat>
<Node> <Occurrence>
<NodeName>LockScreenImageStatus</NodeName> <One />
<DFProperties> </Occurrence>
<AccessType> <Scope>
<Get /> <Dynamic />
</AccessType> </Scope>
<Description>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> <DFType>
<DFFormat> <MIME />
<int /> </DFType>
</DFFormat> <MSFT:AllowedValues ValueType="None">
<Occurrence> </MSFT:AllowedValues>
<One /> </DFProperties>
</Occurrence> </Node>
<Scope> <Node>
<Dynamic /> <NodeName>LockScreenImageStatus</NodeName>
</Scope> <DFProperties>
<DFType> <AccessType>
<MIME>text/plain</MIME> <Get />
</DFType> </AccessType>
</DFProperties> <Description>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>
</Node> <DFFormat>
</Node> <int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
</Node>
</MgmtTree> </MgmtTree>
``` ```
## Related articles
[Personalization configuration service provider reference](personalization-csp.md)