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

MarkDown update: replace deprecated HTML tags

Browse Source 
- As requested in issue ticket #9449
(**<strong> tags causing issue in localized articles**),
this Pull Request aims to remove HTML tags known to cause layout and
readability issues in the MS Docs document pages, Frame Overflow being
a frequent and obvious layout-breaking issue in translated articles.

Changes proposed:
- Replace HTML tag <strong> </strong> with its MD equivalent ** **
- Replace single asterisk * with underscore _ (when combined with **)
- Simplify usage of bold formatting (** **) to only the outer pair
- Replace HTML tag <em> </em> with MarkDown underscore _ _

Whitespace changes:
- Remove redundant end-of-line (EOL) blanks (trailing space)
- Normalize spacing in numbered lists and bullet point lists to 1 space
- Replace end-of-file (EOF) consecutive blank lines with 1 NewLine
- Normalize layout spacing in MarkDown tables (consistency)
- Normalize layout to 1 blank line after H2, H3, H4 headings
- Allow up to 2 blank lines spacing (not 3 or more), ex. H1 page title

Closes #9449
This commit is contained in:
illfated 2021-04-24 11:49:32 +02:00
parent f7d1ea21d2
commit 594bfb310b
5 changed files with 221 additions and 247 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
windows/client-management/mdm/diagnosticlog-csp.md
View File

