From dc1278f6c39210c9d65500b9b868faaf38aa06ab Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Fri, 17 Feb 2023 14:07:36 -0500 Subject: [PATCH] DevicePreparation CSP --- .../mdm/devicepreparation-csp.md | 344 ++++++++++++++++++ .../mdm/devicepreparation-ddf-file.md | 252 +++++++++++++ windows/client-management/mdm/toc.yml | 7 +- 3 files changed, 601 insertions(+), 2 deletions(-) create mode 100644 windows/client-management/mdm/devicepreparation-csp.md create mode 100644 windows/client-management/mdm/devicepreparation-ddf-file.md diff --git a/windows/client-management/mdm/devicepreparation-csp.md b/windows/client-management/mdm/devicepreparation-csp.md new file mode 100644 index 0000000000..a528dae6cb --- /dev/null +++ b/windows/client-management/mdm/devicepreparation-csp.md @@ -0,0 +1,344 @@ +--- +title: DevicePreparation CSP +description: Learn more about the DevicePreparation CSP. +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 +--- + + + + +# DevicePreparation CSP + +> [!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. + + + + + + +The following example shows the DevicePreparation configuration service provider in tree format. + +```text +./Device/Vendor/MSFT/DevicePreparation +--- BootstrapperAgent +------ ClassID +------ ExecutionContext +------ InstallationStatusUri +--- PageEnabled +--- PageSettings +--- PageStatus +``` + + + +## BootstrapperAgent + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/BootstrapperAgent +``` + + + + +The subnodes configure settings for the Bootstrapper Agent. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | node | +| Access Type | Get | + + + + + + + + + +### BootstrapperAgent/ClassID + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/BootstrapperAgent/ClassID +``` + + + + +This node stores the class ID for the Bootstrapper Agent WinRT object. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get, Replace | + + + + + + + + + +### BootstrapperAgent/ExecutionContext + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/BootstrapperAgent/ExecutionContext +``` + + + + +This node holds opaque data that will be passed to the Bootstrapper Agent as a parameter when it is invoked to execute. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get, Replace | + + + + + + + + + +### BootstrapperAgent/InstallationStatusUri + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/BootstrapperAgent/InstallationStatusUri +``` + + + + +This node holds a URI that can be queried for the status of the Bootstrapper Agent installation. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get, Replace | + + + + + + + + + +## PageEnabled + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/PageEnabled +``` + + + + +This node determines whether to enable or show the Device Preparation page. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | bool | +| Access Type | Get, Replace | +| Default Value | false | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| false (Default) | The page is not enabled. | +| true | The page is enabled. | + + + + + + + + + +## PageSettings + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/PageSettings +``` + + + + +This node configures specific settings for the Device Preparation page. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Get, Replace | + + + + + + + + + +## PageStatus + + +| 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 Insider Preview | + + + +```Device +./Device/Vendor/MSFT/DevicePreparation/PageStatus +``` + + + + +This node provides status of the Device Preparation page. Values are an enum: 0 = Disabled; 1 = Enabled; 2 = InProgress; 3 = Succeeded; 4 = Failed. + + + + + + + +**Description framework properties**: + +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Get | + + + +**Allowed values**: + +| Value | Description | +|:--|:--| +| 0 | Disabled. | +| 1 | Enabled. | +| 2 | InProgress. | +| 3 | Succeeded. | +| 4 | Failed. | + + + + + + + + + + + + + + +## Related articles + +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/devicepreparation-ddf-file.md b/windows/client-management/mdm/devicepreparation-ddf-file.md new file mode 100644 index 0000000000..e10e6a1a49 --- /dev/null +++ b/windows/client-management/mdm/devicepreparation-ddf-file.md @@ -0,0 +1,252 @@ +--- +title: DevicePreparation DDF file +description: View the XML file containing the device description framework (DDF) for the DevicePreparation 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 +--- + + + +# DevicePreparation DDF file + +The following XML file contains the device description framework (DDF) for the DevicePreparation configuration service provider. + +```xml + +]> + + 1.2 + + + + DevicePreparation + ./Device/Vendor/MSFT + + + + + Parent node for the CSP. + + + + + + + + + + + + + + 99.9.99999 + 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; + + + + PageEnabled + + + + + + false + This node determines whether to enable or show the Device Preparation page. + + + + + + + + + + + + + + + false + The page is not enabled + + + true + The page is enabled + + + + + + PageStatus + + + + + This node provides status of the Device Preparation page. Values are an enum: 0 = Disabled; 1 = Enabled; 2 = InProgress; 3 = Succeeded; 4 = Failed. + + + + + + + + + + + + + + + 0 + Disabled + + + 1 + Enabled + + + 2 + InProgress + + + 3 + Succeeded + + + 4 + Failed + + + + + + PageSettings + + + + + + This node configures specific settings for the Device Preparation page. + + + + + + + + + + + + + + + + + + BootstrapperAgent + + + + + The subnodes configure settings for the Bootstrapper Agent. + + + + + + + + + + + + + + + ClassID + + + + + + This node stores the class ID for the Bootstrapper Agent WinRT object. + + + + + + + + + + + + + + + + + + ExecutionContext + + + + + + This node holds opaque data that will be passed to the Bootstrapper Agent as a parameter when it is invoked to execute. + + + + + + + + + + + + + + + + + + InstallationStatusUri + + + + + + This node holds a URI that can be queried for the status of the Bootstrapper Agent installation. + + + + + + + + + + + + + + + + + + + +``` + +## Related articles + +[DevicePreparation configuration service provider reference](devicepreparation-csp.md) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index d6bbeca59e..a9748e5429 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -670,6 +670,11 @@ items: items: - name: DeviceManageability DDF file href: devicemanageability-ddf.md + - name: DevicePreparation + href: devicepreparation-csp.md + items: + - name: DevicePreparation DDF file + href: devicepreparation-ddf-file.md - name: DeviceStatus href: devicestatus-csp.md items: @@ -742,8 +747,6 @@ items: items: - name: EnterpriseModernAppManagement DDF file href: enterprisemodernappmanagement-ddf.md - - name: EnterpriseModernAppManagement XSD - href: enterprisemodernappmanagement-xsd.md - name: eUICCs href: euiccs-csp.md items: