MDM_WindowsLicensing class

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The MDM_WindowsLicensing class is designed for licensing related management scenarios. Currently the scope is limited to edition upgrades of Windows 10 desktop and mobile devices, such as Windows 10 Pro to Windows 10 Enterprise. In addition, this CSP provides the capability to activate or change the product key of Windows 10 desktop devices.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[InPartition("local-system"), dynamic, provider("DMWmiBridgeProv")]
class MDM_WindowsLicensing
{
  string InstanceID;
  string ParentID;
  sint32 Edition;
  sint32 Status;
  string LicenseKeyType;
};

Members

The MDM_WindowsLicensing class has these types of members:

Methods

The MDM_WindowsLicensing class has these methods.

Method Description
ChangeProductKeyMethod Installs a product key for Windows 10 desktop devices. Does not reboot.
CheckApplicabilityMethod Method to check if the entered product key can be used for an edition upgrade, activation or changing a product key of Windows 10 for desktop devices.
UpgradeEditionWithLicenseMethod Provide a license for an edition upgrade of Windows 10 mobile devices.
Note: This upgrade process does not require a system restart.
The date type is XML.
The supported operation is Execute.
Important:
The XML license file contents must be properly escaped (that is, it should not simply be a copied XML), otherwise the edition upgrade on Windows 10 mobile devices will fail. For more information on proper escaping of the XML license file, see Section 2.4 of the W3C XML spec. The XML license file is acquired from the Microsoft Volume Licensing Service Center. Your organization must have a Volume Licensing contract with Microsoft to access the portal.
The following are valid edition upgrade paths when using this node through an MDM or provisioning package:
- Windows 10 Mobileto Windows 10 Mobile Enterprise
UpgradeEditionWithProductKeyMethod Triggers the device to take the product key and upgrade the edition of the client.
[!Note]
This upgrade process requires a system restart.


The supported operation is Execute.
When a product key is pushed from an MDM server to a user's device, changepk.exe runs using the product key. After it completes, a notification is shown to the user that a new edition of Windows 10 is available. The user can then restart their system manually or, after two hours, the device will restart automatically to complete the upgrade. The user will receive a reminder notification 10 minutes before the automatic restart.
After the device restarts, the edition upgrade process completes. The user will receive a notification of the successful upgrade.
[!Important]
If another policy requires a system reboot that occurs when changepk.exe is running, the edition upgrade will fail.


If a product key is entered in a provisioning package and the user begins installation of the package, a notification is shown to the user that their system will restart to complete the package installation. Upon explicit consent from the user to proceed, the package continues installation and changepk.exe runs using the product key. The user will receive a reminder notification 30 seconds before the automatic restart.
After the device restarts, the edition upgrade process completes. The user will receive a notification of the successful upgrade.
This node can also be used to activate or change a product key on a particular edition of Windows 10 desktop device by entering a product key. Activation or changing a product key does not require a reboot and is a silent process for the user.
[!Important]
The product key entered must be 29 characters (that is, it should include dashes), otherwise the activation, edition upgrade, or product key change on Windows 10 desktop devices will fail. The product key is acquired from Microsoft Volume Licensing Service Center. Your organization must have a Volume Licensing contract with Microsoft to access the portal.

The following are valid edition upgrade paths when using this node through an MDM:
  • Windows 10 Enterprise to Windows 10 Education
  • Windows 10 Home to Windows 10 Education
  • Windows 10 Pro to Windows 10 Education
  • Windows 10 Pro to Windows 10 Enterprise

Activation or changing a product key can be carried out on the following editions:
  • Windows 10 Education
  • Windows 10 Enterprise
  • Windows 10 Home
  • Windows 10 Pro

Properties

The MDM_WindowsLicensing class has these properties.

Edition

Data type: sint32

Access type: Read/write

InstanceID

Data type: string

Access type: Read-only

Qualifiers: key

Identifies the name of the parent node.

LicenseKeyType

Data type: string

Access type: Read/write

ParentID

Data type: string

Access type: Read-only

Qualifiers: key

Describes the full path to the parent node. For this class, the string is "./Vendor/MSFT/"

Status

Data type: sint32

Access type: Read/write

Requirements

Requirement Value
Minimum supported client
Windows 10 [desktop apps only]
Minimum supported server
None supported
Namespace
Root\CIMv2\MDM\DMMap
MOF
DMWmiBridgeProv.mof
DLL
DMWmiBridgeProv.dll

See also

Using PowerShell scripting with the WMI Bridge Provider