deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 05:17:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

LanguagePackManagement CSP

Browse Source
This commit is contained in:
Vinay Pamnani 2023-02-17 17:53:13 -05:00
parent 86872f94fc
commit 5c0cc3476f
3 changed files with 960 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

600
windows/client-management/mdm/Language-pack-management-csp.md
View File

@ -1,30 +1,582 @@
---
title: Language Pack Management CSP
description: Language Pack Management CSP allows a direct way to provision language packs remotely in Windows 10.
ms.reviewer:
title: LanguagePackManagement CSP
description: Learn more about the LanguagePackManagement CSP.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.topic: article
ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
author: vinaypamnani-msft
ms.date: 06/22/2021
ms.topic: reference
---
# Language Pack Management CSP
<!-- Auto-Generated CSP Document -->
The table below shows the applicability of Windows:
<!-- LanguagePackManagement-Begin -->
# LanguagePackManagement CSP
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|Yes|Yes|
|Business|No|No|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
> [!IMPORTANT]
> This CSP contains preview policies that are under development and only applicable for [Windows Insider Preview builds](/windows-insider/). These policies are subject to change and may have dependencies on other features or services in preview.
<!-- LanguagePackManagement-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The Language Pack Management CSP allows a way to easily add languages and related language features and manage settings like System Preferred UI Language, System Locale, Input method (Keyboard), Locale, Speech Recognizer, User Preferred Language List. This CSP can be accessed using the new [LanguagePackManagement](/powershell/module/languagepackmanagement) PowerShell module.
<!-- LanguagePackManagement-Editable-End -->
<!-- LanguagePackManagement-Tree-Begin -->
The following example shows the LanguagePackManagement configuration service provider in tree format.
```text
./Device/Vendor/MSFT/LanguagePackManagement
--- Install
------ {Language ID}
--------- CopyToDeviceInternationalSettings
--------- EnableLanguageFeatureInstallations
--------- ErrorCode
--------- StartInstallation
--------- Status
--- InstalledLanguages
------ {Language ID}
--------- LanguageFeatures
--------- Providers
--- LanguageSettings
------ SystemPreferredUILanguages
```
<!-- LanguagePackManagement-Tree-End -->
<!-- Device-Install-Begin -->
## Install
<!-- Device-Install-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 Insider Preview [99.9.9999] |
<!-- Device-Install-Applicability-End -->
<!-- Device-Install-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install
```
<!-- Device-Install-OmaUri-End -->
<!-- Device-Install-Description-Begin -->
<!-- Description-Source-DDF -->
Language to be installed or being installed.
<!-- Device-Install-Description-End -->
<!-- Device-Install-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-Editable-End -->
<!-- Device-Install-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-Install-DFProperties-End -->
<!-- Device-Install-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-Examples-End -->
<!-- Device-Install-End -->
<!-- Device-Install-{Language ID}-Begin -->
### Install/{Language ID}
<!-- Device-Install-{Language ID}-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-Applicability-End -->
<!-- Device-Install-{Language ID}-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}
```
<!-- Device-Install-{Language ID}-OmaUri-End -->
<!-- Device-Install-{Language ID}-Description-Begin -->
<!-- Description-Source-DDF -->
Language tag of the language to be installed or being installed.
<!-- Device-Install-{Language ID}-Description-End -->
<!-- Device-Install-{Language ID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-Editable-End -->
<!-- Device-Install-{Language ID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | UniqueName: Language tag of the language to be installed or being installed. |
<!-- Device-Install-{Language ID}-DFProperties-End -->
<!-- Device-Install-{Language ID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-Examples-End -->
<!-- Device-Install-{Language ID}-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Begin -->
#### Install/{Language ID}/CopyToDeviceInternationalSettings
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Applicability-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}/CopyToDeviceInternationalSettings
```
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-OmaUri-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Description-Begin -->
<!-- Description-Source-DDF -->
Copies the language to the international settings (i.e., locale, input layout, speech recognizer, preferred UI language) of the device immediately after installation if the value is true. Default value is false.
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Description-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Editable-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | bool |
| Access Type | Add, Delete, Get, Replace |
| Default Value | false |
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-DFProperties-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| false (Default) | Don't copy the language to the international settings immediately after installation. |
| true | Copy the language to the international settings immediately after installation. |
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-AllowedValues-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-Examples-End -->
<!-- Device-Install-{Language ID}-CopyToDeviceInternationalSettings-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Begin -->
#### Install/{Language ID}/EnableLanguageFeatureInstallations
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Applicability-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}/EnableLanguageFeatureInstallations
```
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-OmaUri-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Description-Begin -->
<!-- Description-Source-DDF -->
Enables installations of all available language features when the value is true. Default value is true.
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Description-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Editable-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | bool |
| Access Type | Add, Delete, Get, Replace |
| Default Value | true |
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-DFProperties-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| true (Default) | Install all available language features. |
| false | Install only the required language features. |
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-AllowedValues-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-Examples-End -->
<!-- Device-Install-{Language ID}-EnableLanguageFeatureInstallations-End -->
<!-- Device-Install-{Language ID}-ErrorCode-Begin -->
#### Install/{Language ID}/ErrorCode
<!-- Device-Install-{Language ID}-ErrorCode-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-ErrorCode-Applicability-End -->
<!-- Device-Install-{Language ID}-ErrorCode-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}/ErrorCode
```
<!-- Device-Install-{Language ID}-ErrorCode-OmaUri-End -->
<!-- Device-Install-{Language ID}-ErrorCode-Description-Begin -->
<!-- Description-Source-DDF -->
Error code of queued language installation. 0 if there is no error.
<!-- Device-Install-{Language ID}-ErrorCode-Description-End -->
<!-- Device-Install-{Language ID}-ErrorCode-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-ErrorCode-Editable-End -->
<!-- Device-Install-{Language ID}-ErrorCode-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get |
<!-- Device-Install-{Language ID}-ErrorCode-DFProperties-End -->
<!-- Device-Install-{Language ID}-ErrorCode-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-ErrorCode-Examples-End -->
<!-- Device-Install-{Language ID}-ErrorCode-End -->
<!-- Device-Install-{Language ID}-StartInstallation-Begin -->
#### Install/{Language ID}/StartInstallation
<!-- Device-Install-{Language ID}-StartInstallation-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-StartInstallation-Applicability-End -->
<!-- Device-Install-{Language ID}-StartInstallation-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}/StartInstallation
```
<!-- Device-Install-{Language ID}-StartInstallation-OmaUri-End -->
<!-- Device-Install-{Language ID}-StartInstallation-Description-Begin -->
<!-- Description-Source-DDF -->
Execution node to queue a language for installation on the device.
<!-- Device-Install-{Language ID}-StartInstallation-Description-End -->
<!-- Device-Install-{Language ID}-StartInstallation-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-StartInstallation-Editable-End -->
<!-- Device-Install-{Language ID}-StartInstallation-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | null |
| Access Type | Exec |
<!-- Device-Install-{Language ID}-StartInstallation-DFProperties-End -->
<!-- Device-Install-{Language ID}-StartInstallation-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-StartInstallation-Examples-End -->
<!-- Device-Install-{Language ID}-StartInstallation-End -->
<!-- Device-Install-{Language ID}-Status-Begin -->
#### Install/{Language ID}/Status
<!-- Device-Install-{Language ID}-Status-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 Insider Preview [99.9.9999] |
<!-- Device-Install-{Language ID}-Status-Applicability-End -->
<!-- Device-Install-{Language ID}-Status-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/Install/{Language ID}/Status
```
<!-- Device-Install-{Language ID}-Status-OmaUri-End -->
<!-- Device-Install-{Language ID}-Status-Description-Begin -->
<!-- Description-Source-DDF -->
Status of the language queued for install. 0 - not started; 1 - in progress; 2 - succeeded; 3 - failed; 4 - partially succeeded.
<!-- Device-Install-{Language ID}-Status-Description-End -->
<!-- Device-Install-{Language ID}-Status-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-Status-Editable-End -->
<!-- Device-Install-{Language ID}-Status-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get |
<!-- Device-Install-{Language ID}-Status-DFProperties-End -->
<!-- Device-Install-{Language ID}-Status-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Install-{Language ID}-Status-Examples-End -->
<!-- Device-Install-{Language ID}-Status-End -->
<!-- Device-InstalledLanguages-Begin -->
## InstalledLanguages
<!-- Device-InstalledLanguages-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 Insider Preview [99.9.9999] |
<!-- Device-InstalledLanguages-Applicability-End -->
<!-- Device-InstalledLanguages-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/InstalledLanguages
```
<!-- Device-InstalledLanguages-OmaUri-End -->
<!-- Device-InstalledLanguages-Description-Begin -->
<!-- Description-Source-DDF -->
Languages currently installed on the device.
<!-- Device-InstalledLanguages-Description-End -->
<!-- Device-InstalledLanguages-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-Editable-End -->
<!-- Device-InstalledLanguages-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-InstalledLanguages-DFProperties-End -->
<!-- Device-InstalledLanguages-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-Examples-End -->
<!-- Device-InstalledLanguages-End -->
<!-- Device-InstalledLanguages-{Language ID}-Begin -->
### InstalledLanguages/{Language ID}
<!-- Device-InstalledLanguages-{Language ID}-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 Insider Preview [99.9.9999] |
<!-- Device-InstalledLanguages-{Language ID}-Applicability-End -->
<!-- Device-InstalledLanguages-{Language ID}-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/InstalledLanguages/{Language ID}
```
<!-- Device-InstalledLanguages-{Language ID}-OmaUri-End -->
<!-- Device-InstalledLanguages-{Language ID}-Description-Begin -->
<!-- Description-Source-DDF -->
Language tag of an installed language on the device. Delete to uninstall.
<!-- Device-InstalledLanguages-{Language ID}-Description-End -->
<!-- Device-InstalledLanguages-{Language ID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-Editable-End -->
<!-- Device-InstalledLanguages-{Language ID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Delete, Get |
| Dynamic Node Naming | ClientInventory |
<!-- Device-InstalledLanguages-{Language ID}-DFProperties-End -->
<!-- Device-InstalledLanguages-{Language ID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-Examples-End -->
<!-- Device-InstalledLanguages-{Language ID}-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Begin -->
#### InstalledLanguages/{Language ID}/LanguageFeatures
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-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 Insider Preview [99.9.9999] |
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Applicability-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/InstalledLanguages/{Language ID}/LanguageFeatures
```
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-OmaUri-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Description-Begin -->
<!-- Description-Source-DDF -->
Numeric representation of the language features installed. Basic Typing - 1 (0x1), Fonts - 2 (0x2), Handwriting - 4 (0x4), Speech - 8 (0x8), TextToSpeech - 16 (0x10), OCR - 32 (0x20), LocaleData - 64 (0x40), SupplementFonts - 128 (0x80).
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Description-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Editable-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get |
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-DFProperties-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-Examples-End -->
<!-- Device-InstalledLanguages-{Language ID}-LanguageFeatures-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Begin -->
#### InstalledLanguages/{Language ID}/Providers
<!-- Device-InstalledLanguages-{Language ID}-Providers-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 Insider Preview [99.9.9999] |
<!-- Device-InstalledLanguages-{Language ID}-Providers-Applicability-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/InstalledLanguages/{Language ID}/Providers
```
<!-- Device-InstalledLanguages-{Language ID}-Providers-OmaUri-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Description-Begin -->
<!-- Description-Source-DDF -->
Numeric representation of how a language is installed. 1 - The system language pack is installed; 2 - The Local Experience Pack is installed; 3 - Both are installed.
<!-- Device-InstalledLanguages-{Language ID}-Providers-Description-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Editable-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | int |
| Access Type | Get |
<!-- Device-InstalledLanguages-{Language ID}-Providers-DFProperties-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-Examples-End -->
<!-- Device-InstalledLanguages-{Language ID}-Providers-End -->
<!-- Device-LanguageSettings-Begin -->
## LanguageSettings
<!-- Device-LanguageSettings-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 Insider Preview [99.9.9999] |
<!-- Device-LanguageSettings-Applicability-End -->
<!-- Device-LanguageSettings-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/LanguageSettings
```
<!-- Device-LanguageSettings-OmaUri-End -->
<!-- Device-LanguageSettings-Description-Begin -->
<!-- Description-Source-DDF -->
Language settings of the device.
<!-- Device-LanguageSettings-Description-End -->
<!-- Device-LanguageSettings-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-LanguageSettings-Editable-End -->
<!-- Device-LanguageSettings-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-LanguageSettings-DFProperties-End -->
<!-- Device-LanguageSettings-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-LanguageSettings-Examples-End -->
<!-- Device-LanguageSettings-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Begin -->
### LanguageSettings/SystemPreferredUILanguages
<!-- Device-LanguageSettings-SystemPreferredUILanguages-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 Insider Preview [99.9.9999] |
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Applicability-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/LanguagePackManagement/LanguageSettings/SystemPreferredUILanguages
```
<!-- Device-LanguageSettings-SystemPreferredUILanguages-OmaUri-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Description-Begin -->
<!-- Description-Source-DDF -->
System Preferred UI Language of the device.
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Description-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Editable-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Get, Replace |
<!-- Device-LanguageSettings-SystemPreferredUILanguages-DFProperties-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-Examples-End -->
<!-- Device-LanguageSettings-SystemPreferredUILanguages-End -->
<!-- LanguagePackManagement-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
## Examples
1. Enumerate installed languages and features with GET command on the "InstalledLanguages" node. Below are the samples:
@ -60,10 +612,10 @@ The Language Pack Management CSP allows a way to easily add languages and relate
- System Preferred UI Language
- System Locale
- Default settings for new users
- Input Method (keyboard)
- Locale
- Speech Recognizer
- User Preferred Language List
- Input Method (keyboard)
- Locale
- Speech Recognizer
- User Preferred Language List
- Admins can optionally configure whether they want to install all available language features during installation using the REPLACE command on the "EnableLanguageFeatureInstallations" node of the language. false- will install only required features; true (default)- will install all available features.
Here are the sample commands to install French language with required features and copy to the device's international settings:
@ -79,7 +631,6 @@ The Language Pack Management CSP allows a way to easily add languages and relate
**GET./Device/Vendor/MSFT/LanguagePackManagement/Install/fr-FR/ErrorCode**
Status: 0 – not started; 1 – in progress; 2 – succeeded; 3 – failed; 4 - partial success (A partial success indicates not all the provisioning operations succeeded, for example, there was an error installing the language pack or features).
ErrorCode: An HRESULT that could help diagnosis if the installation failed or partially failed.
3. Delete installed Language with the DELETE command on the installed language tag. The delete command is a fire and forget operation. The deletion will run in background. IT admin can query the installed language later and resend the command if needed. Below is a sample command to delete the zh-CN language.
@ -92,7 +643,10 @@ The Language Pack Management CSP allows a way to easily add languages and relate
4. Get/Set System Preferred UI Language with GET or REPLACE command on the "SystemPreferredUILanguages" Node
**./Device/Vendor/MSFT/LanguagePackManagement/LanguageSettings/SystemPreferredUILanguages**
<!-- LanguagePackManagement-CspMoreInfo-End -->
## Related topics
<!-- LanguagePackManagement-End -->
[Configuration service provider reference](index.yml)
## Related articles
[Configuration service provider reference](configuration-service-provider-reference.md)

378
windows/client-management/mdm/language-pack-management-ddf-file.md Normal file
View File

@ -0,0 +1,378 @@
---
title: LanguagePackManagement DDF file
description: View the XML file containing the device description framework (DDF) for the LanguagePackManagement configuration service provider.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
ms.topic: reference
---
<!-- Auto-Generated CSP Document -->
# LanguagePackManagement DDF file
The following XML file contains the device description framework (DDF) for the LanguagePackManagement configuration service provider.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!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"?>]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD>
<MSFT:Diagnostics>
</MSFT:Diagnostics>
<Node>
<NodeName>LanguagePackManagement</NodeName>
<Path>./Device/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
</AccessType>
<Description>CSP for managing language packs and language settings.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>99.9.9999</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.0</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;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>
</MSFT:Applicability>
</DFProperties>
<Node>
<NodeName>InstalledLanguages</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Languages currently installed on the device.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>
</NodeName>
<DFProperties>
<AccessType>
<Delete />
<Get />
</AccessType>
<Description>Language tag of an installed language on the device. Delete to uninstall.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<OneOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>Language ID</DFTitle>
<DFType>
<DDFName />
</DFType>
<MSFT:DynamicNodeNaming>
<MSFT:ClientInventory />
</MSFT:DynamicNodeNaming>
</DFProperties>
<Node>
<NodeName>Providers</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Numeric representation of how a language is installed. 1 - The system language pack is installed; 2 - The Local Experience Pack is installed; 3 - Both are installed.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>LanguageFeatures</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Numeric representation of the language features installed. Basic Typing - 1 (0x1), Fonts - 2 (0x2), Handwriting - 4 (0x4), Speech - 8 (0x8), TextToSpeech - 16 (0x10), OCR - 32 (0x20), LocaleData - 64 (0x40), SupplementFonts - 128 (0x80).</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
</Node>
</Node>
<Node>
<NodeName>Install</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Language to be installed or being installed.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>
</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
</AccessType>
<Description>Language tag of the language to be installed or being installed.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<ZeroOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>Language ID</DFTitle>
<DFType>
<DDFName />
</DFType>
<MSFT:DynamicNodeNaming>
<MSFT:UniqueName>Language tag of the language to be installed or being installed.</MSFT:UniqueName>
</MSFT:DynamicNodeNaming>
</DFProperties>
<Node>
<NodeName>Status</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Status of the language queued for install. 0 – not started; 1 – in progress; 2 – succeeded; 3 – failed; 4 – partially succeeded.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>ErrorCode</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Error code of queued language installation. 0 if there is no error.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>CopyToDeviceInternationalSettings</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>false</DefaultValue>
<Description>Copies the language to the international settings (i.e., locale, input layout, speech recognizer, preferred UI language) of the device immediately after installation if the value is true. Default value is false.</Description>
<DFFormat>
<bool />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>false</MSFT:Value>
<MSFT:ValueDescription>Don't copy the language to the international settings immediately after installation.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>true</MSFT:Value>
<MSFT:ValueDescription>Copy the language to the international settings immediately after installation.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>EnableLanguageFeatureInstallations</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>true</DefaultValue>
<Description>Enables installations of all available language features when the value is true. Default value is true.</Description>
<DFFormat>
<bool />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>true</MSFT:Value>
<MSFT:ValueDescription>Install all available language features.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>false</MSFT:Value>
<MSFT:ValueDescription>Install only the required language features.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>StartInstallation</NodeName>
<DFProperties>
<AccessType>
<Exec />
</AccessType>
<Description>Execution node to queue a language for installation on the device.</Description>
<DFFormat>
<null />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
</Node>
</Node>
<Node>
<NodeName>LanguageSettings</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Language settings of the device.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>SystemPreferredUILanguages</NodeName>
<DFProperties>
<AccessType>
<Get />
<Replace />
</AccessType>
<Description>System Preferred UI Language of the device.</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node>
</Node>
</MgmtTree>
```
## Related articles
[LanguagePackManagement configuration service provider reference](language-pack-management-csp.md)

5
windows/client-management/mdm/toc.yml
View File

@ -762,6 +762,11 @@ items:
items:
- name: HealthAttestation DDF
href: healthattestation-ddf.md
- name: LanguagePackManagement
href: language-pack-management-csp.md
items:
- name: LanguagePackManagement DDF file
href: language-pack-management-ddf-file.md
- name: Local Administrator Password Solution
href: laps-csp.md
items: