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

update declared config csps

Browse Source
This commit is contained in:
Aaron Czechowski 2023-09-27 16:16:21 -07:00
parent 7040a92d8a
commit 009729d7ae
4 changed files with 135 additions and 419 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

230
windows/client-management/mdm/declaredconfiguration-csp.md
View File

@ -29,7 +29,6 @@ The declared configuration device management model requires the server to delive
- On the client, if there are any requests in process or completed, it sends a [generic alert](#declared-configuration-generic-alert) to the server. This alert summarizes each document's status, state, and progress. Every client HTTPS request to the declared configuration OMA-DM server includes this summary.
- The declared configuration server uses the generic alert to determine which requests are completed successfully or with errors. The server can then synchronously retrieve the declared configuration document process results through the [Declared Configuration CSP URI](#declared-configuration-oma-uri).
<!-- DeclaredConfiguration-Editable-End -->
<!-- DeclaredConfiguration-Tree-Begin -->
@ -53,10 +52,6 @@ The following list shows the DeclaredConfiguration configuration service provide
- [Results](#hostinventoryresults)
- [{DocID}](#hostinventoryresultsdocid)
- [Document](#hostinventoryresultsdociddocument)
- [ManagementServiceConfiguration](#managementserviceconfiguration)
- [CertificateExpirationThreshold](#managementserviceconfigurationcertificateexpirationthreshold)
- [RefreshInterval](#managementserviceconfigurationrefreshinterval)
- [StartSyncSessionOnFailure](#managementserviceconfigurationstartsyncsessiononfailure)
<!-- DeclaredConfiguration-Tree-End -->
<!-- Device-Host-Begin -->
@ -75,7 +70,8 @@ The following list shows the DeclaredConfiguration configuration service provide
<!-- Device-Host-OmaUri-End -->
<!-- Device-Host-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Host internal node indicates that the target of the configuration request or inventory request is the host OS. This node is for scope in case enclaves are ever targeted for configuration.
<!-- Device-Host-Description-End -->
<!-- Device-Host-Editable-Begin -->
@ -113,7 +109,8 @@ The following list shows the DeclaredConfiguration configuration service provide
<!-- Device-Host-Complete-OmaUri-End -->
<!-- Device-Host-Complete-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
This internal node indicates that the configuration has discrete settings values and is self-contained with complete setting and value pairs that don't contain placeholders that the need to be resolved later with additional data. The request is ready to be processed as is.
<!-- Device-Host-Complete-Description-End -->
<!-- Device-Host-Complete-Editable-Begin -->
@ -152,7 +149,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Documents-OmaUri-End -->
<!-- Device-Host-Complete-Documents-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Documents node indicates that the configuration is in the form of a document, which is a collection of settings used to configure a scenario by the Declared Configuration stack.
<!-- Device-Host-Complete-Documents-Description-End -->
<!-- Device-Host-Complete-Documents-Editable-Begin -->
@ -190,7 +188,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Documents-{DocID}-OmaUri-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
Uniquely identifies the configuration document. No other document can have this id. The Id should be a GUID.
<!-- Device-Host-Complete-Documents-{DocID}-Description-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Editable-Begin -->
@ -230,7 +229,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Documents-{DocID}-Document-OmaUri-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Document-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Document node's value is an XML based document containing a collection of settings and values to configure the specified scenario. The Declared Configuration stack verifies the syntax of the document, the stack marks the document to be processed asynchronously by the client. The stack then returns control back to the OMA-DM service. The stack, in turn, asynchronously processes the request. Below is an example of a specified desired state configuration using the Declared Configuration URI ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68. B9-4320-9. FC4-296. F6FDFAFE2/Document.
<!-- Device-Host-Complete-Documents-{DocID}-Document-Description-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Document-Editable-Begin -->
@ -268,7 +268,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Documents-{DocID}-Properties-OmaUri-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Properties node encapsulates the list of properties that apply to the specified document referenced by [DocID].
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Description-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Editable-Begin -->
@ -306,7 +307,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-OmaUri-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Abandoned node allows the OMA-DM server to indicate that the document is no longer managed.
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-Description-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-Editable-Begin -->
@ -328,8 +330,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
| Value | Description |
|:--|:--|
| 0 (Default) | Insert Description Here. |
| 1 | Insert Description Here. |
| 0 (Default) | The document is no longer managed. |
| 1 | The document is managed. |
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-AllowedValues-End -->
<!-- Device-Host-Complete-Documents-{DocID}-Properties-Abandoned-Examples-Begin -->
@ -354,7 +356,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Results-OmaUri-End -->
<!-- Device-Host-Complete-Results-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Results node indicates that this is part of the URI path that will return an XML document containing the results of the configuration request.
<!-- Device-Host-Complete-Results-Description-End -->
<!-- Device-Host-Complete-Results-Editable-Begin -->
@ -392,7 +395,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Results-{DocID}-OmaUri-End -->
<!-- Device-Host-Complete-Results-{DocID}-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
Uniquely identifies the configuration document in which results of the configuration request will be returned.
<!-- Device-Host-Complete-Results-{DocID}-Description-End -->
<!-- Device-Host-Complete-Results-{DocID}-Editable-Begin -->
@ -431,7 +435,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Complete-Results-{DocID}-Document-OmaUri-End -->
<!-- Device-Host-Complete-Results-{DocID}-Document-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Document node's value is an XML based document containing a collection of setting results from the configuration request specified by [DocId].
<!-- Device-Host-Complete-Results-{DocID}-Document-Description-End -->
<!-- Device-Host-Complete-Results-{DocID}-Document-Editable-Begin -->
@ -469,7 +474,8 @@ The server to client flow of the **Complete** request is the same as an **Invent
<!-- Device-Host-Inventory-OmaUri-End -->
<!-- Device-Host-Inventory-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Inventory internal node indicates that this is an inventory request. The setting values to be retrieved are specified in an XML document through the Document leaf node.
<!-- Device-Host-Inventory-Description-End -->
<!-- Device-Host-Inventory-Editable-Begin -->
@ -508,7 +514,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Documents-OmaUri-End -->
<!-- Device-Host-Inventory-Documents-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Documents node indicates that the inventory request is in the form of a document, which is a collection of settings used to retrieve their values.
<!-- Device-Host-Inventory-Documents-Description-End -->
<!-- Device-Host-Inventory-Documents-Editable-Begin -->
@ -546,7 +553,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Documents-{DocID}-OmaUri-End -->
<!-- Device-Host-Inventory-Documents-{DocID}-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
Uniquely identifies the inventory document. No other document can have this id. The Id should be a GUID.
<!-- Device-Host-Inventory-Documents-{DocID}-Description-End -->
<!-- Device-Host-Inventory-Documents-{DocID}-Editable-Begin -->
@ -586,7 +594,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Documents-{DocID}-Document-OmaUri-End -->
<!-- Device-Host-Inventory-Documents-{DocID}-Document-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Document node's value is an XML based document containing a collection of settings that will be used to retrieve their values. The Declared Configuration stack verifies the syntax of the document, the stack marks the document to be processed asynchronously by the client. The stack then returns control back to the OMA-DM service. The stack, in turn, asynchronously processes the request. Below is an example of a specified desired state configuration using the Declared Configuration URI ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents/27FEA311-68. B9-4320-9. FC4-296. F6FDFAFE2/Document.
<!-- Device-Host-Inventory-Documents-{DocID}-Document-Description-End -->
<!-- Device-Host-Inventory-Documents-{DocID}-Document-Editable-Begin -->
@ -624,7 +633,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Results-OmaUri-End -->
<!-- Device-Host-Inventory-Results-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Results node indicates that this is part of the URI path that will return an XML document containing the results of the inventory request.
<!-- Device-Host-Inventory-Results-Description-End -->
<!-- Device-Host-Inventory-Results-Editable-Begin -->
@ -662,7 +672,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Results-{DocID}-OmaUri-End -->
<!-- Device-Host-Inventory-Results-{DocID}-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
Uniquely identifies the inventory document. No other document can have this id. The Id should be a GUID.
<!-- Device-Host-Inventory-Results-{DocID}-Description-End -->
<!-- Device-Host-Inventory-Results-{DocID}-Editable-Begin -->
@ -701,7 +712,8 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Results-{DocID}-Document-OmaUri-End -->
<!-- Device-Host-Inventory-Results-{DocID}-Document-Description-Begin -->
<!-- Description-Source-Not-Found -->
<!-- Description-Source-DDF -->
The Document node's value is an XML based document containing a collection of setting results from the inventory request specified by [DocId].
<!-- Device-Host-Inventory-Results-{DocID}-Document-Description-End -->
<!-- Device-Host-Inventory-Results-{DocID}-Document-Editable-Begin -->
@ -723,176 +735,6 @@ The server to client flow of the **Inventory** request is the same as the **Comp
<!-- Device-Host-Inventory-Results-{DocID}-Document-End -->
<!-- Device-ManagementServiceConfiguration-Begin -->
## ManagementServiceConfiguration
<!-- Device-ManagementServiceConfiguration-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview |
<!-- Device-ManagementServiceConfiguration-Applicability-End -->
<!-- Device-ManagementServiceConfiguration-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration
```
<!-- Device-ManagementServiceConfiguration-OmaUri-End -->
<!-- Device-ManagementServiceConfiguration-Description-Begin -->
<!-- Description-Source-DDF -->
Configuration settings for WinDC behavior.
<!-- Device-ManagementServiceConfiguration-Description-End -->
<!-- Device-ManagementServiceConfiguration-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-Editable-End -->
<!-- Device-ManagementServiceConfiguration-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `node` |
| Access Type | Get |
<!-- Device-ManagementServiceConfiguration-DFProperties-End -->
<!-- Device-ManagementServiceConfiguration-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-Examples-End -->
<!-- Device-ManagementServiceConfiguration-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Begin -->
### ManagementServiceConfiguration/CertificateExpirationThreshold
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview |
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Applicability-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration/CertificateExpirationThreshold
```
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-OmaUri-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Description-Begin -->
<!-- Description-Source-DDF -->
This node determines the number of minutes as near expiration check for certificate.
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Description-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Editable-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `int` |
| Access Type | Add, Delete, Get, Replace |
| Allowed Values | Range: `[0-4294967295]` |
| Default Value | 2880 |
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-DFProperties-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-Examples-End -->
<!-- Device-ManagementServiceConfiguration-CertificateExpirationThreshold-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Begin -->
### ManagementServiceConfiguration/RefreshInterval
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview |
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Applicability-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration/RefreshInterval
```
<!-- Device-ManagementServiceConfiguration-RefreshInterval-OmaUri-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Description-Begin -->
<!-- Description-Source-DDF -->
This node determines the number of minutes between refreshes.
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Description-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Editable-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `int` |
| Access Type | Add, Delete, Get, Replace |
| Allowed Values | Range: `[30-4294967295]` |
| Default Value | 240 |
<!-- Device-ManagementServiceConfiguration-RefreshInterval-DFProperties-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-Examples-End -->
<!-- Device-ManagementServiceConfiguration-RefreshInterval-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Begin -->
### ManagementServiceConfiguration/StartSyncSessionOnFailure
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview |
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Applicability-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration/StartSyncSessionOnFailure
```
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-OmaUri-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Description-Begin -->
<!-- Description-Source-DDF -->
This node determines whether or not to start a sync session when failed to refresh.
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Description-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Editable-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `bool` |
| Access Type | Add, Delete, Get, Replace |
| Default Value | false |
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-DFProperties-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| true | Start a sync session when failed to refresh. |
| false (Default) | Don't start a sync session when failed to refresh. |
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-AllowedValues-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-Examples-End -->
<!-- Device-ManagementServiceConfiguration-StartSyncSessionOnFailure-End -->
<!-- DeclaredConfiguration-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
## Declared configuration OMA URI

155
windows/client-management/mdm/declaredconfiguration-ddf-file.md
View File

@ -4,7 +4,7 @@ description: View the XML file containing the device description framework (DDF)
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.date: 09/13/2023
ms.date: 09/27/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
@ -31,7 +31,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Declared Configuration CSP (Configuration Service Provider) allows the OMA-DM server to provide the device with the complete collection of setting names and associated values based on a specified scenario. The Declared Configuration stack on the device is responsible for handling the configuration request along with maintaining its state including updates to the scenario. It also provides the means to retrieve a scenario’s settings from the device. The configuration request and settings retrieval request are performed asynchronously, freeing up the server’s worker thread to do other useful work. The subsequent results can be retrieved through Declared Configuration’s result nodes.</Description>
<DFFormat>
<node />
</DFFormat>
@ -58,7 +58,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Host internal node indicates that the target of the configuration request or inventory request is the host OS. This node is for scope in case enclaves are ever targeted for configuration.</Description>
<DFFormat>
<node />
</DFFormat>
@ -80,7 +80,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>This internal node indicates that the configuration has discrete settings values and is self-contained with complete setting and value pairs that do not contain placeholders that the need to be resolved later with additional data. The request is ready to be processed as is.</Description>
<DFFormat>
<node />
</DFFormat>
@ -102,7 +102,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Documents node indicates that the configuration is in the form of a document, which is a collection of settings used to configure a scenario by the Declared Configuration stack.</Description>
<DFFormat>
<node />
</DFFormat>
@ -125,7 +125,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>Uniquely identifies the configuration document. No other document can have this id. The Id should be a GUID.</Description>
<DFFormat>
<node />
</DFFormat>
@ -155,7 +155,7 @@ The following XML file contains the device description framework (DDF) for the D
<Get />
<Replace />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Document node's value is an XML based document containing a collection of settings and values to configure the specified scenario. The Declared Configuration stack verifies the syntax of the document, the stack marks the document to be processed asynchronously by the client. The stack then returns control back to the OMA-DM service. The stack, in turn, asynchronously processes the request. Below is an example of a specified desired state configuration using the Declared Configuration URI ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document</Description>
<DFFormat>
<chr />
</DFFormat>
@ -180,7 +180,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Properties node encapsulates the list of properties that apply to the specified document referenced by [DocID].</Description>
<DFFormat>
<node />
</DFFormat>
@ -204,7 +204,7 @@ The following XML file contains the device description framework (DDF) for the D
<Replace />
</AccessType>
<DefaultValue>0</DefaultValue>
<Description>Insert Description Here</Description>
<Description>The Abandoned node allows the OMA-DM server to indicate that the document is no longer managed.</Description>
<DFFormat>
<int />
</DFFormat>
@ -220,11 +220,11 @@ The following XML file contains the device description framework (DDF) for the D
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>0</MSFT:Value>
<MSFT:ValueDescription>Insert Description Here</MSFT:ValueDescription>
<MSFT:ValueDescription>The document is no longer managed.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>Insert Description Here</MSFT:ValueDescription>
<MSFT:ValueDescription>The document is managed.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
@ -238,7 +238,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Results node indicates that this is part of the URI path that will return an XML document containing the results of the configuration request.</Description>
<DFFormat>
<node />
</DFFormat>
@ -259,7 +259,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>Uniquely identifies the configuration document in which results of the configuration request will be returned.</Description>
<DFFormat>
<node />
</DFFormat>
@ -283,7 +283,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Document node's value is an XML based document containing a collection of setting results from the configuration request specified by [DocId].</Description>
<DFFormat>
<chr />
</DFFormat>
@ -309,7 +309,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Inventory internal node indicates that this is an inventory request. The setting values to be retrieved are specified in an XML document through the Document leaf node.</Description>
<DFFormat>
<node />
</DFFormat>
@ -331,7 +331,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Documents node indicates that the inventory request is in the form of a document, which is a collection of settings used to retrieve their values.</Description>
<DFFormat>
<node />
</DFFormat>
@ -354,7 +354,7 @@ The following XML file contains the device description framework (DDF) for the D
<Delete />
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>Uniquely identifies the inventory document. No other document can have this id. The Id should be a GUID.</Description>
<DFFormat>
<node />
</DFFormat>
@ -384,7 +384,7 @@ The following XML file contains the device description framework (DDF) for the D
<Get />
<Replace />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Document node's value is an XML based document containing a collection of settings that will be used to retrieve their values. The Declared Configuration stack verifies the syntax of the document, the stack marks the document to be processed asynchronously by the client. The stack then returns control back to the OMA-DM service. The stack, in turn, asynchronously processes the request. Below is an example of a specified desired state configuration using the Declared Configuration URI ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document</Description>
<DFFormat>
<chr />
</DFFormat>
@ -409,7 +409,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Results node indicates that this is part of the URI path that will return an XML document containing the results of the inventory request.</Description>
<DFFormat>
<node />
</DFFormat>
@ -430,7 +430,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>Uniquely identifies the inventory document. No other document can have this id. The Id should be a GUID.</Description>
<DFFormat>
<node />
</DFFormat>
@ -454,7 +454,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Insert Description Here</Description>
<Description>The Document node's value is an XML based document containing a collection of setting results from the inventory request specified by [DocId].</Description>
<DFFormat>
<chr />
</DFFormat>
@ -473,119 +473,6 @@ The following XML file contains the device description framework (DDF) for the D
</Node>
</Node>
</Node>
<Node>
<NodeName>ManagementServiceConfiguration</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Configuration settings for WinDC behavior</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>RefreshInterval</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>240</DefaultValue>
<Description>This node determines the number of minutes between refreshes.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="Range">
<MSFT:Value>[30-4294967295]</MSFT:Value>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>StartSyncSessionOnFailure</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>false</DefaultValue>
<Description>This node determines whether or not to start a sync session when failed to refresh.</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>Start a sync session when failed to refresh.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>false</MSFT:Value>
<MSFT:ValueDescription>Do not start a sync session when failed to refresh.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
<MSFT:ConflictResolution>LastWrite</MSFT:ConflictResolution>
</DFProperties>
</Node>
<Node>
<NodeName>CertificateExpirationThreshold</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<DefaultValue>2880</DefaultValue>
<Description>This node determines the number of minutes as near expiration check for certificate.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="Range">
<MSFT:Value>[0-4294967295]</MSFT:Value>
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node>
</Node>
</MgmtTree>
```

97
windows/client-management/mdm/dmclient-csp.md
View File

@ -4,7 +4,7 @@ description: Learn more about the DMClient CSP.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.date: 08/10/2023
ms.date: 09/27/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
@ -80,10 +80,10 @@ The following list shows the DMClient configuration service provider nodes:
- [HelpWebsite](#deviceproviderprovideridhelpwebsite)
- [HWDevID](#deviceproviderprovideridhwdevid)
- [LinkedEnrollment](#deviceproviderprovideridlinkedenrollment)
- [DiscoveryEndpoint](#deviceproviderprovideridlinkedenrollmentdiscoveryendpoint)
- [Enroll](#deviceproviderprovideridlinkedenrollmentenroll)
- [EnrollStatus](#deviceproviderprovideridlinkedenrollmentenrollstatus)
- [LastError](#deviceproviderprovideridlinkedenrollmentlasterror)
- [Priority](#deviceproviderprovideridlinkedenrollmentpriority)
- [Unenroll](#deviceproviderprovideridlinkedenrollmentunenroll)
- [ManagementServerAddressList](#deviceproviderprovideridmanagementserveraddresslist)
- [ManagementServerToUpgradeTo](#deviceproviderprovideridmanagementservertoupgradeto)
@ -2411,6 +2411,45 @@ The interior node for linked enrollment.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Begin -->
##### Device/Provider/{ProviderID}/LinkedEnrollment/DiscoveryEndpoint
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows Insider Preview |
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Applicability-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DMClient/Provider/{ProviderID}/LinkedEnrollment/DiscoveryEndpoint
```
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-OmaUri-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Description-Begin -->
<!-- Description-Source-DDF -->
Endpoint Discovery is the process where a specific URL (the "discovery endpoint") is accessed, which returns a directory of endpoints for using the system including enrollment. On Get, if the endpoint isn't set, client will return an rmpty string with S_OK.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Description-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Editable-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `chr` (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-DFProperties-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-Examples-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-DiscoveryEndpoint-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Enroll-Begin -->
##### Device/Provider/{ProviderID}/LinkedEnrollment/Enroll
@ -2428,7 +2467,7 @@ The interior node for linked enrollment.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Enroll-Description-Begin -->
<!-- Description-Source-DDF -->
Trigger to enroll for the Linked Enrollment.
This is an execution node and will trigger a silent Declared Configuration unenroll, there is no user interaction needed. On un-enrollment, all the settings/resources set by Declared Configuration will be rolled back (rollback details will be covered later).
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Enroll-Description-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Enroll-Editable-Begin -->
@ -2468,7 +2507,7 @@ This is an execution node and will trigger a silent Declared Configuration enrol
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-EnrollStatus-Description-Begin -->
<!-- Description-Source-DDF -->
Returns the current enrollment or un-enrollment status of the linked enrollment.
Returns the current enrollment or un-enrollment status of the linked enrollment. Supports Get only.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-EnrollStatus-Description-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-EnrollStatus-Editable-Begin -->
@ -2523,7 +2562,7 @@ Returns the current enrollment or un-enrollment status of the linked enrollment.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-LastError-Description-Begin -->
<!-- Description-Source-DDF -->
return the last error for enroll/unenroll.
Supports Get Only. Returns the HRESULT for the last error when enroll/unenroll fails.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-LastError-Description-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-LastError-Editable-Begin -->
@ -2545,54 +2584,6 @@ return the last error for enroll/unenroll.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-LastError-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Begin -->
##### Device/Provider/{ProviderID}/LinkedEnrollment/Priority
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| ✅ Device <br> ❌ User | ✅ Pro <br> ✅ Enterprise <br> ✅ Education <br> ✅ Windows SE <br> ✅ IoT Enterprise / IoT Enterprise LTSC | ✅ Windows 10, version 2009 [10.0.19042.2193] and later <br> ✅ Windows 10, version 21H1 [10.0.19043.2193] and later <br> ✅ Windows 10, version 21H2 [10.0.19044.2193] and later <br> ✅ Windows 11, version 21H2 [10.0.22000.918] and later <br> ✅ Windows 11, version 22H2 [10.0.22621] and later |
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Applicability-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/DMClient/Provider/{ProviderID}/LinkedEnrollment/Priority
```
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-OmaUri-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Description-Begin -->
<!-- Description-Source-DDF -->
Optional. Allowed value is 0 or 1. 0 means the main enrollment has authority for MDM settings and resources, 1 means the linked enrollment has authority.
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Description-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Editable-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | `int` |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-DFProperties-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-AllowedValues-Begin -->
**Allowed values**:
| Value | Description |
|:--|:--|
| 0 | The main enrollment has priority over linked enrollment. |
| 1 | The linked enrollment has priority over the main enrollment. |
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-AllowedValues-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-Examples-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Priority-End -->
<!-- Device-Provider-{ProviderID}-LinkedEnrollment-Unenroll-Begin -->
##### Device/Provider/{ProviderID}/LinkedEnrollment/Unenroll

72
windows/client-management/mdm/dmclient-ddf-file.md
View File

@ -4,7 +4,7 @@ description: View the XML file containing the device description framework (DDF)
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.date: 06/02/2023
ms.date: 09/27/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
@ -2548,47 +2548,13 @@ The following XML file contains the device description framework (DDF) for the D
<MSFT:CspVersion>1.6</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties>
<Node>
<NodeName>Priority</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Optional. Allowed value is 0 or 1. 0 means the main enrollment has authority for mdm settings and resources, 1 means the linked enrollment has authority.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<ZeroOrOne />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="ENUM">
<MSFT:Enum>
<MSFT:Value>0</MSFT:Value>
<MSFT:ValueDescription>The main enrollment has priority over linked enrollment.</MSFT:ValueDescription>
</MSFT:Enum>
<MSFT:Enum>
<MSFT:Value>1</MSFT:Value>
<MSFT:ValueDescription>The linked enrollment has priority over the main enrollment.</MSFT:ValueDescription>
</MSFT:Enum>
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>LastError</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>return the last error for enroll/unenroll.</Description>
<Description>Supports Get Only. Returns the HRESULT for the last error when enroll/unenroll fails.</Description>
<DFFormat>
<int />
</DFFormat>
@ -2609,7 +2575,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Get />
</AccessType>
<Description>Returns the current enrollment or un-enrollment status of the linked enrollment.</Description>
<Description>Returns the current enrollment or un-enrollment status of the linked enrollment. Supports Get only.</Description>
<DFFormat>
<int />
</DFFormat>
@ -2668,7 +2634,7 @@ The following XML file contains the device description framework (DDF) for the D
<AccessType>
<Exec />
</AccessType>
<Description>Trigger to enroll for the Linked Enrollment</Description>
<Description>This is an execution node and will trigger a silent Declared Configuration unenroll, there is no user interaction needed. On un-enrollment, all the settings/resources set by Declared Configuration will be rolled back (rollback details will be covered later).</Description>
<DFFormat>
<null />
</DFFormat>
@ -2704,6 +2670,36 @@ The following XML file contains the device description framework (DDF) for the D
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>DiscoveryEndpoint</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Endpoint Discovery is the process where a specific URL (the "discovery endpoint") is accessed, which returns a directory of endpoints for using the system including enrollment. On Get, if the endpoint is not set, client will return an rmpty string with S_OK. </Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>99.9.99999</MSFT:OsBuildVersion>
<MSFT:CspVersion>9.9</MSFT:CspVersion>
</MSFT:Applicability>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node>
<Node>
<NodeName>MultipleSession</NodeName>