deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-06-16 02:43:43 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

More changes

Browse Source
This commit is contained in:
Vinay Pamnani
2023-09-14 13:07:38 -04:00
parent 70264d37e6
commit 225aaccfd5
5 changed files with 12 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
windows/client-management/declared-configuration-dsc.md
View File

@ -1,10 +0,0 @@
---
title: Authoring DSC resources for Declared Configuration
description: Learn more about authoring DSC resources for Declared Configuration
ms.date: 09/11/2023
ms.topic: how-to
---
# Authoring DSC resources for Declared Configuration
[TODO]

4
windows/client-management/declared-configuration-extensibility.md
View File

@ -62,7 +62,7 @@ To create a native WMI provider, follow the steps outlined in [How to Implement
This example provides more details about each step to demonstrate how to implement a sample native resource named `MSFT_FileDirectoryConfiguration`. This example provides more details about each step to demonstrate how to implement a sample native resource named `MSFT_FileDirectoryConfiguration`.
### Step 1: Create the Resource Schema File in MOF Format ### Step 1: Create the resource schema MOF file
Create a sample schema MOF file used to generate the initial source code for the `MSFT_FileDirectoryConfiguration` native resource and place it in the project directory named `MSFT_FileDirectoryConfiguration`. Create a sample schema MOF file used to generate the initial source code for the `MSFT_FileDirectoryConfiguration` native resource and place it in the project directory named `MSFT_FileDirectoryConfiguration`.
@ -188,7 +188,7 @@ Copy the generated files from the `temp` folder that was specified with `-OutPat
> [!NOTE] > [!NOTE]
> With each update to the schema MOF file, `codegen.cmd` script to regenerate the source files must be executed again, which overwrites the source files if they exist. To prevent this, this example uses a temporary folder. It is best to minimize the updates to the schema MOF file since the main implementation should be merged with the most recent auto-generated source files. > With each update to the schema MOF file, `codegen.cmd` script to regenerate the source files must be executed again, which overwrites the source files if they exist. To prevent this, this example uses a temporary folder. It is best to minimize the updates to the schema MOF file since the main implementation should be merged with the most recent auto-generated source files.
### Auto-generated MSFT_FileDirectoryConfiguration Resource ### About MSFT_FileDirectoryConfiguration resource
After you run the provider generator tool, several source and header files are created, including: After you run the provider generator tool, several source and header files are created, including:

2
windows/client-management/declared-configuration.md
View File

@ -28,7 +28,7 @@ The benefit of the Declared Configuration desired state model is that it's effic
- [LinkedEnrollment/LastError](mdm/dmclient-csp.md#deviceproviderprovideridlinkedenrollmentlasterror) - [LinkedEnrollment/LastError](mdm/dmclient-csp.md#deviceproviderprovideridlinkedenrollmentlasterror)
- [LinkedEnrollment/DiscoveryEndpoint](mdm/dmclient-csp.md#deviceproviderprovideridlinkedenrollmentdiscoveryendpoint) - [LinkedEnrollment/DiscoveryEndpoint](mdm/dmclient-csp.md#deviceproviderprovideridlinkedenrollmentdiscoveryendpoint)
Here's a SyncML example for setting LinkedEnrolment/DiscoveryEndpoint and triggering LinkedEnrollment/Enroll: Here's a SyncML example for setting **LinkedEnrolment/DiscoveryEndpoint** and triggering **LinkedEnrollment/Enroll**:
```xml ```xml
<SyncML xmlns="SYNCML:SYNCML1.1"> <SyncML xmlns="SYNCML:SYNCML1.1">

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

@ -25,7 +25,7 @@ The Primary MDM Management device management model is one where the MDM server i
The new Declared Configuration device management model requires the server to deliver all the setting values to the device for the scenario configuration, in batch, asynchronously through the client Declared Configuration CSP. The new Declared Configuration device management model requires the server to deliver all the setting values to the device for the scenario configuration, in batch, asynchronously through the client Declared Configuration CSP.
- During the client initiated OMA-DM session, the Declared Configuration server sends a configuration or an inventory Declared Configuration document to the client through the [Declared Configuration CSP URI](#declared-configuration-oma-uri). If the device verifies the syntax of the document is correct, the client stack pushes the request to its orchestrator to be processed asynchronously. The client stack then exits, returning control back to Declared Configuration service allowing the device to asynchronously process the request. - During the client initiated OMA-DM session, the Declared Configuration server sends a configuration or an inventory Declared Configuration document to the client through the [Declared Configuration CSP URI](#declared-configuration-oma-uri). If the device verifies the syntax of the document is correct, the client stack pushes the request to its orchestrator to be processed asynchronously. The client stack then exits, returning control back to Declared Configuration service allowing the device to asynchronously process the request.
- On the client, if there are any requests in process or completed, a [generic alert](#declared-configuration-document-generic-alert) is sent to the server summing up each document status, state, progress. This summation is sent on every client HTTP request to the Declared Configuration OMA-DM server. - On the client, if there are any requests in process or completed, a [generic alert](#declared-configuration-generic-alert) is sent to the server summing up each document status, state, progress. This summation is sent on every client HTTP request to the Declared Configuration OMA-DM server.
- The Declared Configuration server uses the 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). - The Declared Configuration server uses the 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-Editable-End -->
@ -115,6 +115,7 @@ The following list shows the DeclaredConfiguration configuration service provide
<!-- Device-Host-Complete-Editable-Begin --> <!-- Device-Host-Complete-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. --> <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The Server to Client flow of the Complete request, is the same as an Inventory request.
<!-- Device-Host-Complete-Editable-End --> <!-- Device-Host-Complete-Editable-End -->
<!-- Device-Host-Complete-DFProperties-Begin --> <!-- Device-Host-Complete-DFProperties-Begin -->
@ -470,6 +471,7 @@ The following list shows the DeclaredConfiguration configuration service provide
<!-- Device-Host-Inventory-Editable-Begin --> <!-- Device-Host-Inventory-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. --> <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The Server to Client flow of the Inventory request, is the same as the Complete request.
<!-- Device-Host-Inventory-Editable-End --> <!-- Device-Host-Inventory-Editable-End -->
<!-- Device-Host-Inventory-DFProperties-Begin --> <!-- Device-Host-Inventory-DFProperties-Begin -->
@ -892,16 +894,14 @@ This node determines whether or not to start a sync session when failed to refre
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. --> <!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
## Declared Configuration OMA URI ## Declared Configuration OMA URI
A Declared Configuration request is sent using an OMA-URI similar to `./Device/Vendor/MSFT/DeclaredConfiguration/Host/[Complete|Inventory]/Documents/{document id guid}/Document`. A Declared Configuration request is sent using an OMA-URI similar to `./Device/Vendor/MSFT/DeclaredConfiguration/Host/[Complete|Inventory]/Documents/{DocID}/Document`.
- The URI is prefixed with a targeted scope. The target of the scenario settings can only be device wide for Extensibility. The scope should be "Device". - The URI is prefixed with a targeted scope. The target of the scenario settings can only be device wide for Extensibility. The scope should be "Device".
- `{document id guid}` is a unique identifier for the desired state of the configuration scenario. Every document must have a unique doc id, which must be a GUID. - `{DocID}` is a unique identifier for the desired state of the configuration scenario. Every document must have a ID, which must be a GUID.
- The request can be a Configuration request, Inventory request or Complete. - The request can be a Configuration request, Inventory or Complete.
Example URI for a Complete request: `./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document` Example URI for a Complete request: `./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document`
The Server to Client flow of the configuration URI request, Complete, is the same as an Inventory request.
## DeclaredConfiguration Document XML ## DeclaredConfiguration Document XML
The value of the leaf node Document is an XML document describing the request. The actual processing of the request pivots around the `osdefinedscenario` tag: The value of the leaf node Document is an XML document describing the request. The actual processing of the request pivots around the `osdefinedscenario` tag:
@ -922,7 +922,7 @@ Here's an example that uses the built-in native MI provider **MSFT_FileDirectory
</DeclaredConfiguration> </DeclaredConfiguration>
``` ```
The standard OMA-DM SyncML syntax is used to specify the DeclaredConfiguration CSP operations such as Replace, Set, and Delete. The SyncML's `<Data>` element's value is the specified desired state document, which is also expressed in XML and uses CDATA to ensure that the Declared Configuration client can properly interpret the SyncML. The standard OMA-DM SyncML syntax is used to specify the DeclaredConfiguration CSP operations such as Replace, Set, and Delete. The payload of the SyncML's `<Data>` element must be XML-encoded; for this XML encoding, there are a variety of online encoders that you can use. To avoid encoding the payload, you can use [CDATA Section](http://www.w3.org/TR/REC-xml/#sec-cdata-sect) as shown in this example.
```xml ```xml
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
@ -990,7 +990,7 @@ Both MSFTExtensibilityMIProviderConfig and MSFTExtensibilityMIProviderInventory
|--|--| |--|--|
| name | Specifies the name of a MI Provider parameter. | | name | Specifies the name of a MI Provider parameter. |
## Declared Configuration Document generic alert ## Declared Configuration generic alert
On every client response to the server's request, the client constructs a Declared Configuration alert summing up the state of each of the documents that the Windows service has processed. Here's an example alert: On every client response to the server's request, the client constructs a Declared Configuration alert summing up the state of each of the documents that the Windows service has processed. Here's an example alert:

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

@ -32,7 +32,7 @@ items:
- name: Declared Configuration protocol - name: Declared Configuration protocol
href: ../declared-configuration.md href: ../declared-configuration.md
items: items:
- name: Declared Configuration Extensibility - name: Declared Configuration extensibility
href: ../declared-configuration-extensibility.md href: ../declared-configuration-extensibility.md
- name: DeclaredConfiguration CSP - name: DeclaredConfiguration CSP
href: declaredconfiguration-csp.md href: declaredconfiguration-csp.md