@ -13,6 +13,7 @@ ms.date: 11/19/2019
--- ---
# DiagnosticLog CSP # DiagnosticLog CSP
The DiagnosticLog configuration service provider (CSP) provides the following feature areas: The DiagnosticLog configuration service provider (CSP) provides the following feature areas:
- [DiagnosticArchive area](#diagnosticarchive-area). Capture and upload event logs, log files, and registry values for troubleshooting. - [DiagnosticArchive area](#diagnosticarchive-area). Capture and upload event logs, log files, and registry values for troubleshooting.
- [Policy area](#policy-area). Configure Windows event log policies, such as maximum log size. - [Policy area](#policy-area). Configure Windows event log policies, such as maximum log size.
@ -27,9 +28,9 @@ The following are the links to different versions of the DiagnosticLog CSP DDF f
The following shows the DiagnosticLog CSP in tree format. The following shows the DiagnosticLog CSP in tree format.
``` ```
./Vendor/MSFT ./Vendor/MSFT/DiagnosticLog
DiagnosticLog
----EtwLog ----EtwLog
--------Collectors --------Collectors
------------CollectorName ------------CollectorName
@ -59,6 +60,7 @@ DiagnosticLog
----------------DataBlocks ----------------DataBlocks
--------------------BlockNumber --------------------BlockNumber
``` ```
<a href="" id="--vendor-msft-diagnosticlog"></a>**./Vendor/MSFT/DiagnosticLog** <a href="" id="--vendor-msft-diagnosticlog"></a>**./Vendor/MSFT/DiagnosticLog**
The root node for the DiagnosticLog CSP. The root node for the DiagnosticLog CSP.
@ -68,7 +70,7 @@ Rest of the nodes in the DiagnosticLog CSP are described within their respective
The DiagnosticArchive functionality within the DiagnosticLog CSP is used to trigger devices to gather troubleshooting data into a zip archive file and upload that archive to cloud storage. DiagnosticArchive is designed for ad-hoc troubleshooting scenarios, such as an IT admin investigating an app installation failure using a collection of event log events, registry values, and app or OS log files. The DiagnosticArchive functionality within the DiagnosticLog CSP is used to trigger devices to gather troubleshooting data into a zip archive file and upload that archive to cloud storage. DiagnosticArchive is designed for ad-hoc troubleshooting scenarios, such as an IT admin investigating an app installation failure using a collection of event log events, registry values, and app or OS log files.
> [!Note] > [!NOTE]
> DiagnosticArchive is a "break glass" backstop option for device troubleshooting. Diagnostic data such as log files can grow to many gigabytes. Gathering, transferring, and storing large amounts of data may burden the user's device, the network and cloud storage. Management servers invoking DiagnosticArchive must take care to minimize data gathering frequency and scope. > DiagnosticArchive is a "break glass" backstop option for device troubleshooting. Diagnostic data such as log files can grow to many gigabytes. Gathering, transferring, and storing large amounts of data may burden the user's device, the network and cloud storage. Management servers invoking DiagnosticArchive must take care to minimize data gathering frequency and scope.
The following section describes the nodes for the DiagnosticArchive functionality. The following section describes the nodes for the DiagnosticArchive functionality.
@ -230,6 +232,7 @@ A Get to the above URI will return the results of the data gathering for the las
Each data gathering node is annotated with the HRESULT of the action and the collection is also annotated with an overall HRESULT. In this example, note that the mdmdiagnosticstool.exe command failed. Each data gathering node is annotated with the HRESULT of the action and the collection is also annotated with an overall HRESULT. In this example, note that the mdmdiagnosticstool.exe command failed.
### Making use of the uploaded data ### Making use of the uploaded data
The zip archive which is created and uploaded by the CSP contains a folder structure like the following: The zip archive which is created and uploaded by the CSP contains a folder structure like the following:
```powershell ```powershell
@ -828,22 +831,22 @@ The DiagnosticLog CSP maintains a log file for each collector node and the log f
For each collector node, the user can: For each collector node, the user can:
- Start or stop the session with all registered and enabled providers - Start or stop the session with all registered and enabled providers
- Query session status - Query session status
- Change trace log file mode - Change trace log file mode
- Change trace log file size limit - Change trace log file size limit
The configurations log file mode and log file size limit does not take effect while trace session is in progress. These are applied when user stops the current session and then starts it again for this collector. The configurations log file mode and log file size limit does not take effect while trace session is in progress. These are applied when user stops the current session and then starts it again for this collector.
For each registered provider in this collector, the user can: For each registered provider in this collector, the user can:
- Specify keywords to filter events from this provider - Specify keywords to filter events from this provider
- Change trace level to filter events from this provider - Change trace level to filter events from this provider
- Enable or disable the provider in the trace session - Enable or disable the provider in the trace session
The changes on **State**, **Keywords**, and **TraceLevel** takes effect immediately while trace session is in progress. The changes on **State**, **Keywords**, and **TraceLevel** takes effect immediately while trace session is in progress.
> [!Note] > [!NOTE]
> Microsoft-WindowsPhone-Enterprise-Diagnostics-Provider (GUID - 3da494e4-0fe2-415C-b895-fb5265c5c83b) has the required debug resource files built into Windows OS, which will allow the logs files to be decoded on the remote machine. Any other logs may not have the debug resources required to decode. > Microsoft-WindowsPhone-Enterprise-Diagnostics-Provider (GUID - 3da494e4-0fe2-415C-b895-fb5265c5c83b) has the required debug resource files built into Windows OS, which will allow the logs files to be decoded on the remote machine. Any other logs may not have the debug resources required to decode.
### Channel-based tracing ### Channel-based tracing
@ -864,20 +867,20 @@ For more information about using DiagnosticLog to collect logs remotely from a P
To gather diagnostics using this CSP: To gather diagnostics using this CSP:
1. Specify a *CollectorName* for the container of the target ETW providers. 1. Specify a *CollectorName* for the container of the target ETW providers.
2. (Optional) Set logging and log file parameters using the following options: 2. (Optional) Set logging and log file parameters using the following options:
- <a href="#etwlog-collectors-collectorname-tracelogfilemode">TraceLogFileMode</a> - <a href="#etwlog-collectors-collectorname-tracelogfilemode">TraceLogFileMode</a>
- <a href="#etwlog-collectors-collectorname-logfilesizelimitmb">LogFileSizeLimitMB</a> - <a href="#etwlog-collectors-collectorname-logfilesizelimitmb">LogFileSizeLimitMB</a>
3. Indicate one or more target ETW providers by supplying its *ProviderGUID* to the Add operation of EtwLog/Collectors/*CollectorName*/Providers/*ProviderGUID*. 3. Indicate one or more target ETW providers by supplying its *ProviderGUID* to the Add operation of EtwLog/Collectors/*CollectorName*/Providers/*ProviderGUID*.
4. (Optional) Set logging and log file parameters using the following options: 4. (Optional) Set logging and log file parameters using the following options:
- <a href="#etwlog-collectors-collectorname-providers-providerguid-tracelevel">TraceLevel</a> - <a href="#etwlog-collectors-collectorname-providers-providerguid-tracelevel">TraceLevel</a>
- <a href="#etwlog-collectors-collectorname-providers-providerguid-keywords">Keywords</a> - <a href="#etwlog-collectors-collectorname-providers-providerguid-keywords">Keywords</a>
5. Start logging using **TraceControl** EXECUTE command “START”. 5. Start logging using **TraceControl** EXECUTE command “START”.
6. Perform actions on the target device that will generate activity in the log files. 6. Perform actions on the target device that will generate activity in the log files.
7. Stop logging using **TraceControl** EXECUTE command “STOP”. 7. Stop logging using **TraceControl** EXECUTE command “STOP”.
8. Collect the log file located in the `%temp%` folder using the method described in [Reading a log file](#reading-a-log-file). 8. Collect the log file located in the `%temp%` folder using the method described in [Reading a log file](#reading-a-log-file).
The following section describes the nodes for EtwLog functionality. The following section describes the nodes for EtwLog functionality.
@ -891,7 +894,7 @@ Interior node to contain dynamic child interior nodes for active providers.
The supported operation is Get. The supported operation is Get.
<a href="" id="etwlog-collectors-collectorname"></a>**EtwLog/Collectors/**<strong>*CollectorName*</strong> <a href="" id="etwlog-collectors-collectorname"></a>**EtwLog/Collectors/_CollectorName_**
Dynamic nodes to represent active collector configuration. Dynamic nodes to represent active collector configuration.
Supported operations are Add, Delete, and Get. Supported operations are Add, Delete, and Get.
@ -947,7 +950,7 @@ The supported operation is Get.
The following table represents the possible values: The following table represents the possible values:
| Value | Description | | Value | Description |
|-------|-------------| | ----- | ----------- |
| 0 | Stopped | | 0 | Stopped |
| 1 | Started | | 1 | Started |
@ -961,9 +964,9 @@ Supported operations are Get and Replace.
The following table lists the possible values: The following table lists the possible values:
| Value | Description | | Value | Description |
|-------|--------------------| | ----- | ------------------ |
| EVENT_TRACE_FILE_MODE_SEQUENTIAL (0x00000001) | Writes events to a log file sequentially; stops when the file reaches its maximum size. | | EVENT_TRACE_FILE_MODE_SEQUENTIAL (0x00000001) | Writes events to a log file sequentially; stops when the file reaches its maximum size. |
| EVENT_TRACE_FILE_MODE_CIRCULAR (0x00000002) | Writes events to a log file. After the file reaches the maximum size, the oldest events are replaced with incoming events. | | EVENT_TRACE_FILE_MODE_CIRCULAR (0x00000002) | Writes events to a log file. After the file reaches the maximum size, the oldest events are replaced with incoming events. |
<a href="" id="etwlog-collectors-collectorname-tracecontrol"></a>**EtwLog/Collectors/*CollectorName*/TraceControl** <a href="" id="etwlog-collectors-collectorname-tracecontrol"></a>**EtwLog/Collectors/*CollectorName*/TraceControl**
Specifies the logging and report action state. Specifies the logging and report action state.
@ -973,9 +976,9 @@ The data type is a string.
The following table lists the possible values: The following table lists the possible values:
| Value | Description | | Value | Description |
|-------|--------------------| | ----- | ------------------ |
| START | Start log tracing. | | START | Start log tracing. |
| STOP | Stop log tracing | | STOP | Stop log tracing. |
The supported operation is Execute. The supported operation is Execute.
@ -1043,10 +1046,10 @@ Interior node to contain dynamic child interior nodes for active providers.
The supported operation is Get. The supported operation is Get.
<a href="" id="etwlog-collectors-collectorname-providers-providerguid"></a>**EtwLog/Collectors/*CollectorName*/Providers/**<strong>*ProviderGUID*</strong> <a href="" id="etwlog-collectors-collectorname-providers-providerguid"></a>**EtwLog/Collectors/*CollectorName*/Providers/_ProviderGUID_**
Dynamic nodes to represent active provider configuration per provider GUID. Dynamic nodes to represent active provider configuration per provider GUID.
> [!Note] > [!NOTE]
> Microsoft-WindowsPhone-Enterprise-Diagnostics-Provider (GUID - 3da494e4-0fe2-415C-b895-fb5265c5c83b) has the required debug resource files built into Windows OS, which will allow the logs files to be decoded on the remote machine. Any other logs may not have the debug resources required to decode. > Microsoft-WindowsPhone-Enterprise-Diagnostics-Provider (GUID - 3da494e4-0fe2-415C-b895-fb5265c5c83b) has the required debug resource files built into Windows OS, which will allow the logs files to be decoded on the remote machine. Any other logs may not have the debug resources required to decode.
Supported operations are Add, Delete, and Get. Supported operations are Add, Delete, and Get.
@ -1102,12 +1105,12 @@ Supported operations are Get and Replace.
The following table lists the possible values: The following table lists the possible values:
| Value | Description | | Value | Description |
|-------|--------------------| | ----- | ------------------ |
| 1 – TRACE_LEVEL_CRITICAL | Abnormal exit or termination events | | 1 – TRACE_LEVEL_CRITICAL | Abnormal exit or termination events |
| 2 – TRACE_LEVEL_ERROR | Severe error events | | 2 – TRACE_LEVEL_ERROR | Severe error events |
| 3 – TRACE_LEVEL_WARNING | Warning events such as allocation failures | | 3 – TRACE_LEVEL_WARNING | Warning events such as allocation failures |
| 4 – TRACE_LEVEL_INFORMATION | Non-error events, such as entry or exit events | | 4 – TRACE_LEVEL_INFORMATION | Non-error events, such as entry or exit events |
| 5 – TRACE_LEVEL_VERBOSE | Detailed information | | 5 – TRACE_LEVEL_VERBOSE | Detailed information |
Set provider **TraceLevel** Set provider **TraceLevel**
@ -1196,9 +1199,9 @@ Supported operations are Get and Replace. This change will be effective during a
The following table lists the possible values: The following table lists the possible values:
| Value | Description | | Value | Description |
|-------|--------------------| | ----- | ------------------ |
| TRUE | Provider is enabled in the trace session. This is the default. | | TRUE | Provider is enabled in the trace session. This is the default. |
| FALSE | Provider is disabled in the trace session. | | FALSE | Provider is disabled in the trace session. |
Set provider **State** Set provider **State**
@ -1228,7 +1231,7 @@ Interior node to contain dynamic child interior nodes for registered channels.
The supported operation is Get. The supported operation is Get.
<a href="" id="etwlog-channels-channelname"></a>**EtwLog/Channels/**<strong>*ChannelName*</strong> <a href="" id="etwlog-channels-channelname"></a>**EtwLog/Channels/_ChannelName_**
Dynamic nodes to represent a registered channel. The node name must be a valid Windows event log channel name, such as "Microsoft-Client-Licensing-Platform%2FAdmin" Dynamic nodes to represent a registered channel. The node name must be a valid Windows event log channel name, such as "Microsoft-Client-Licensing-Platform%2FAdmin"
Supported operations are Add, Delete, and Get. Supported operations are Add, Delete, and Get.
@ -1335,10 +1338,10 @@ Supported operations are Get and Replace.
The following table lists the possible values: The following table lists the possible values:
| Value | Description | | Value | Description |
|-------|--------------------| | ----- | -------------------- |
| TRUE | Channel is enabled. | | TRUE | Channel is enabled. |
| FALSE | Channel is disabled. | | FALSE | Channel is disabled. |
Get channel **State** Get channel **State**
@ -1418,9 +1421,11 @@ The supported value is Execute.
``` ```
## FileDownload area ## FileDownload area
The FileDownload feature of the DiagnosticLog CSP enables a management server to pull data directly from the device. In the FileDownload context the client and server roles are conceptually reversed, with the management server acting as a client to download the data from the managed device. The FileDownload feature of the DiagnosticLog CSP enables a management server to pull data directly from the device. In the FileDownload context the client and server roles are conceptually reversed, with the management server acting as a client to download the data from the managed device.
### Comparing FileDownload and DiagnosticArchive ### Comparing FileDownload and DiagnosticArchive
Both the FileDownload and DiagnosticArchive features can be used to get data from the device to the management server, but they are optimized for different workflows. Both the FileDownload and DiagnosticArchive features can be used to get data from the device to the management server, but they are optimized for different workflows.
- FileDownload enables the management server to directly pull byte-level trace data from the managed device. The data transfer takes place through the existing OMA-DM/SyncML context. It is typically used together with the EtwLogs feature as part of an advanced monitoring or diagnostic flow. FileDownlod requires granular orchestration by the management server, but avoids the need for dedicated cloud storage. - FileDownload enables the management server to directly pull byte-level trace data from the managed device. The data transfer takes place through the existing OMA-DM/SyncML context. It is typically used together with the EtwLogs feature as part of an advanced monitoring or diagnostic flow. FileDownlod requires granular orchestration by the management server, but avoids the need for dedicated cloud storage.
@ -1434,7 +1439,7 @@ Node to contain child nodes for log file transportation protocols and correspond
<a href="" id="filedownload-dmchannel"></a>**FileDownload/DMChannel** <a href="" id="filedownload-dmchannel"></a>**FileDownload/DMChannel**
Node to contain child nodes using DM channel for transport protocol. Node to contain child nodes using DM channel for transport protocol.
<a href="" id="filedownload-dmchannel-filecontext"></a>**FileDownload/DMChannel/**<strong>*FileContext*</strong> <a href="" id="filedownload-dmchannel-filecontext"></a>**FileDownload/DMChannel/_FileContext_**
Dynamic interior nodes that represents per log file context. Dynamic interior nodes that represents per log file context.
<a href="" id="filedownload-dmchannel-filecontext-blocksizekb"></a>**FileDownload/DMChannel/*FileContext*/BlockSizeKB** <a href="" id="filedownload-dmchannel-filecontext-blocksizekb"></a>**FileDownload/DMChannel/*FileContext*/BlockSizeKB**
@ -1594,18 +1599,19 @@ Get **BlockData**
<a href="" id="filedownload-dmchannel-filecontext-datablocks"></a>**FileDownload/DMChannel/*FileContext*/DataBlocks** <a href="" id="filedownload-dmchannel-filecontext-datablocks"></a>**FileDownload/DMChannel/*FileContext*/DataBlocks**
Node to transfer the selected log file block to the DM server. Node to transfer the selected log file block to the DM server.
<a href="" id="filedownload-dmchannel-filecontext-datablocks-blocknumber"></a>**FileDownload/DMChannel/*FileContext*/DataBlocks/**<strong>*BlockNumber*</strong> <a href="" id="filedownload-dmchannel-filecontext-datablocks-blocknumber"></a>**FileDownload/DMChannel/*FileContext*/DataBlocks/_BlockNumber_**
The data type is Base64. The data type is Base64.
The supported operation is Get. The supported operation is Get.
### Reading a log file ### Reading a log file
To read a log file: To read a log file:
1. Enumerate log file under **./Vendor/MSFT/DiagnosticLog/FileDownload/DMChannel**. 1. Enumerate log file under **./Vendor/MSFT/DiagnosticLog/FileDownload/DMChannel**.
2. Select a log file in the Enumeration result. 2. Select a log file in the Enumeration result.
3. Set **BlockSizeKB** per DM server payload limitation. 3. Set **BlockSizeKB** per DM server payload limitation.
4. Get **BlockCount** to determine total read request. 4. Get **BlockCount** to determine total read request.
5. Set **BlockIndexToRead** to initialize read start point. 5. Set **BlockIndexToRead** to initialize read start point.
6. Get **BlockData** for upload log block. 6. Get **BlockData** for upload log block.
7. Increase **BlockIndexToRead**. 7. Increase **BlockIndexToRead**.
8. Repeat steps 5 to 7 until **BlockIndexToRead == (BlockIndexToRead – 1)**. 8. Repeat steps 5 to 7 until **BlockIndexToRead == (BlockIndexToRead – 1)**.

31
windows/client-management/mdm/provisioning-csp.md
View File

@ -17,13 +17,13 @@ ms.date: 06/26/2017
The Provisioning configuration service provider is used for bulk user enrollment to an MDM service. The Provisioning configuration service provider is used for bulk user enrollment to an MDM service.
> **Note**  Bulk enrollment does not work when two factor authentication is enabled. > [!NOTE]
> Bulk enrollment does not work when two-factor authentication is enabled.
For bulk enrollment step-by-step guide, see [Bulk enrollment](bulk-enrollment-using-windows-provisioning-tool.md). For bulk enrollment step-by-step guide, see [Bulk enrollment](bulk-enrollment-using-windows-provisioning-tool.md).
The following shows the Provisioning configuration service provider in tree format. The following shows the Provisioning configuration service provider in tree format.
``` ```
./Vendor/MSFT/ProvisioningCommands ./Vendor/MSFT/ProvisioningCommands
ProvisioningCommands ProvisioningCommands
@ -40,13 +40,14 @@ ProvisioningCommands
----------------RestartRequired ----------------RestartRequired
----------------ContinueInstall ----------------ContinueInstall
``` ```
<a href="" id="--vendor-msft"></a>**./Vendor/MSFT**
<a href="" id="--vendor-msft"></a>**./Vendor/MSFT/ProvisioningCommands**
Root node for Provisioning CSP. Root node for Provisioning CSP.
<a href="" id="provisioning-enrollments"></a>**Provisioning/Enrollments** <a href="" id="provisioning-enrollments"></a>**Provisioning/Enrollments**
Node for defining bulk enrollment of users into an MDM service. Node for defining bulk enrollment of users into an MDM service.
<a href="" id="provisioning-enrollments-upn"></a>**Provisioning/Enrollments/**<strong>*UPN*</strong> <a href="" id="provisioning-enrollments-upn"></a>**Provisioning/Enrollments/_UPN_**
Unique identifier for the enrollment. For bulk enrollment, this must a service account that is allowed to enroll multiple users. Example, "generic-device@contoso.com" Unique identifier for the enrollment. For bulk enrollment, this must a service account that is allowed to enroll multiple users. Example, "generic-device@contoso.com"
<a href="" id="provisioning-enrollments-upn-discoveryservicefullurl"></a>**Provisioning/Enrollments/*UPN*/DiscoveryServiceFullURL** <a href="" id="provisioning-enrollments-upn-discoveryservicefullurl"></a>**Provisioning/Enrollments/*UPN*/DiscoveryServiceFullURL**
@ -55,28 +56,18 @@ The full URL for the discovery service.
<a href="" id="provisioning-enrollments-upn-secret"></a>**Provisioning/Enrollments/*UPN*/Secret** <a href="" id="provisioning-enrollments-upn-secret"></a>**Provisioning/Enrollments/*UPN*/Secret**
This information is dependent on the AuthPolicy being used. Possible values: This information is dependent on the AuthPolicy being used. Possible values:
- Password string for on-premises authentication enrollment - Password string for on-premises authentication enrollment
- Federated security token for federated enrollment - Federated security token for federated enrollment
- Certificate thumb print for certificated based enrollment - Certificate thumb print for certificated based enrollment
<a href="" id="provisioning-enrollments-upn-authpolicy"></a>**Provisioning/Enrollments/*UPN*/AuthPolicy** <a href="" id="provisioning-enrollments-upn-authpolicy"></a>**Provisioning/Enrollments/*UPN*/AuthPolicy**
Specifies the authentication policy used by the MDM service. Valid values: Specifies the authentication policy used by the MDM service. Valid values:
- OnPremise - OnPremise
- Certificate - Certificate
<a href="" id="provisioning-enrollments-upn-policyservicefullurl"></a>**Provisioning/Enrollments/*UPN*/PolicyServiceFullURL** <a href="" id="provisioning-enrollments-upn-policyservicefullurl"></a>**Provisioning/Enrollments/*UPN*/PolicyServiceFullURL**
Specifies the policy service URL. Specifies the policy service URL.
<a href="" id="provisioning-enrollments-upn-enrollmentservicefullurl"></a>**Provisioning/Enrollments/*UPN*/EnrollmentServiceFullURL** <a href="" id="provisioning-enrollments-upn-enrollmentservicefullurl"></a>**Provisioning/Enrollments/*UPN*/EnrollmentServiceFullURL**
Specifies the enrollment service URL. Specifies the enrollment service URL.

26
windows/client-management/mdm/proxy-csp.md
View File

@ -17,18 +17,17 @@ ms.date: 06/26/2017
The PROXY configuration service provider is used to configure proxy connections. The PROXY configuration service provider is used to configure proxy connections.
> **Note**  Use [CM\_ProxyEntries CSP](cm-proxyentries-csp.md) instead of PROXY CSP, which will be deprecated in a future release. > [!NOTE]
> Use [CM\_ProxyEntries CSP](cm-proxyentries-csp.md) instead of PROXY CSP, which will be deprecated in a future release.
This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_NETWORKING\_ADMIN capabilities to be accessed from a network configuration application. This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_NETWORKING\_ADMIN capabilities to be accessed from a network configuration application.
For the PROXY CSP, you cannot use the Replace command unless the node already exists. For the PROXY CSP, you cannot use the Replace command unless the node already exists.
The following shows the PROXY configuration service provider management object in tree format as used by OMA DM. The OMA Client Provisioning protocol is not supported by this configuration service provider. The following shows the PROXY configuration service provider management object in tree format as used by OMA DM. The OMA Client Provisioning protocol is not supported by this configuration service provider.
``` ```
./Vendor/MSFT ./Vendor/MSFT/Proxy
Proxy
----* ----*
--------ProxyId --------ProxyId
--------Name --------Name
@ -56,6 +55,7 @@ Proxy
------------Microsoft ------------Microsoft
----------------Guid ----------------Guid
``` ```
<a href="" id="--vendor-msft-proxy"></a>**./Vendor/MSFT/Proxy** <a href="" id="--vendor-msft-proxy"></a>**./Vendor/MSFT/Proxy**
Root node for the proxy connection. Root node for the proxy connection.
@ -90,7 +90,7 @@ Depending on the ProxyID, the valid values are ISA, WAP, SOCKS, or NULL.
<a href="" id="proxyname-ports"></a>***ProxyName*/Ports** <a href="" id="proxyname-ports"></a>***ProxyName*/Ports**
Node for port information. Node for port information.
<a href="" id="proxyname-ports-portname"></a>***ProxyName*/Ports/**<strong>*PortName*</strong> <a href="" id="proxyname-ports-portname"></a>***ProxyName*/Ports/_PortName_**
Defines the name of a port. Defines the name of a port.
It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two ports, use "PORT0" and "PORT1" as the element names. It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two ports, use "PORT0" and "PORT1" as the element names.
@ -101,7 +101,7 @@ Specifies the port number to be associated with the parent port.
<a href="" id="proxyname-ports-portname-services"></a>***ProxyName*/Ports/*PortName*/Services** <a href="" id="proxyname-ports-portname-services"></a>***ProxyName*/Ports/*PortName*/Services**
Node for services information. Node for services information.
<a href="" id="proxyname-ports-services-servicename"></a>***ProxyName*/Ports/Services/**<strong>*ServiceName*</strong> <a href="" id="proxyname-ports-services-servicename"></a>***ProxyName*/Ports/Services/_ServiceName_**
Defines the name of a service. Defines the name of a service.
It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two services, use "SERVICE0" and "SERVICE1" as the element names. It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two services, use "SERVICE0" and "SERVICE1" as the element names.
@ -114,7 +114,7 @@ One commonly used value is "HTTP".
<a href="" id="proxyname-conrefs"></a>***ProxyName*/ConRefs** <a href="" id="proxyname-conrefs"></a>***ProxyName*/ConRefs**
Node for connection reference information Node for connection reference information
<a href="" id="proxyname-conrefs-conrefname"></a>***ProxyName*/ConRefs/**<strong>*ConRefName*</strong> <a href="" id="proxyname-conrefs-conrefname"></a>***ProxyName*/ConRefs/_ConRefName_**
Defines the name of a connection reference. Defines the name of a connection reference.
It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two connection references, use "CONREF0" and "CONREF1" as the element names. It is recommended that this element name is specified as a numbered node beginning at zero. For example, to provision two connection references, use "CONREF0" and "CONREF1" as the element names.
@ -124,14 +124,4 @@ Specifies one single connectivity object associated with the proxy connection.
## Related topics ## Related topics
[Configuration service provider reference](configuration-service-provider-reference.md) [Configuration service provider reference](configuration-service-provider-reference.md)

47
windows/client-management/mdm/update-csp.md
View File

@ -16,13 +16,13 @@ ms.date: 02/23/2018
The Update configuration service provider enables IT administrators to manage and control the rollout of new updates. The Update configuration service provider enables IT administrators to manage and control the rollout of new updates.
> [!Note] > [!NOTE]
> The Update CSP functionality of 'AprrovedUpdates' is not recommended for managing desktop devices. To manage updates to desktop devices from Windows Update, see the [Policy CSP - Updates](policy-csp-update.md) documentation for the recommended policies. > The Update CSP functionality of 'AprrovedUpdates' is not recommended for managing desktop devices. To manage updates to desktop devices from Windows Update, see the [Policy CSP - Updates](policy-csp-update.md) documentation for the recommended policies.
The following shows the Update configuration service provider in tree format. The following shows the Update configuration service provider in tree format.
```./Vendor/MSFT ```
Update ./Vendor/MSFT/Update
----ApprovedUpdates ----ApprovedUpdates
--------Approved Update Guid --------Approved Update Guid
------------ApprovedTime ------------ApprovedTime
@ -50,7 +50,8 @@ Update
--------QualityUpdateStatus --------QualityUpdateStatus
--------FeatureUpdateStatus --------FeatureUpdateStatus
``` ```
<a href="" id="update"></a>**Update**
<a href="" id="update"></a>**./Vendor/MSFT/Update**
<p style="margin-left: 20px">The root node. <p style="margin-left: 20px">The root node.
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -70,7 +71,7 @@ Update
<p style="margin-left: 20px">Supported operations are Get and Add. <p style="margin-left: 20px">Supported operations are Get and Add.
<a href="" id="approvedupdates-approved-update-guid"></a>**ApprovedUpdates/**<strong>*Approved Update Guid*</strong> <a href="" id="approvedupdates-approved-update-guid"></a>**ApprovedUpdates/_Approved Update Guid_**
<p style="margin-left: 20px">Specifies the update GUID. <p style="margin-left: 20px">Specifies the update GUID.
<p style="margin-left: 20px">To auto-approve a class of updates, you can specify the <a href="/previous-versions/windows/desktop/ff357803(v=vs.85)" data-raw-source="[Update Classifications](/previous-versions/windows/desktop/ff357803(v=vs.85))">Update Classifications</a> GUIDs. We strongly recommend to always specify the DefinitionsUpdates classification (E0789628-CE08-4437-BE74-2495B842F43B), which are used for anti-malware signatures. There are released periodically (several times a day). Some businesses may also want to auto-approve security updates to get them deployed quickly. <p style="margin-left: 20px">To auto-approve a class of updates, you can specify the <a href="/previous-versions/windows/desktop/ff357803(v=vs.85)" data-raw-source="[Update Classifications](/previous-versions/windows/desktop/ff357803(v=vs.85))">Update Classifications</a> GUIDs. We strongly recommend to always specify the DefinitionsUpdates classification (E0789628-CE08-4437-BE74-2495B842F43B), which are used for anti-malware signatures. There are released periodically (several times a day). Some businesses may also want to auto-approve security updates to get them deployed quickly.
@ -93,7 +94,7 @@ Update
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
<a href="" id="failedupdates-failed-update-guid"></a>**FailedUpdates/**<strong>*Failed Update Guid*</strong> <a href="" id="failedupdates-failed-update-guid"></a>**FailedUpdates/_Failed Update Guid_**
<p style="margin-left: 20px">Update identifier field of the UpdateIdentity GUID that represent an update that failed to download or install. <p style="margin-left: 20px">Update identifier field of the UpdateIdentity GUID that represent an update that failed to download or install.
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -118,7 +119,7 @@ Update
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
<a href="" id="installedupdates-installed-update-guid"></a>**InstalledUpdates/**<strong>*Installed Update Guid*</strong> <a href="" id="installedupdates-installed-update-guid"></a>**InstalledUpdates/_Installed Update Guid_**
<p style="margin-left: 20px">UpdateIDs that represent the updates installed on a device. <p style="margin-left: 20px">UpdateIDs that represent the updates installed on a device.
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -133,7 +134,7 @@ Update
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
<a href="" id="installableupdates-installable-update-guid"></a>**InstallableUpdates/**<strong>*Installable Update Guid*</strong> <a href="" id="installableupdates-installable-update-guid"></a>**InstallableUpdates/_Installable Update Guid_**
<p style="margin-left: 20px">Update identifiers that represent the updates applicable and not installed on a device. <p style="margin-left: 20px">Update identifiers that represent the updates applicable and not installed on a device.
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -141,9 +142,9 @@ Update
<a href="" id="installableupdates-installable-update-guid-type"></a>**InstallableUpdates/*Installable Update Guid*/Type** <a href="" id="installableupdates-installable-update-guid-type"></a>**InstallableUpdates/*Installable Update Guid*/Type**
<p style="margin-left: 20px">The UpdateClassification value of the update. Valid values are: <p style="margin-left: 20px">The UpdateClassification value of the update. Valid values are:
- 0 - None - 0 - None
- 1 - Security - 1 - Security
- 2 = Critical - 2 - Critical
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -157,7 +158,7 @@ Update
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
<a href="" id="pendingrebootupdates-pending-reboot-update-guid"></a>**PendingRebootUpdates/**<strong>*Pending Reboot Update Guid*</strong> <a href="" id="pendingrebootupdates-pending-reboot-update-guid"></a>**PendingRebootUpdates/_Pending Reboot Update Guid_**
<p style="margin-left: 20px">Update identifiers for the pending reboot state. <p style="margin-left: 20px">Update identifiers for the pending reboot state.
<p style="margin-left: 20px">Supported operation is Get. <p style="margin-left: 20px">Supported operation is Get.
@ -188,26 +189,25 @@ Added in Windows 10, version 1803. Node for the rollback operations.
<a href="" id="rollback-qualityupdate"></a>**Rollback/QualityUpdate** <a href="" id="rollback-qualityupdate"></a>**Rollback/QualityUpdate**
Added in Windows 10, version 1803. Roll back latest Quality Update, if the machine meets the following conditions: Added in Windows 10, version 1803. Roll back latest Quality Update, if the machine meets the following conditions:
- Condition 1: Device must be Windows Update for Business Connected - Condition 1: Device must be Windows Update for Business Connected
- Condition 2: Device must be in a Paused State - Condition 2: Device must be in a Paused State
- Condition 3: Device must have the Latest Quality Update installed on the device (Current State) - Condition 3: Device must have the Latest Quality Update installed on the device (Current State)
If the conditions are not true, the device will not Roll Back the Latest Quality Update. If the conditions are not true, the device will not Roll Back the Latest Quality Update.
<a href="" id="rollback-featureupdate"></a>**Rollback/FeatureUpdate** <a href="" id="rollback-featureupdate"></a>**Rollback/FeatureUpdate**
Added in Windows 10, version 1803. Roll Back Latest Feature Update, if the machine meets the following conditions: Added in Windows 10, version 1803. Roll Back Latest Feature Update, if the machine meets the following conditions:
- Condition 1: Device must be Windows Update for Business Connected - Condition 1: Device must be Windows Update for Business Connected
- Condition 2: Device must be in Paused State - Condition 2: Device must be in Paused State
- Condition 3: Device must have the Latest Feature Update Installed on the device (Current State) - Condition 3: Device must have the Latest Feature Update Installed on the device (Current State)
- Condition 4: Machine should be within the uninstall period - Condition 4: Machine should be within the uninstall period
> [!Note] > [!NOTE]
> This only works for Semi Annual Channel Targeted devices. > This only works for Semi-Annual Channel Targeted devices.
If the conditions are not true, the device will not Roll Back the Latest Feature Update. If the conditions are not true, the device will not Roll Back the Latest Feature Update.
<a href="" id="rollback-qualityupdatestatus"></a>**Rollback/QualityUpdateStatus** <a href="" id="rollback-qualityupdatestatus"></a>**Rollback/QualityUpdateStatus**
Added in Windows 10, version 1803. Returns the result of last RollBack QualityUpdate operation. Added in Windows 10, version 1803. Returns the result of last RollBack QualityUpdate operation.
@ -217,6 +217,3 @@ Added in Windows 10, version 1803. Returns the result of last RollBack FeatureUp
## Related topics ## Related topics
[Configuration service provider reference](configuration-service-provider-reference.md) [Configuration service provider reference](configuration-service-provider-reference.md)

34
windows/client-management/mdm/win32appinventory-csp.md
View File

@ -18,9 +18,9 @@ ms.date: 06/26/2017
The Win32AppInventory configuration service provider is used to provide an inventory of installed applications on a device. The Win32AppInventory configuration service provider is used to provide an inventory of installed applications on a device.
The following shows the Win32AppInventory configuration service provider management objects in tree format as used by Open Mobile Alliance Device Management (OMA DM), OMA Client Provisioning, and Enterprise DM. The following shows the Win32AppInventory configuration service provider management objects in tree format as used by Open Mobile Alliance Device Management (OMA DM), OMA Client Provisioning, and Enterprise DM.
``` ```
./Vendor/MSFT ./Vendor/MSFT/Win32AppInventory
Win32AppInventory
----Win32InstalledProgram ----Win32InstalledProgram
--------InstalledProgram --------InstalledProgram
------------Name ------------Name
@ -32,6 +32,7 @@ Win32AppInventory
------------MsiProductCode ------------MsiProductCode
------------MsiPackageCode ------------MsiPackageCode
``` ```
<a href="" id="--vendor-msft-win32appinventory"></a>**./Vendor/MSFT/Win32AppInventory** <a href="" id="--vendor-msft-win32appinventory"></a>**./Vendor/MSFT/Win32AppInventory**
The root node for the Win32AppInventory configuration service provider. The root node for the Win32AppInventory configuration service provider.
@ -42,30 +43,30 @@ This represents an inventory of installed Win32 applications on the device.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram"></a>**Win32InstalledProgram/**<em>InstalledProgram</em> <a href="" id="win32installedprogram-installedprogram"></a>**Win32InstalledProgram/_InstalledProgram_**
A node that contains information for a specific application. A node that contains information for a specific application.
<a href="" id="win32installedprogram-installedprogram-name"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/Name** <a href="" id="win32installedprogram-installedprogram-name"></a>**Win32InstalledProgram/_InstalledProgram_/Name**
A string that specifies the name of the application. A string that specifies the name of the application.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-publisher"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/Publisher** <a href="" id="win32installedprogram-installedprogram-publisher"></a>**Win32InstalledProgram/_InstalledProgram_/Publisher**
A string that specifies the publisher of the application. A string that specifies the publisher of the application.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-version"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/Version** <a href="" id="win32installedprogram-installedprogram-version"></a>**Win32InstalledProgram/_InstalledProgram_/Version**
A string that specifies the version of the application. A string that specifies the version of the application.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-language"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/Language** <a href="" id="win32installedprogram-installedprogram-language"></a>**Win32InstalledProgram/_InstalledProgram_/Language**
A string that specifies the language of the application. A string that specifies the language of the application.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-regkey"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/RegKey** <a href="" id="win32installedprogram-installedprogram-regkey"></a>**Win32InstalledProgram/_InstalledProgram_/RegKey**
A string that specifies product code or registry subkey. A string that specifies product code or registry subkey.
For MSI-based applications this is the product code. For MSI-based applications this is the product code.
@ -74,32 +75,21 @@ For applications found in Add/Remove Programs, this is the registry subkey.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-source"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/Source** <a href="" id="win32installedprogram-installedprogram-source"></a>**Win32InstalledProgram/_InstalledProgram_/Source**
A string that specifies where the application was discovered, such as MSI or Add/Remove Programs. A string that specifies where the application was discovered, such as MSI or Add/Remove Programs.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-msiproductcode"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/MsiProductCode** <a href="" id="win32installedprogram-installedprogram-msiproductcode"></a>**Win32InstalledProgram/_InstalledProgram_/MsiProductCode**
A GUID that uniquely identifies a particular MSI product. A GUID that uniquely identifies a particular MSI product.
The supported operation is Get. The supported operation is Get.
<a href="" id="win32installedprogram-installedprogram-msipackagecode"></a>**Win32InstalledProgram/**<em>InstalledProgram</em>**/MsiPackageCode** <a href="" id="win32installedprogram-installedprogram-msipackagecode"></a>**Win32InstalledProgram/_InstalledProgram_/MsiPackageCode**
A GUID that identifies an MSI package. Multiple products can make up a single package. A GUID that identifies an MSI package. Multiple products can make up a single package.
The supported operation is Get. The supported operation is Get.
## Related topics ## Related topics
[Configuration service provider reference](configuration-service-provider-reference.md) [Configuration service provider reference](configuration-service-provider-reference.md)