From cf0fa95b2d23777ef0e69708ebe699e9467ce8a3 Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Fri, 17 Feb 2023 14:05:52 -0500 Subject: [PATCH] DeviceManageability CSP --- .../mdm/devicemanageability-csp.md | 335 +++++++++++++++--- .../mdm/devicemanageability-ddf.md | 334 +++++++++-------- windows/client-management/mdm/toc.yml | 4 +- 3 files changed, 477 insertions(+), 196 deletions(-) diff --git a/windows/client-management/mdm/devicemanageability-csp.md b/windows/client-management/mdm/devicemanageability-csp.md index ba8c8543ab..c7d550cafa 100644 --- a/windows/client-management/mdm/devicemanageability-csp.md +++ b/windows/client-management/mdm/devicemanageability-csp.md @@ -1,81 +1,322 @@ --- title: DeviceManageability CSP -description: Learn how the DeviceManageability configuration service provider (CSP) is used to retrieve general information about MDM configuration capabilities on the device. -ms.reviewer: +description: Learn more about the DeviceManageability 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: 11/01/2017 +ms.topic: reference --- + + + # DeviceManageability CSP -The table below shows the applicability of Windows: + + +The DeviceManageability configuration service provider (CSP) is used to retrieve the general information about MDM configuration capabilities on the device. This CSP was added in Windows 10, version 1607. -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|Yes|Yes| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| +For performance reasons, DeviceManageability CSP directly reads the CSP version from the registry. Specifically, the value `csp_version` is used to determine each of the CSP versions. The `csp_version` is a value under each of the CSP registration keys. To have consistency on the CSP version, the CSP GetProperty implementation for `CFGMGR_PROPERTY_SEMANTICTYPE` has to be updated to read from the registry as well, so that both the paths return the same information. + -The DeviceManageability configuration service provider (CSP) is used to retrieve the general information about MDM configuration capabilities on the device. This CSP was added in Windows 10, version 1607. + +The following example shows the DeviceManageability configuration service provider in tree format. -For performance reasons, DeviceManageability CSP directly reads the CSP version from the registry. Specifically, the value csp\_version is used to determine each of the CSP versions. The csp\_version is a value under each of the CSP registration keys. To have consistency on the CSP version, the CSP GetProperty implementation for CFGMGR\_PROPERTY\_SEMANTICTYPE has to be updated to read from the registry as well, so that both the paths return the same information. - -The following example shows the DeviceManageability configuration service provider in a tree format. +```text +./Device/Vendor/MSFT/DeviceManageability +--- Capabilities +------ CSPVersions +--- Provider +------ {ProviderID} +--------- ConfigInfo +--------- EnrollmentInfo +--------- PayloadTransfer ``` -./Device/Vendor/MSFT -DeviceManageability -----Capabilities ---------CSPVersions -----Provider (Added in Windows 10, version 1709) ---------ProviderID (Added in Windows 10, version 1709) -------------ConfigInfo (Added in Windows 10, version 1709) -------------EnrollmentInfo (Added in Windows 10, version 1709) + + + +## Capabilities + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later | + + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Capabilities ``` + -**./Device/Vendor/MSFT/DeviceManageability** -Root node to group information about runtime MDM configuration capability on the target device. + + + -**Capabilities** -Interior node. + + + -**Capabilities/CSPVersions** -Returns the versions of all configuration service providers supported on the device for the MDM service. + +**Description framework properties**: -**Provider** -Added in Windows 10, version 1709. Interior node. +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + -**Provider/_ProviderID_** -Added in Windows 10, version 1709. Provider ID of the configuration source. ProviderID should be unique among the different config sources. + + + -**Provider/_ProviderID_/ConfigInfo** -Added in Windows 10, version 1709. Configuration information string value set by the configuration source. Recommended to use during sync session. + -ConfigInfo value can only be set by the provider that owns the ProviderID. The value is readable by other config sources. + +### Capabilities/CSPVersions -Data type is string. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1607 [10.0.14393] and later | + -Supported operations are Add, Get, Delete, and Replace. + +```Device +./Device/Vendor/MSFT/DeviceManageability/Capabilities/CSPVersions +``` + -**Provider/_ProviderID_/EnrollmentInfo** -Added in Windows 10, version 1709. Enrollment information string value set by the configuration source and sent during MDM enrollment. It's readable by MDM server during sync session. + + +Returns the versions of all configuration service providers (CSP) for MDM. + -Data type is string. + + + -Supported operations are Add, Get, Delete, and Replace.  + +**Description framework properties**: -## Related topics +| Property name | Property value | +|:--|:--| +| Format | xml | +| Access Type | Get | + -[Configuration service provider reference](index.yml) + + + + + +## Provider + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Provider +``` + + + + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + + + + + + + + + +### Provider/{ProviderID} + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Provider/{ProviderID} +``` + + + + +Provider ID String of the Configuration Source. + + + + +Provider ID should be unique among the different config sources. + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Add, Delete, Get | +| Dynamic Node Naming | UniqueName: Provider ID String of the Configuration Source | + + + + + + + + + +#### Provider/{ProviderID}/ConfigInfo + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Provider/{ProviderID}/ConfigInfo +``` + + + + +Configuration Info string value set by the config source. Recommended to be used during sync session. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +#### Provider/{ProviderID}/EnrollmentInfo + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Provider/{ProviderID}/EnrollmentInfo +``` + + + + +Enrollment Info string value set by the config source. Recommended to sent to server during MDM enrollment. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + +#### Provider/{ProviderID}/PayloadTransfer + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 2009 [10.0.19042.2193] and later
:heavy_check_mark: Windows 10, version 21H1 [10.0.19043.2193] and later
:heavy_check_mark: Windows 10, version 21H2 [10.0.19044.2193] and later
:heavy_check_mark: Windows 11, version 21H2 [10.0.22000.918] and later
:heavy_check_mark: Windows 11, version 22H2 [10.0.22621] and later | + + + +```Device +./Device/Vendor/MSFT/DeviceManageability/Provider/{ProviderID}/PayloadTransfer +``` + + + + +Payload Transfer string value set by the config source. Recommended to be used during sync session. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + + + + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/devicemanageability-ddf.md b/windows/client-management/mdm/devicemanageability-ddf.md index 8854d21cfc..3436c3b0bb 100644 --- a/windows/client-management/mdm/devicemanageability-ddf.md +++ b/windows/client-management/mdm/devicemanageability-ddf.md @@ -1,41 +1,85 @@ --- -title: DeviceManageability DDF -description: This topic shows the OMA DM device description framework (DDF) for the DeviceManageability configuration service provider. This CSP was added in Windows 10, version 1607. -ms.reviewer: +title: DeviceManageability DDF file +description: View the XML file containing the device description framework (DDF) for the DeviceManageability configuration service provider. +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: 12/05/2017 +ms.topic: reference --- -# DeviceManageability DDF + +# DeviceManageability DDF file -This topic shows the OMA DM device description framework (DDF) for the DeviceManageability configuration service provider. This CSP was added in Windows 10, version 1607. - -Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md). - -The XML below is for Windows 10, version 1709. +The following XML file contains the device description framework (DDF) for the DeviceManageability configuration service provider. ```xml -]> +]> 1.2 + + + + DeviceManageability + ./Device/Vendor/MSFT + + + + + + + Root node to group information about runtime MDM configuration capability on the target device. + + + + + + + + + + + + + + 10.0.14393 + 1.0 + 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; + + + + Capabilities + + + + + + + + + + + + + + + + + - DeviceManageability - ./Device/Vendor/MSFT + CSPVersions + Returns the versions of all configuration service providers (CSP) for MDM. - + @@ -44,60 +88,74 @@ The XML below is for Windows 10, version 1709. - com.microsoft/1.1/MDM/DeviceManageability + + + + + Provider + + + + + + + + + + + + + + Provider + + + + + 10.0.17134 + 1.1 + + + + + + + + + + + + Provider ID String of the Configuration Source + + + + + + + + + + ProviderID + + + + + Provider ID String of the Configuration Source + + - Capabilities + ConfigInfo - - - - - - - - - - - - - - - - - CSPVersions - - - - - Returns the versions of all configuration service providers (CSP) for MDM. - - - - - - - - - - - text/plain - - - - - - Provider - - - + + + Configuration Info string value set by the config source. Recommended to be used during sync session. - + @@ -105,96 +163,78 @@ The XML below is for Windows 10, version 1709. - Provider + ConfigInfo - + + + + + + + PayloadTransfer + + + + + + + + Payload Transfer string value set by the config source. Recommended to be used during sync session. + + + + + + + + + + PayloadTransfer + + + + + 10.0.22621, 10.0.22000.918, 10.0.19044.2193, 10.0.19043.2193, 10.0.19042.2193 + 1.1 + + + + + + + EnrollmentInfo + + + + + + + + Enrollment Info string value set by the config source. Recommended to sent to server during MDM enrollment. + + + + + + + + + + EnrollmentInfo + + + + + - - - - - - - - - Provider ID String of the Configuration Source - - - - - - - - - - ProviderID - - - - - - ConfigInfo - - - - - - - - Configuration Info string value set by the config source. Recommended to be used during sync session. - - - - - - - - - - ConfigInfo - - text/plain - - - - - EnrollmentInfo - - - - - - - - Enrollment Info string value set by the config source. Recommended to sent to server during MDM enrollment. - - - - - - - - - - EnrollmentInfo - - text/plain - - - - + + ``` -  - -  - - - - - +## Related articles +[DeviceManageability configuration service provider reference](devicemanageability-csp.md) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index d35962adb6..d6bbeca59e 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -668,7 +668,7 @@ items: - name: DeviceManageability href: devicemanageability-csp.md items: - - name: DeviceManageability DDF + - name: DeviceManageability DDF file href: devicemanageability-ddf.md - name: DeviceStatus href: devicestatus-csp.md @@ -740,7 +740,7 @@ items: - name: EnterpriseModernAppManagement href: enterprisemodernappmanagement-csp.md items: - - name: EnterpriseModernAppManagement DDF + - name: EnterpriseModernAppManagement DDF file href: enterprisemodernappmanagement-ddf.md - name: EnterpriseModernAppManagement XSD href: enterprisemodernappmanagement-xsd.md