mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-12 05:17:22 +00:00
Merge branch 'main' into v-smandalika-5694287-B12
This commit is contained in:
commit
4fb941a46b
@ -14,20 +14,20 @@ ms.date: 09/18/2018
|
||||
|
||||
# AssignedAccess CSP
|
||||
|
||||
The AssignedAccess configuration service provider (CSP) is used to set the device to run in kiosk mode. Once the CSP has been executed, then the next user login that is associated with the kiosk mode puts the device into the kiosk mode running the application specified in the CSP configuration.
|
||||
The AssignedAccess configuration service provider (CSP) is used to set the device to run in kiosk mode. Once the CSP has been executed, the next user login that is associated with the kiosk mode puts the device into the kiosk mode running the application specified in the CSP configuration.
|
||||
|
||||
For a step-by-step guide for setting up devices to run in kiosk mode, see [Set up a kiosk on Windows 10 Pro, Enterprise, or Education.](/windows/configuration/kiosk-single-app)
|
||||
|
||||
In Windows 10, version 1709, the AssignedAccess configuration service provider (CSP) has been expanded to make it easy for administrators to create kiosks that run more than one app. You can configure multi-app kiosks using a provisioning package. For a step-by-step guide, see [Create a Windows 10 kiosk that runs multiple apps](/windows/configuration/lock-down-windows-10-to-specific-apps).
|
||||
In Windows 10, version 1709, the AssignedAccess configuration service provider (CSP) has been expanded to make it easy for administrators to create kiosks that run more than one app. You can configure multi-app kiosks using a provisioning package. For a step-by-step guide, see [Create a Windows 10 kiosk that runs multiple apps](/windows/configuration/lock-down-windows-10-to-specific-apps).
|
||||
|
||||
> [!Warning]
|
||||
> You can only assign one single app kiosk profile to an individual user account on a device. The single app profile does not support domain groups.
|
||||
|
||||
> [!Note]
|
||||
> If the application calls KeyCredentialManager.IsSupportedAsync when it is running in assigned access mode and it returns false on the first run, invoke the settings screen and select a convenience PIN to use with Windows Hello. This is the settings screen that is hidden by the application running in assigned access mode. You can only use Windows Hello if you first leave assigned access mode, select your convenience pin, and then go back into assigned access mode again.
|
||||
> If the application calls KeyCredentialManager.IsSupportedAsync when it is running in assigned access mode and it returns false on the first run, invoke the settings screen and select a appropriate PIN to use with Windows Hello. This is the settings screen that is hidden by the application running in assigned access mode. You can only use Windows Hello if you first leave assigned access mode, select your convenience pin, and then go back into assigned access mode again.
|
||||
|
||||
> [!Note]
|
||||
> The AssignedAccess CSP is supported in Windows 10 Enterprise and Windows 10 Education. Starting from Windows 10, version 1709 it is also supported in Windows 10 Pro and Windows 10 S. Starting in Windows 10, version 1803, it is also supported in Windows Holographic for Business edition.
|
||||
> The AssignedAccess CSP is supported in Windows 10 Enterprise and Windows 10 Education. Starting from Windows 10, version 1709, it is supported in Windows 10 Pro and Windows 10 S. Starting from Windows 10, version 1803, it is also supported in Windows Holographic for Business edition.
|
||||
|
||||
The following shows the AssignedAccess configuration service provider in tree format
|
||||
|
||||
@ -40,13 +40,14 @@ AssignedAccess
|
||||
----ShellLauncher (Added in Windows 10, version 1803)
|
||||
----StatusConfiguration (Added in Windows 10, version 1803)
|
||||
```
|
||||
|
||||
<a href="" id="--vendor-msft-assignedaccess"></a>**./Device/Vendor/MSFT/AssignedAccess**
|
||||
Root node for the CSP.
|
||||
|
||||
<a href="" id="assignedaccess-kioskmodeapp"></a>**./Device/Vendor/MSFT/AssignedAccess/KioskModeApp**
|
||||
A JSON string that contains the user account name and Application User Model ID (AUMID) of the Kiosk mode app. For more information about how to get the AUMID, see [Find the Application User Model ID of an installed app](/windows-hardware/customize/enterprise/find-the-application-user-model-id-of-an-installed-app).
|
||||
|
||||
For a step-by-step guide for setting up devices to run in kiosk mode, see [Set up a kiosk on Windows 10 Pro, Enterprise, or Education.](/windows/configuration/kiosk-single-app)
|
||||
For more information, see [Set up a kiosk on Windows 10 Pro, Enterprise, or Education.](/windows/configuration/kiosk-single-app)
|
||||
|
||||
> [!Note]
|
||||
> In Windows 10, version 1803 the Configuration node introduces single app kiosk profile to replace KioskModeApp CSP node. KioskModeApp node will be deprecated soon, so you should use the single app kiosk profile in config xml for Configuration node to configure public-facing single app Kiosk.
|
||||
@ -66,42 +67,36 @@ Here's an example:
|
||||
|
||||
> [!Tip]
|
||||
> In this example the double \\\ is required because it's in JSON and JSON escapes \ into \\\\. If an MDM server uses JSON parser\composer, they should ask customers to type only one \\, which will be \\\ in the JSON. If user types \\\\, it'll become \\\\\\\ in JSON, which will cause erroneous results. For the same reason, domain\account used in Configuration xml does not need \\\ but only one \\, because xml does not (need to) escape \\.
|
||||
>
|
||||
> This applies to both domain\account, AzureAD\someone@contoso.onmicrosoft.com, i.e. as long as a \ used in JSON string.
|
||||
>
|
||||
> This applies to both domain\account, AzureAD\someone@contoso.onmicrosoft.com, i.e. as long as a \ used in JSON string.
|
||||
|
||||
When configuring the kiosk mode app, the account name will be used to find the target user. The account name includes domain name and user name.
|
||||
|
||||
> [!Note]
|
||||
> The domain name can be optional if the user name is unique across the system.
|
||||
> The domain name can be optional, if the user name is unique across the system.
|
||||
|
||||
For a local account, the domain name should be the device name. When Get is executed on this node, the domain name is always returned in the output.
|
||||
|
||||
|
||||
The supported operations are Add, Delete, Get and Replace. When there's no configuration, the Get and Delete methods fail. When there's already a configuration for kiosk mode app, the Add method fails. The data pattern for Add and Replace is the same.
|
||||
|
||||
<a href="" id="assignedaccess-configuration"></a>**./Device/Vendor/MSFT/AssignedAccess/Configuration**
|
||||
Added in Windows 10, version 1709. Specifies the settings that you can configure in the kiosk or device. This node accepts an AssignedAccessConfiguration xml as input to configure the device experience. For details about the configuration settings in the XML, see [Create a Windows 10 kiosk that runs multiple apps](/windows/configuration/lock-down-windows-10-to-specific-apps). Here is the schema for the [AssignedAccessConfiguration](#assignedaccessconfiguration-xsd).
|
||||
|
||||
> [!Note]
|
||||
> In Windows 10, version 1803 the Configuration node introduces single app kiosk profile to replace KioskModeApp CSP node. KioskModeApp node will be deprecated soon, so you should use the single app kiosk profile in config xml for Configuration node to configure public-facing single app Kiosk.
|
||||
>
|
||||
> Starting in Windows 10, version 1803 the KioskModeApp node becomes No-Op if Configuration node is configured on the device. That Add/Replace/Delete command on KioskModeApp node always returns SUCCESS to the MDM server if Configuration node is set, but the data of KioskModeApp will not take any effect on the device. Get command on KioskModeApp will return the configured JSON string even it’s not effective.
|
||||
|
||||
Enterprises can use this to easily configure and manage the curated lockdown experience.
|
||||
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
Deleting the multi-app configuration will remove the assigned access lockdown profiles associated with the users, but it cannot revert all the enforced policies back (e.g. Start Layout).
|
||||
Deleting the multi-app configuration will remove the assigned access lockdown profiles associated with the users, but it cannot revert all the enforced policies back (for example, Start Layout).
|
||||
|
||||
<a href="" id="assignedaccess-status"></a>**./Device/Vendor/MSFT/AssignedAccess/Status**
|
||||
Added in Windows 10, version 1803. This read only polling node allows MDM server to query the current KioskModeAppRuntimeStatus as long as the StatusConfiguration node is set to “On” or “OnWithAlerts”. If the StatusConfiguration is “Off”, a node not found error will be reported to the MDM server. Click [link](#status-example) to see an example SyncML. [Here](#assignedaccessalert-xsd) is the schema for the Status payload.
|
||||
|
||||
In Windows 10, version 1803, Assigned Access runtime status only supports monitoring single app kiosk mode. Here are the possible status available for single app kiosk mode.
|
||||
In Windows 10, version 1803, Assigned Access runtime status only supports monitoring single app kiosk mode. Here are the possible statuses available for single app kiosk mode.
|
||||
|
||||
|Status |Description |
|
||||
|---------|---------|---------|
|
||||
| KioskModeAppRunning | This means the kiosk app is running normally. |
|
||||
| KioskModeAppNotFound | This occurs when the kiosk app is not deployed to the machine. |
|
||||
| KioskModeAppNotFound | This occurs when the kiosk app isn't deployed to the machine. |
|
||||
| KioskModeAppActivationFailure | This happens when the assigned access controller detects the process terminated unexpectedly after exceeding the max retry. |
|
||||
|
||||
> [!NOTE]
|
||||
@ -113,7 +108,7 @@ In Windows 10, version 1803, Assigned Access runtime status only supports monito
|
||||
| 2 | KioskModeAppNotFound |
|
||||
| 3 | KioskModeAppActivationFailure |
|
||||
|
||||
Additionally, the status payload includes a profileId that can be used by the MDM server to correlate which kiosk app caused the error.
|
||||
Additionally, the status payload includes a profileId that can be used by the MDM server to correlate as to which kiosk app caused the error.
|
||||
|
||||
In Windows 10, version 1809, Assigned Access runtime status supports monitoring single-app kiosk and multi-app modes. Here are the possible status codes.
|
||||
|
||||
@ -136,27 +131,27 @@ In Windows 10, version 1809, Assigned Access runtime status supports monitoring
|
||||
|
||||
Additionally, the Status payload includes the following fields:
|
||||
|
||||
- profileId: can be used by the MDM server to correlate which account caused the error.
|
||||
- OperationList: list of failed operations that occurred while applying the assigned access CSP, if any exist.
|
||||
- profileId: It can be used by the MDM server to correlate which account caused the error.
|
||||
- OperationList: It gives the list of failed operations that occurred while applying the assigned access CSP, if any exist.
|
||||
|
||||
Supported operation is Get.
|
||||
|
||||
<a href="" id="assignedaccess-shelllauncher"></a>**./Device/Vendor/MSFT/AssignedAccess/ShellLauncher**
|
||||
Added in Windows 10,version 1803. This node accepts a ShellLauncherConfiguration xml as input. Click [link](#shelllauncherconfiguration-xsd) to see the schema. Shell Launcher V2 is introduced in Windows 10, version 1903 to support both UWP and Win32 apps as the custom shell. For more information, see [Shell Launcher](/windows/configuration/kiosk-shelllauncher).
|
||||
Added in Windows 10, version 1803. This node accepts a ShellLauncherConfiguration xml as input. Click [link](#shelllauncherconfiguration-xsd) to see the schema. Shell Launcher V2 is introduced in Windows 10, version 1903 to support both UWP and Win32 apps as the custom shell. For more information, see [Shell Launcher](/windows/configuration/kiosk-shelllauncher).
|
||||
|
||||
> [!Note]
|
||||
> You cannot set both ShellLauncher and KioskModeApp at the same time on the device.
|
||||
>
|
||||
> Configuring Shell Launcher using the ShellLauncher node automatically enables the Shell Launcher feature if it is available within the SKU. I. Shell Launcher as a feature and the ShellLauncher node both require Windows Enterprise or Windows Education to function.
|
||||
> Configuring Shell Launcher using the ShellLauncher node automatically enables the Shell Launcher feature, if it is available within the SKU. I. Shell Launcher as a feature and the ShellLauncher node both require Windows Enterprise or Windows Education to function.
|
||||
>
|
||||
>The ShellLauncher node is not supported in Windows 10 Pro.
|
||||
|
||||
<a href="" id="assignedaccess-statusconfiguration"></a>**./Device/Vendor/MSFT/AssignedAccess/StatusConfiguration**
|
||||
Added in Windows 10, version 1803. This node accepts a StatusConfiguration xml as input to configure the Kiosk App Health monitoring. There are three possible values for StatusEnabled node inside StatusConfiguration xml: On, OnWithAlerts, and Off. Click [link](#statusconfiguration-xsd) to see the StatusConfiguration schema.
|
||||
|
||||
By default the StatusConfiguration node does not exist, and it implies this feature is off. Once enabled via CSP, Assigned Access will check kiosk app status and wait for MDM server to query the latest status from the Status node.
|
||||
By default the StatusConfiguration node doesn't exist, and it implies this feature is off. Once enabled via CSP, Assigned Access will check kiosk app status and wait for MDM server to query the latest status from the Status node.
|
||||
|
||||
Optionally, the MDM server can opt-in to the MDM alert so a MDM alert will be generated and sent immediately to the MDM server when the assigned access runtime status is changed. This MDM alert will contain the status payload that is available via the Status node.
|
||||
Optionally, the MDM server can opt in to the MDM alert, so that MDM alert will be generated and sent immediately to the MDM server when the assigned access runtime status is changed. This MDM alert will contain the status payload that is available via the Status node.
|
||||
|
||||
This MDM alert header is defined as follows:
|
||||
|
||||
@ -431,7 +426,8 @@ Below schema is for AssignedAccess Configuration up to Windows 10 1803 release.
|
||||
</xs:schema>
|
||||
```
|
||||
|
||||
Here is the schema for new features introduced in Windows 10 1809 release
|
||||
Here's the schema for new features introduced in Windows 10 1809 release
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<xs:schema
|
||||
@ -506,7 +502,8 @@ Schema for Windows 10 prerelease
|
||||
</xs:schema>
|
||||
```
|
||||
|
||||
To authorize a compatible configuration XML that includes 1809 or prerelease elements and attributes, always include the namespace of these add-on schemas, and decorate the attributes and elements accordingly with the namespace alias. e.g. to configure auto-launch feature which is added in 1809 release, use below sample, notice an alias r1809 is given to the 201810 namespace for 1809 release, and the alias is tagged on AutoLaunch and AutoLaunchArguments inline.
|
||||
To authorize a compatible configuration XML that includes 1809 or prerelease elements and attributes, always include the namespace of these add-on schemas, and decorate the attributes and elements accordingly with the namespace alias. For example, to configure auto-launch feature, which is added in 1809 release, the below can be used to notice that an alias r1809 is given to the 201810 namespace for 1809 release, and the alias is tagged on AutoLaunch and AutoLaunchArguments inline.
|
||||
|
||||
```xml
|
||||
<AssignedAccessConfiguration
|
||||
xmlns="http://schemas.microsoft.com/AssignedAccess/2017/config"
|
||||
@ -574,11 +571,11 @@ To authorize a compatible configuration XML that includes 1809 or prerelease ele
|
||||
|
||||
## Configuration examples
|
||||
|
||||
XML encoding (escaped) and CDATA of the XML in the Data node both ensure that DM client can properly interpret the SyncML and send the configuration xml as string (in original format, unescaped) to AssignedAccess CSP to handle.
|
||||
XML encoding (escaped) and CDATA of the XML in the Data node will both ensure that DM client can properly interpret the SyncML and send the configuration xml as string (in original format, unescaped) to AssignedAccess CSP to handle.
|
||||
|
||||
Similarly, the StartLayout xml inside the configuration xml is using the same format, xml inside xml as string. In the sample Configuration xml provided above, CDATA is used to embed the StartLayout xml. If you use CDATA to embed configuration xml in SyncML as well, you’ll have nested CDATA so pay attention to how CDATA is used in the provided CDATA sample. With that being said, when the Configuration xml is being constructed, MDM server can either escape start layout xml or put startlayout xml inside CDATA, when MDM server puts configuration xml inside SyncML, MDM server can also either escape it or wrap with CDATA.
|
||||
Similarly, the StartLayout xml inside the configuration xml is using the same format, xml inside xml as string. In the sample Configuration xml provided above, CDATA is used to embed the StartLayout xml. If you use CDATA to embed configuration xml in SyncML as well, you’ll have nested CDATA, so pay attention to how CDATA is used in the provided CDATA sample. With that being said, when the Configuration xml is being constructed, MDM server can either escape start layout xml or put startlayout xml inside CDATA, when MDM server puts configuration xml inside SyncML, MDM server can also either escape it or wrap with CDATA.
|
||||
|
||||
Escape and CDATA are mechanisms when handling xml in xml. Consider it’s a transportation channel to send the configuration xml as payload from server to client. It’s transparent to both end user who configures the CSP and transparent to our CSP. Both the customer on the server side and our CSP must only see the original configuration XML.
|
||||
Escape and CDATA are mechanisms when handling xml in xml. Consider it’s a transportation channel to send the configuration xml as payload from server to client. It’s transparent to both, the end user who configures the CSP and to our CSP. Both the customer on the server side and our CSP must only see the original configuration XML.
|
||||
|
||||
This example shows escaped XML of the Data node.
|
||||
|
||||
@ -894,8 +891,8 @@ StatusConfiguration Add OnWithAlerts
|
||||
</SyncML>
|
||||
```
|
||||
|
||||
|
||||
StatusConfiguration Delete
|
||||
|
||||
```xml
|
||||
<SyncML xmlns='SYNCML:SYNCML1.2'>
|
||||
<SyncBody>
|
||||
@ -962,6 +959,7 @@ StatusConfiguration Replace On
|
||||
## Status example
|
||||
|
||||
Status Get
|
||||
|
||||
```xml
|
||||
<SyncML xmlns='SYNCML:SYNCML1.2'>
|
||||
<SyncBody>
|
||||
@ -1478,4 +1476,8 @@ This example configures the following apps: Skype, Learning, Feedback Hub, and C
|
||||
</Config>
|
||||
</Configs>
|
||||
</AssignedAccessConfiguration>
|
||||
```
|
||||
```
|
||||
|
||||
## Related topics
|
||||
|
||||
[Configuration service provider reference](configuration-service-provider-reference.md)
|
@ -66,7 +66,7 @@ The XML below is for Windows 10, version 1803.
|
||||
|
||||
Example: {"User":"domain\\user", "AUMID":"Microsoft.WindowsCalculator_8wekyb3d8bbwe!App"}.
|
||||
|
||||
When configuring kiosk mode app, account name will be used to find the target user. Account name includes domain name and user name. Domain name can be optional if user name is unique across the system. For a local account, domain name should be machine name. When "Get" is executed on this node, domain name is always returned in the output.
|
||||
When configuring kiosk mode app, account name will be used to find the target user. Account name includes domain name and user name. Domain name can be optional, if user name is unique across the system. For a local account, domain name should be machine name. When "Get" is executed on this node, domain name is always returned in the output.
|
||||
|
||||
This node supports Add, Delete, Replace and Get methods. When there's no configuration, "Get" and "Delete" methods fail. When there's already a configuration for kiosk mode app, "Add" method fails. The data pattern for "Add" and "Replace" is the same.</Description>
|
||||
<DFFormat>
|
||||
@ -119,7 +119,7 @@ This node supports Add, Delete, Replace and Get methods. When there's no configu
|
||||
<AccessType>
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>This read only node contains kiosk health event xml</Description>
|
||||
<Description>This read only node contains kiosk health event in xml</Description>
|
||||
<DFFormat>
|
||||
<chr />
|
||||
</DFFormat>
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -19,7 +19,7 @@ The CellularSettings configuration service provider is used to configure cellula
|
||||
> [!Note]
|
||||
> Starting in Windows 10, version 1703 the CellularSettings CSP is supported in Windows 10 Home, Pro, Enterprise, and Education editions.
|
||||
|
||||
The following shows the CellularSettings CSP in tree format as used by Open Mobile Alliance Client Provisioning (OMA CP). The OMA DM protocol is not supported with this configuration service provider.
|
||||
The following shows the CellularSettings CSP in tree format as used by Open Mobile Alliance Client Provisioning (OMA CP). The OMA DM protocol isn't supported with this configuration service provider.
|
||||
|
||||
```console
|
||||
./Vendor/MSFT
|
||||
@ -36,6 +36,6 @@ CellularSettings
|
||||
|1|Don’t roam (or Domestic roaming if applicable)|
|
||||
|2|Roam|
|
||||
|
||||
## Related topics
|
||||
## Related topics
|
||||
|
||||
[Configuration service provider reference](configuration-service-provider-reference.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: CertificateStore CSP
|
||||
description: Use the The CertificateStore configuration service provider (CSP) to add secure socket layers (SSL), intermediate, and self-signed certificates.
|
||||
description: Use the CertificateStore configuration service provider (CSP) to add secure socket layers (SSL), intermediate, and self-signed certificates.
|
||||
ms.assetid: 0fe28629-3cc3-42a0-91b3-3624c8462fd3
|
||||
ms.reviewer:
|
||||
manager: dansimp
|
||||
@ -14,15 +14,12 @@ ms.date: 02/28/2020
|
||||
|
||||
# CertificateStore CSP
|
||||
|
||||
|
||||
The CertificateStore configuration service provider is used to add secure socket layers (SSL), intermediate, and self-signed certificates.
|
||||
|
||||
> [!Note]
|
||||
> The CertificateStore configuration service provider does not support installing client certificates.
|
||||
> The Microsoft protocol version of Open Mobile Alliance (OMA) is case insensitive.
|
||||
|
||||
|
||||
|
||||
For the CertificateStore CSP, you cannot use the Replace command unless the node already exists.
|
||||
|
||||
The following shows the CertificateStore configuration service provider management object in tree format as used by both Open Mobile Alliance Device Management (OMA DM) and OMA Client Provisioning.
|
||||
@ -106,6 +103,7 @@ CertificateStore
|
||||
----------------ValidTo
|
||||
----------------TemplateName
|
||||
```
|
||||
|
||||
<a href="" id="root-system"></a>**Root/System**
|
||||
Defines the certificate store that contains root, or self-signed, certificates.
|
||||
|
||||
@ -114,8 +112,6 @@ Supported operation is Get.
|
||||
> [!NOTE]
|
||||
> Root/System is case sensitive. Please use the RootCATrustedCertificates CSP moving forward for installing root certificates.
|
||||
|
||||
|
||||
|
||||
<a href="" id="ca-system"></a>**CA/System**
|
||||
Defines the certificate store that contains cryptographic information, including intermediary certification authorities.
|
||||
|
||||
@ -124,8 +120,6 @@ Supported operation is Get.
|
||||
> [!NOTE]
|
||||
> CA/System is case sensitive. Please use the RootCATrustedCertificates CSP moving forward for installing CA certificates.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-user"></a>**My/User**
|
||||
Defines the certificate store that contains public keys for client certificates. This is only used by enterprise servers to push down the public key of a client certificate. The client certificate is used by the device client to authenticate itself to the enterprise server for device management and downloading enterprise applications.
|
||||
|
||||
@ -134,8 +128,6 @@ Supported operation is Get.
|
||||
> [!NOTE]
|
||||
> My/User is case sensitive.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-system"></a>**My/System**
|
||||
Defines the certificate store that contains public key for client certificate. This is only used by enterprise server to push down the public key of the client cert. The client cert is used by the device to authenticate itself to the enterprise server for device management and enterprise app downloading.
|
||||
|
||||
@ -144,15 +136,13 @@ Supported operation is Get.
|
||||
> [!NOTE]
|
||||
> My/System is case sensitive.
|
||||
|
||||
|
||||
|
||||
<a href="" id="certhash"></a>***CertHash***
|
||||
Defines the SHA1 hash for the certificate. The 20-byte value of the SHA1 certificate hash is specified as a hexadecimal string value.
|
||||
|
||||
Supported operations are Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="certhash-encodedcertificate"></a>***CertHash*/EncodedCertificate**
|
||||
Required. Specifies the X.509 certificate as a Base64-encoded string. The Base-64 string value cannot include extra formatting characters such as embedded linefeeds, etc.
|
||||
Required. Specifies the X.509 certificate as a Base64-encoded string. The Base-64 string value can’t include extra formatting characters such as embedded linefeeds, etc.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
@ -189,23 +179,19 @@ Supported operation is Get.
|
||||
> [!NOTE]
|
||||
> Please use the ClientCertificateInstall CSP to install SCEP certificates moving forward. All enhancements to SCEP will happen in that CSP.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-scep-uniqueid"></a>**My/SCEP/**<strong>*UniqueID*</strong>
|
||||
Required for SCEP certificate enrollment. A unique ID to differentiate certificate enrollment requests. Format is node.
|
||||
|
||||
Supported operations are Get, Add, Replace, and Delete.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install"></a>**My/SCEP/*UniqueID*/Install**
|
||||
Required for SCEP certificate enrollment. Parent node to group SCEP certificate install related request. Format is node.
|
||||
Required for SCEP certificate enrollment. Parent node to group SCEP certificate installs related request. Format is node.
|
||||
|
||||
Supported operations are Add, Replace, and Delete.
|
||||
|
||||
> [!NOTE]
|
||||
> Though the children nodes under Install support Replace commands, after the Exec command is sent to the device, the device takes the values that are set when the Exec command is accepted. You should not expect the node value change that occurs after the Exec command is accepted to impact the current undergoing enrollment. You should check the Status node value and make sure that the device is not at an unknown stage before changing the children node values.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-serverurl"></a>**My/SCEP/*UniqueID*/Install/ServerURL**
|
||||
Required for SCEP certificate enrollment. Specifies the certificate enrollment server. The server could specify multiple server URLs separated by a semicolon. Value type is string.
|
||||
|
||||
@ -219,12 +205,12 @@ Supported operations are Get, Add, Replace, and Delete.
|
||||
Challenge will be deleted shortly after the Exec command is accepted.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-ekumapping"></a>**My/SCEP/*UniqueID*/Install/EKUMapping**
|
||||
Required. Specifies the extended key usages and subject to SCEP server configuration. The list of OIDs are separated by a plus sign **+**, such as OID1+OID2+OID3. Value type is chr.
|
||||
Required. Specifies the extended key usages and subject to SCEP server configuration. The list of OIDs is separated by a plus sign **+**, such as OID1+OID2+OID3. Value type is chr.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-keyusage"></a>**My/SCEP/*UniqueID*/Install/KeyUsage**
|
||||
Required for enrollment. Specifies the key usage bits (0x80, 0x20, 0xA0, etc.) for the certificate in decimal format. The value should at least have second (0x20) or fourth (0x80) or both bits set. If the value does not have those bits set, configuration will fail. Value type is an integer.
|
||||
Required for enrollment. Specifies the key usage bits (0x80, 0x20, 0xA0, etc.) for the certificate in decimal format. The value should at least have second (0x20) or fourth (0x80) or both bits set. If the value doesn't have those bits set, configuration will fail. Value type is an integer.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
@ -233,22 +219,22 @@ Required. Specifies the subject name.
|
||||
|
||||
The SubjectName value is quoted if it contains leading or trailing white space or one of the following characters: (“,” “=” “+” “;” ).
|
||||
|
||||
For more details, see [CertNameToStrA function](/windows/win32/api/wincrypt/nf-wincrypt-certnametostra#remarks).
|
||||
For more information, see [CertNameToStrA function](/windows/win32/api/wincrypt/nf-wincrypt-certnametostra#remarks).
|
||||
|
||||
Value type is chr.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-keyprotection"></a>**My/SCEP/*UniqueID*/Install/KeyProtection**
|
||||
Optional. Specifies the location of the private key. Although the private key is protected by TPM, it is not protected with TPM PIN. SCEP enrolled certificate does not support TPM PIN protection.
|
||||
Optional. Specifies the location of the private key. Although the private key is protected by TPM, it isn't protected with TPM PIN. SCEP enrolled certificate doesn't support TPM PIN protection.
|
||||
|
||||
Supported values are one of the following:
|
||||
|
||||
- 1 – Private key is protected by device TPM.
|
||||
- 1 – Private key is protected by device TPM.
|
||||
|
||||
- 2 – Private key is protected by device TPM if the device supports TPM.
|
||||
- 2 – Private key is protected by device TPM if the device supports TPM.
|
||||
|
||||
- 3 (default) – Private key is only saved in the software KSP.
|
||||
- 3 (default) – Private key is only saved in the software KSP.
|
||||
|
||||
Value type is an integer.
|
||||
|
||||
@ -260,12 +246,15 @@ Optional. Specifies the device retry waiting time in minutes when the SCEP serve
|
||||
Supported operations are Get, Add, and Delete.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-retrycount"></a>**My/SCEP/*UniqueID*/Install/RetryCount**
|
||||
Optional. Special to SCEP. Specifies the device retry times when the SCEP server sends pending status. Value type is an integer. Default value is 3. Max value cannot be larger than 30. If it is larger than 30, the device will use 30. The min value is 0, which means no retry.
|
||||
Optional. Special to SCEP. Specifies the device retry times when the SCEP server sends pending status. Value type is an integer. Default value is 3. Max value can’t be larger than 30. If it's larger than 30, the device will use 30. The min value is 0, which means no retry.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-templatename"></a>**My/SCEP/*UniqueID*/Install/TemplateName**
|
||||
Optional. OID of certificate template name. Note that this name is typically ignored by the SCEP server; therefore, the MDM server typically does not need to provide it. Value type is chr.
|
||||
Optional. OID of certificate template name.
|
||||
|
||||
>[!Note]
|
||||
> Template name is typically ignored by the SCEP server; therefore, the MDM server typically doesn't need to provide it. Value type is chr.
|
||||
|
||||
Supported operations are Get, Add, and Delete.
|
||||
|
||||
@ -282,7 +271,7 @@ Value type is chr.
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-cathumbprint"></a>**My/SCEP/*UniqueID*/Install/CAThumbprint**
|
||||
Required. Specifies the root CA thumbprint. It is a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value. When client authenticates the SCEP server, it checks CA certificate from SCEP server for a match with this certificate. If it does not match, the authentication fails. Value type is chr.
|
||||
Required. Specifies the root CA thumbprint. It's a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value. When client authenticates the SCEP server, it checks CA certificate from SCEP server for a match with this certificate. If it doesn't match, the authentication fails. Value type is chr.
|
||||
|
||||
Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
@ -298,15 +287,13 @@ Supported operations are Get, Add, Delete, and Replace.
|
||||
|
||||
Valid values are one of the following:
|
||||
|
||||
- Days (default)
|
||||
- Months
|
||||
- Years
|
||||
- Days (default)
|
||||
- Months
|
||||
- Years
|
||||
|
||||
> [!NOTE]
|
||||
> The device only sends the MDM server expected certificate validation period (ValidPeriodUnits + ValidPeriod) of the SCEP server as part of certificate enrollment request. How this valid period is used to create the certificate depends on the MDM server.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-validperiodunits"></a>**My/SCEP/*UniqueID*/Install/ValidPeriodUnits**
|
||||
Optional. Specifies desired number of units used in validity period and subject to SCEP server configuration. Default is 0. The units are defined in ValidPeriod node. The valid period specified by MDM overwrites the valid period specified in the certificate template. For example, if ValidPeriod is days and ValidPeriodUnits is 30, it means the total valid duration is 30 days. Value type is an integer.
|
||||
|
||||
@ -315,10 +302,8 @@ Supported operations are Get, Add, Delete, and Replace.
|
||||
> [!NOTE]
|
||||
> The device only sends the MDM server expected certificate validation period (ValidPeriodUnits + ValidPeriod) of the SCEP server as part of certificate enrollment request. How this valid period is used to create the certificate depends on the MDM server.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-scep-uniqueid-install-enroll"></a>**My/SCEP/*UniqueID*/Install/Enroll**
|
||||
Required. Triggers the device to start the certificate enrollment. The MDM server can later query the device to find out whether the new certificate is added. Value type is null, which means that this node does not contain a value.
|
||||
Required. Triggers the device to start the certificate enrollment. The MDM server can later query the device to find out whether the new certificate is added. Value type is null, which means that this node doesn't contain a value.
|
||||
|
||||
Supported operation is Exec.
|
||||
|
||||
@ -336,7 +321,7 @@ Valid values are one of the following:
|
||||
|
||||
- 1 – Finished successfully.
|
||||
|
||||
- 2 – Pending. The device has not finished the action, but has received the SCEP server pending response.
|
||||
- 2 – Pending. The device hasn't finished the action, but has received the SCEP server pending response.
|
||||
|
||||
- 16 - Action failed.
|
||||
|
||||
@ -348,7 +333,7 @@ Optional. The integer value that indicates the HRESULT of the last enrollment er
|
||||
Supported operation is Get.
|
||||
|
||||
<a href="" id="my-scep-uniqueid-certthumbprint"></a>**My/SCEP/*UniqueID*/CertThumbprint**
|
||||
Optional. Specifies the current certificate thumbprint if certificate enrollment succeeds. It is a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value. Value type is chr.
|
||||
Optional. Specifies the current certificate thumbprint if certificate enrollment succeeds. It's a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value. Value type is chr.
|
||||
|
||||
Supported operation is Get.
|
||||
|
||||
@ -358,7 +343,7 @@ Required. Returns the URL of the SCEP server that responded to the enrollment re
|
||||
Supported operation is Get.
|
||||
|
||||
<a href="" id="my-wstep"></a>**My/WSTEP**
|
||||
Required for MDM enrolled device. The parent node that hosts the MDM enrollment client certificate related settings that is enrolled via WSTEP. The nodes under WSTEP are mostly for MDM client certificate renew requests. Value type is node.
|
||||
Required for MDM enrolled device. The parent node that hosts the MDM enrollment client certificate related settings that are enrolled via WSTEP. The nodes under WSTEP are mostly for MDM client certificate renew requests. Value type is node.
|
||||
|
||||
Supported operation is Get.
|
||||
|
||||
@ -368,7 +353,7 @@ Optional. The parent node to group renewal related settings.
|
||||
Supported operation is Get.
|
||||
|
||||
<a href="" id="my-wstep-renew-serverurl"></a>**My/WSTEP/Renew/ServerURL**
|
||||
Optional. Specifies the URL of certificate renewal server. If this node does not exist, the client uses the initial certificate enrollment URL.
|
||||
Optional. Specifies the URL of certificate renewal server. If this node doesn't exist, the client uses the initial certificate enrollment URL.
|
||||
|
||||
> [!NOTE]
|
||||
> The renewal process follows the same steps as device enrollment, which means that it starts with Discovery service, followed by Enrollment policy service, and then Enrollment web service.
|
||||
@ -378,7 +363,7 @@ Optional. Specifies the URL of certificate renewal server. If this node does not
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="my-wstep-renew-renewalperiod"></a>**My/WSTEP/Renew/RenewalPeriod**
|
||||
Optional. The time (in days) to trigger the client to initiate the MDM client certificate renew process before the MDM certificate expires. The MDM server cannot set and update the renewal period. This parameter applies to both manual certificate renewal and request on behalf of (ROBO) certificate renewal. It is recommended that the renew period is set a couple of months before the certificate expires to ensure that the certificate gets renewed successfully with data connectivity.
|
||||
Optional. The time (in days) to trigger the client to initiate the MDM client certificate renew process before the MDM certificate expires. The MDM server cannot set and update the renewal period. This parameter applies to both manual certificate renewal and request on behalf of (ROBO) certificate renewal. It's recommended that the renew period is set a couple of months before the certificate expires to ensure that the certificate gets renewed successfully with data connectivity.
|
||||
|
||||
The default value is 42 and the valid values are 1 – 1000. Value type is an integer.
|
||||
|
||||
@ -387,8 +372,6 @@ Supported operations are Add, Get, Delete, and Replace.
|
||||
> [!NOTE]
|
||||
> When you set the renewal schedule over SyncML DM commands to ROBOSupport, RenewalPeriod, and RetryInterval, you must wrap them in Atomic commands.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-wstep-renew-retryinterval"></a>**My/WSTEP/Renew/RetryInterval**
|
||||
Optional. Specifies the retry interval (in days) when the previous renewal failed. It applies to both manual certificate renewal and ROBO automatic certificate renewal. The retry schedule stops at the certificate expiration date.
|
||||
|
||||
@ -403,8 +386,6 @@ Supported operations are Add, Get, Delete, and Replace.
|
||||
> [!NOTE]
|
||||
> When you set the renewal schedule over SyncML DM commands to ROBOSupport, RenewalPeriod, and RetryInterval, you must wrap them in Atomic commands.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-wstep-renew-robosupport"></a>**My/WSTEP/Renew/ROBOSupport**
|
||||
Optional. Notifies the client if the MDM enrollment server supports ROBO auto certificate renewal. Value type is bool.
|
||||
|
||||
@ -415,8 +396,6 @@ Supported operations are Add, Get, Delete, and Replace.
|
||||
> [!NOTE]
|
||||
> When you set the renewal schedule over SyncML DM commands to ROBOSupport, RenewalPeriod, and RetryInterval, you must wrap them in Atomic commands.
|
||||
|
||||
|
||||
|
||||
<a href="" id="my-wstep-renew-status"></a>**My/WSTEP/Renew/Status**
|
||||
Required. Shows the latest action status for this certificate. Value type is an integer.
|
||||
|
||||
@ -424,13 +403,10 @@ Supported operation is Get.
|
||||
|
||||
Supported values are one of the following:
|
||||
|
||||
- 0 – Not started.
|
||||
|
||||
- 1 – Renewal in progress.
|
||||
|
||||
- 2 – Renewal succeeded.
|
||||
|
||||
- 3 – Renewal failed.
|
||||
- 0 – Not started.
|
||||
- 1 – Renewal in progress.
|
||||
- 2 – Renewal succeeded.
|
||||
- 3 – Renewal failed.
|
||||
|
||||
<a href="" id="my-wstep-renew-errorcode"></a>**My/WSTEP/Renew/ErrorCode**
|
||||
Optional. If certificate renewal fails, this integer value indicates the HRESULT of the last error code during the renewal process. Value type is an integer.
|
||||
@ -454,7 +430,6 @@ Supported operations are Add, Get, and Replace.
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
Add a root certificate to the MDM server.
|
||||
|
||||
```xml
|
||||
|
@ -16,12 +16,14 @@ manager: dansimp
|
||||
The CleanPC configuration service provider (CSP) allows removal of user-installed and pre-installed applications, with the option to persist user data. This CSP was added in Windows 10, version 1703.
|
||||
|
||||
The following shows the CleanPC configuration service provider in tree format.
|
||||
|
||||
```
|
||||
./Device/Vendor/MSFT
|
||||
CleanPC
|
||||
----CleanPCWithoutRetainingUserData
|
||||
----CleanPCRetainingUserData
|
||||
```
|
||||
|
||||
<a href="" id="--device-vendor-msft-cleanpc"></a>**./Device/Vendor/MSFT/CleanPC**
|
||||
<p>The root node for the CleanPC configuration service provider.</p>
|
||||
|
||||
@ -34,3 +36,7 @@ CleanPC
|
||||
<p>An integer specifying a CleanPC operation with retention of user data.
|
||||
|
||||
<p>The only supported operation is Execute.
|
||||
|
||||
## Related topics
|
||||
|
||||
[Configuration service provider reference](configuration-service-provider-reference.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: CleanPC DDF
|
||||
description: This topic shows the OMA DM device description framework (DDF) for the CleanPC configuration service provider. DDF files are used only with OMA DM provisioning XML.
|
||||
description: Learn about the OMA DM device description framework (DDF) for the CleanPC configuration service provider. DDF files are used only with OMA DM provisioning XML.
|
||||
ms.assetid: A2182898-1577-4675-BAE5-2A3A9C2AAC9B
|
||||
ms.reviewer:
|
||||
manager: dansimp
|
||||
|
@ -16,7 +16,7 @@ ms.date: 07/30/2021
|
||||
|
||||
The ClientCertificateInstall configuration service provider enables the enterprise to install client certificates. A client certificate has a unique ID, which is the *\[UniqueID\]* for this configuration. Each client certificate must have different UniqueIDs for the SCEP enrollment request.
|
||||
|
||||
For PFX certificate installation and SCEP installation, the SyncML commands must be wrapped in atomic commands to ensure enrollment execution is not triggered until all settings are configured. The Enroll command must be the last item in the atomic block.
|
||||
For PFX certificate installation and SCEP installation, the SyncML commands must be wrapped in atomic commands to ensure that enrollment execution isn't triggered until all settings are configured. The Enroll command must be the last item in the atomic block.
|
||||
|
||||
> [!Note]
|
||||
> Currently in Windows 10, version 1511, when using the ClientCertificateInstall to install certificates to the device store and the user store and both certificates are sent to the device in the same MDM payload, the certificate intended for the device store will also get installed in the user store. This may cause issues with Wi-Fi or VPN when choosing the correct certificate to establish a connection. We are working to fix this issue.
|
||||
@ -24,6 +24,7 @@ For PFX certificate installation and SCEP installation, the SyncML commands must
|
||||
You can only set PFXKeyExportable to true if KeyLocation=3. For any other KeyLocation value, the CSP will fail.
|
||||
|
||||
The following shows the ClientCertificateInstall configuration service provider in tree format.
|
||||
|
||||
```
|
||||
./Vendor/MSFT
|
||||
ClientCertificateInstall
|
||||
@ -65,6 +66,7 @@ ClientCertificateInstall
|
||||
------------ErrorCode
|
||||
------------RespondentServerUrl
|
||||
```
|
||||
|
||||
<a href="" id="device-or-user"></a>**Device or User**
|
||||
For device certificates, use <strong>./Device/Vendor/MSFT</strong> path and for user certificates use <strong>./User/Vendor/MSFT</strong> path.
|
||||
|
||||
@ -95,12 +97,12 @@ The data type is an integer corresponding to one of the following values:
|
||||
| Value | Description |
|
||||
|-------|---------------------------------------------------------------------------------------------------------------|
|
||||
| 1 | Install to TPM if present, fail if not present. |
|
||||
| 2 | Install to TPM if present. If not present, fallback to software. |
|
||||
| 2 | Install to TPM if present. If not present, fall back to software. |
|
||||
| 3 | Install to software. |
|
||||
| 4 | Install to Windows Hello for Business (formerly known as Microsoft Passport for Work) whose name is specified |
|
||||
|
||||
<a href="" id="clientcertificateinstall-pfxcertinstall-uniqueid-containername"></a>**ClientCertificateInstall/PFXCertInstall/*UniqueID*/ContainerName**
|
||||
Optional. Specifies the Windows Hello for Business (formerly known as Microsoft Passport for Work) container name (if Windows Hello for Business storage provider (KSP) is chosen for the KeyLocation). If this node is not specified when Windows Hello for Business KSP is chosen, enrollment will fail.
|
||||
Optional. Specifies the Windows Hello for Business (formerly known as Microsoft Passport for Work) container name (if Windows Hello for Business storage provider (KSP) is chosen for the KeyLocation). If this node isn't specified when Windows Hello for Business KSP is chosen, enrollment will fail.
|
||||
|
||||
Date type is string.
|
||||
|
||||
@ -115,7 +117,7 @@ Supported operations are Get, Add, and Replace.
|
||||
|
||||
If a blob already exists, the Add operation will fail. If Replace is called on this node, the existing certificates are overwritten.
|
||||
|
||||
If Add is called on this node for a new PFX, the certificate will be added. When a certificate does not exist, Replace operation on this node will fail.
|
||||
If Add is called on this node for a new PFX, the certificate will be added. When a certificate doesn't exist, Replace operation on this node will fail.
|
||||
|
||||
In other words, using Replace or Add will result in the effect of either overwriting the old certificate or adding a new certificate CRYPT_DATA_BLOB, which can be found in <a href="/previous-versions/windows/desktop/legacy/aa381414(v=vs.85)" data-raw-source="[CRYPT\_INTEGER\_BLOB](/previous-versions/windows/desktop/legacy/aa381414(v=vs.85))">CRYPT_INTEGER_BLOB</a>.
|
||||
|
||||
@ -131,7 +133,7 @@ Optional. Used to specify whether the PFX certificate password is encrypted with
|
||||
|
||||
The data type is int. Valid values:
|
||||
|
||||
- 0 - Password is not encrypted.
|
||||
- 0 - Password isn't encrypted.
|
||||
- 1 - Password is encrypted with the MDM certificate.
|
||||
- 2 - Password is encrypted with custom certificate.
|
||||
|
||||
@ -140,7 +142,7 @@ When PFXCertPasswordEncryptionType =2, you must specify the store name in PFXCer
|
||||
Supported operations are Get, Add, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-pfxcertinstall-uniqueid-pfxkeyexportable"></a>**ClientCertificateInstall/PFXCertInstall/*UniqueID*/PFXKeyExportable**
|
||||
Optional. Used to specify if the private key installed is exportable (and can be exported later). The PFX is not exportable when it is installed to TPM.
|
||||
Optional. Used to specify if the private key installed is exportable (and can be exported later). The PFX isn't exportable when it's installed to TPM.
|
||||
|
||||
> [!Note]
|
||||
> You can only set PFXKeyExportable to true if KeyLocation=3. For any other KeyLocation value, the CSP will fail.
|
||||
@ -202,7 +204,7 @@ Data type is string.
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-scep-uniqueid-install-ekumapping"></a>**ClientCertificateInstall/SCEP/*UniqueID*/Install/EKUMapping**
|
||||
Required. Specifies extended key usages. Subject to SCEP server configuration. The list of OIDs are separated by a plus <strong>+</strong>. For example, <em>OID1</em>+<em>OID2</em>+<em>OID3</em>.
|
||||
Required. Specifies extended key usages. Subject to SCEP server configuration. The list of OIDs is separated by a plus <strong>+</strong>. For example, <em>OID1</em>+<em>OID2</em>+<em>OID3</em>.
|
||||
|
||||
Data type is string.
|
||||
|
||||
@ -213,7 +215,7 @@ Required. Specifies the subject name.
|
||||
|
||||
The SubjectName value is quoted if it contains leading or trailing white space or one of the following characters: (“,” “=” “+” “;” ).
|
||||
|
||||
For more details, see [CertNameToStrA function](/windows/win32/api/wincrypt/nf-wincrypt-certnametostra#remarks).
|
||||
For more information, see [CertNameToStrA function](/windows/win32/api/wincrypt/nf-wincrypt-certnametostra#remarks).
|
||||
|
||||
Data type is string.
|
||||
|
||||
@ -330,7 +332,10 @@ Valid values are:
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-scep-uniqueid-install-validperiodunits"></a>**ClientCertificateInstall/SCEP/*UniqueID*/Install/ValidPeriodUnits**
|
||||
Optional. Specifies the desired number of units used in the validity period. This is subject to SCEP server configuration. Default value is 0. The unit type (days, months, or years) are defined in the ValidPeriod node. Note the valid period specified by MDM will overwrite the valid period specified in the certificate template. For example, if ValidPeriod is Days and ValidPeriodUnits is 30, it means the total valid duration is 30 days.
|
||||
Optional. Specifies the desired number of units used in the validity period. This is subject to SCEP server configuration. Default value is 0. The unit type (days, months, or years) is defined in the ValidPeriod node.
|
||||
|
||||
>[!Note]
|
||||
> The valid period specified by MDM will overwrite the valid period specified in the certificate template. For example, if ValidPeriod is Days and ValidPeriodUnits is 30, it means the total valid duration is 30 days.
|
||||
|
||||
Data type is string.
|
||||
|
||||
@ -340,7 +345,7 @@ Data type is string.
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-scep-uniqueid-install-containername"></a>**ClientCertificateInstall/SCEP/*UniqueID*/Install/ContainerName**
|
||||
Optional. Specifies the Windows Hello for Business container name (if Windows Hello for Business KSP is chosen for the node). If this node is not specified when Windows Hello for Business KSP is chosen, the enrollment will fail.
|
||||
Optional. Specifies the Windows Hello for Business container name (if Windows Hello for Business KSP is chosen for the node). If this node isn't specified when Windows Hello for Business KSP is chosen, the enrollment will fail.
|
||||
|
||||
Data type is string.
|
||||
|
||||
@ -354,7 +359,7 @@ Data type is string.
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-scep-uniqueid-install-enroll"></a>**ClientCertificateInstall/SCEP/*UniqueID*/Install/Enroll**
|
||||
Required. Triggers the device to start the certificate enrollment. The device will not notify MDM server after certificate enrollment is done. The MDM server could later query the device to find out whether new certificate is added.
|
||||
Required. Triggers the device to start the certificate enrollment. The device won't notify MDM server after certificate enrollment is done. The MDM server could later query the device to find out whether new certificate is added.
|
||||
|
||||
The date type format is Null, meaning this node doesn’t contain a value.
|
||||
|
||||
@ -368,7 +373,7 @@ Data type is string.
|
||||
Supported operations are Add, Get, Delete, and Replace.
|
||||
|
||||
<a href="" id="clientcertificateinstall-scep-uniqueid-certthumbprint"></a>**ClientCertificateInstall/SCEP/*UniqueID*/CertThumbprint**
|
||||
Optional. Specifies the current certificate’s thumbprint if certificate enrollment succeeds. It is a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value.
|
||||
Optional. Specifies the current certificate’s thumbprint if certificate enrollment succeeds. It's a 20-byte value of the SHA1 certificate hash specified as a hexadecimal string value.
|
||||
|
||||
If the certificate on the device becomes invalid (Cert expired, Cert chain is not valid, private key deleted) then it will return an empty string.
|
||||
|
||||
|
@ -49,26 +49,26 @@ CM_CellularEntries
|
||||
```
|
||||
|
||||
<a href="" id="entryname"></a>***entryname***
|
||||
<p>Defines the name of the connection.</p>
|
||||
Defines the name of the connection.</p>
|
||||
|
||||
<p>The <a href="cmpolicy-csp.md" data-raw-source="[CMPolicy configuration service provider](cmpolicy-csp.md)">CMPolicy configuration service provider</a> uses the value of <em>entryname</em> to identify the connection that is associated with a policy and <a href="cm-proxyentries-csp.md" data-raw-source="[CM\_ProxyEntries configuration service provider](cm-proxyentries-csp.md)">CM_ProxyEntries configuration service provider</a> uses the value of <em>entryname</em> to identify the connection that is associated with a proxy.</p>
|
||||
The [CMPolicy configuration service provider](cmpolicy-csp.md) uses the value of *entryname* to identify the connection that is associated with a policy and [CM\_ProxyEntries configuration service provider](cm-proxyentries-csp.md) uses the value of *entryname* to identify the connection that is associated with a proxy.</p>
|
||||
|
||||
<a href="" id="alwayson"></a>**AlwaysOn**
|
||||
<p>Type: Int. Specifies if the Connection Manager will automatically attempt to connect to the APN when a connection is available.
|
||||
Type: Int. Specifies if the Connection Manager will automatically attempt to connect to the APN when a connection is available.
|
||||
|
||||
<p>A value of "0" specifies that AlwaysOn is not supported, and the Connection Manager will only attempt to connect to the APN when an application requests the connection. This setting is recommended for applications that use a connection occasionally, for example, an APN that only controls MMS.
|
||||
A value of "0" specifies that AlwaysOn is not supported, and the Connection Manager will only attempt to connect to the APN when an application requests the connection. This setting is recommended for applications that use a connection occasionally, for example, an APN that only controls MMS.
|
||||
|
||||
<p>A value of "1" specifies that AlwaysOn is supported, and the Connection Manager will automatically attempt to connect to the APN when it is available. This setting is recommended for general purpose Internet APNs.
|
||||
A value of "1" specifies that AlwaysOn is supported, and the Connection Manager will automatically attempt to connect to the APN when it is available. This setting is recommended for general purpose Internet APNs.
|
||||
|
||||
<p>There must be at least one AlwaysOn Internet connection provisioned for the mobile operator.
|
||||
There must be at least one AlwaysOn Internet connection provisioned for the mobile operator.
|
||||
|
||||
<a href="" id="authtype"></a>**AuthType**
|
||||
<p>Optional. Type: String. Specifies the method of authentication used for a connection.
|
||||
Optional. Type: String. Specifies the method of authentication used for a connection.
|
||||
|
||||
<p>A value of "CHAP" specifies the Challenge Handshake Application Protocol. A value of "PAP" specifies the Password Authentication Protocol. A value of "None" specifies that the UserName and Password parameters are ignored. The default value is "None".
|
||||
A value of "CHAP" specifies the Challenge Handshake Application Protocol. A value of "PAP" specifies the Password Authentication Protocol. A value of "None" specifies that the UserName and Password parameters are ignored. The default value is "None".
|
||||
|
||||
<a href="" id="connectiontype"></a>**ConnectionType**
|
||||
<p>Optional. Type: String. Specifies the type of connection used for the APN. The following connection types are available:
|
||||
Optional. Type: String. Specifies the type of connection used for the APN. The following connection types are available:
|
||||
|
||||
|Connection type|Usage|
|
||||
|--- |--- |
|
||||
@ -79,125 +79,118 @@ CM_CellularEntries
|
||||
|Lte_iwlan|Used for GPRS type connections that may be offloaded over WiFi|
|
||||
|Iwlan|Used for connections that are implemented over WiFi offload only|
|
||||
|
||||
|
||||
|
||||
<a href="" id="desc-langid"></a>**Desc.langid**
|
||||
<p>Optional. Specifies the UI display string used by the defined language ID.
|
||||
Optional. Specifies the UI display string used by the defined language ID.
|
||||
|
||||
<p> A parameter name in the format of Desc.langid will be used as the language-specific identifier for the specified entry. For example, a parameter defined as <code>Desc.0409</code> with a value of <code>"GPRS Connection"</code> will force "GPRS Connection" to be displayed in the UI to represent this connection when the device is set to English language (language ID 0409). Descriptions for multiple languages may be provisioned using this mechanism, and the system will automatically switch among them if the user changes language preferences on the device. If no <strong>Desc</strong> parameter is provisioned for a given language, the system will default to the name used to create the entry.
|
||||
A parameter name in the format of Desc.langid will be used as the language-specific identifier for the specified entry. For example, a parameter defined as <code>Desc.0409</code> with a value of <code>"GPRS Connection"</code> will force "GPRS Connection" to be displayed in the UI to represent this connection when the device is set to English language (language ID 0409). Descriptions for multiple languages may be provisioned using this mechanism, and the system will automatically switch among them if the user changes language preferences on the device. If no <strong>Desc</strong> parameter is provisioned for a given language, the system will default to the name used to create the entry.
|
||||
|
||||
<a href="" id="enabled"></a>**Enabled**
|
||||
<p> Specifies if the connection is enabled.
|
||||
Specifies if the connection is enabled.
|
||||
|
||||
<p> A value of "0" specifies that the connection is disabled. A value of "1" specifies that the connection is enabled.
|
||||
A value of "0" specifies that the connection is disabled. A value of "1" specifies that the connection is enabled.
|
||||
|
||||
<a href="" id="ipheadercompression"></a>**IpHeaderCompression**
|
||||
<p> Optional. Specifies if IP header compression is enabled.
|
||||
Optional. Specifies if IP header compression is enabled.
|
||||
|
||||
<p> A value of "0" specifies that IP header compression for the connection is disabled. A value of "1" specifies that IP header compression for the connection is enabled.
|
||||
A value of "0" specifies that IP header compression for the connection is disabled. A value of "1" specifies that IP header compression for the connection is enabled.
|
||||
|
||||
<a href="" id="password"></a>**Password**
|
||||
<p> Required if AuthType is set to a value other than "None". Specifies the password used to connect to the APN.
|
||||
Required if AuthType is set to a value other than "None". Specifies the password used to connect to the APN.
|
||||
|
||||
<a href="" id="swcompression"></a>**SwCompression**
|
||||
<p> Optional. Specifies if software compression is enabled.
|
||||
Optional. Specifies if software compression is enabled.
|
||||
|
||||
<p> A value of "0" specifies that software compression for the connection is disabled. A value of "1" specifies that software compression for the connection is enabled.
|
||||
A value of "0" specifies that software compression for the connection is disabled. A value of "1" specifies that software compression for the connection is enabled.
|
||||
|
||||
<a href="" id="username"></a>**UserName**
|
||||
<p> Required if AuthType is set to a value other than "None". Specifies the user name used to connect to the APN.
|
||||
Required if AuthType is set to a value other than "None". Specifies the user name used to connect to the APN.
|
||||
|
||||
<a href="" id="userequiresmappingspolicy"></a>**UseRequiresMappingsPolicy**
|
||||
<p> Optional. Specifies if the connection requires a corresponding mappings policy.
|
||||
Optional. Specifies if the connection requires a corresponding mappings policy.
|
||||
|
||||
<p> A value of "0" specifies that the connection can be used for any general Internet communications. A value of "1" specifies that the connection is only used if a mapping policy is present.
|
||||
A value of "0" specifies that the connection can be used for any general Internet communications. A value of "1" specifies that the connection is only used if a mapping policy is present.
|
||||
|
||||
<p> For example, if the multimedia messaging service (MMS) APN should not have any other traffic except MMS, you can configure a mapping policy that sends MMS traffic to this connection. Then, you set the value of UseRequiresMappingsPolicy to be equal to "1" and Connection Manager will only use the connection for MMS traffic. Without this, Connection Manager will try to use the connection for any general purpose Internet traffic.
|
||||
For example, if the multimedia messaging service (MMS) APN should not have any other traffic except MMS, you can configure a mapping policy that sends MMS traffic to this connection. Then, you set the value of UseRequiresMappingsPolicy to be equal to "1" and Connection Manager will only use the connection for MMS traffic. Without this, Connection Manager will try to use the connection for any general purpose Internet traffic.
|
||||
|
||||
<a href="" id="version"></a>**Version**
|
||||
<p> Type: Int. Specifies the XML version number and is used to verify that the XML is supported by Connection Manager's configuration service provider.
|
||||
Type: Int. Specifies the XML version number and is used to verify that the XML is supported by Connection Manager's configuration service provider.
|
||||
|
||||
<p> This value must be "1" if included.
|
||||
This value must be "1" if included.
|
||||
|
||||
<a href="" id="gprsinfoaccesspointname"></a>**GPRSInfoAccessPointName**
|
||||
<p> Specifies the logical name to select the GPRS gateway. For more information about allowable values, see GSM specification 07.07 "10.1.1 Define PDP Context +CGDCONT".
|
||||
Specifies the logical name to select the GPRS gateway. For more information about allowable values, see GSM specification 07.07 "10.1.1 Define PDP Context +CGDCONT".
|
||||
|
||||
<a href="" id="roaming"></a>**Roaming**
|
||||
<p> Optional. Type: Int. This parameter specifies the roaming conditions under which the connection should be activated. The following conditions are available:
|
||||
Optional. Type: Int. This parameter specifies the roaming conditions under which the connection should be activated. The following conditions are available:
|
||||
|
||||
- 0 - Home network only.
|
||||
- 1 (default)- All roaming conditions (home and roaming).
|
||||
- 2 - Home and domestic roaming only.
|
||||
- 3 - Domestic roaming only.
|
||||
- 4 - Non-domestic roaming only.
|
||||
- 5 - Roaming only.
|
||||
- 0 - Home network only.
|
||||
- 1 (default)- All roaming conditions (home and roaming).
|
||||
- 2 - Home and domestic roaming only.
|
||||
- 3 - Domestic roaming only.
|
||||
- 4 - Non-domestic roaming only.
|
||||
- 5 - Roaming only.
|
||||
|
||||
<a href="" id="oemconnectionid"></a>**OEMConnectionID**
|
||||
<p> Optional. Type: GUID. Specifies a GUID to use to identify a specific connection in the modem. If a value is not specified, the default value is 00000000-0000-0000-0000-000000000000. This parameter is only used on LTE devices.
|
||||
Optional. Type: GUID. Specifies a GUID to use to identify a specific connection in the modem. If a value isn't specified, the default value is 00000000-0000-0000-0000-000000000000. This parameter is only used on LTE devices.
|
||||
|
||||
<a href="" id="apnid"></a>**ApnId**
|
||||
<p> Optional. Type: Int. Specifies the purpose of the APN. If a value is not specified, the default value is "0" (none). This parameter is only used on LTE devices.
|
||||
Optional. Type: Int. Specifies the purpose of the APN. If a value isn't specified, the default value is "0" (none). This parameter is only used on LTE devices.
|
||||
|
||||
<a href="" id="iptype"></a>**IPType**
|
||||
<p> Optional. Type: String. Specifies the network protocol of the connection. Available values are "IPv4", "IPv6", "IPv4v6", and "IPv4v6xlat". If a value is not specified, the default value is "IPv4".
|
||||
Optional. Type: String. Specifies the network protocol of the connection. Available values are "IPv4", "IPv6", "IPv4v6", and "IPv4v6xlat". If a value isn't specified, the default value is "IPv4".
|
||||
|
||||
> [!WARNING]
|
||||
> Do not use IPv6 or IPv4v6xlat on a device or network that does not support IPv6. Data functionality will not work. In addition, the device will not be able to connect to a roaming network that does not support IPv6 unless you configure roaming connections with an IPType of IPv4v6.
|
||||
|
||||
|
||||
|
||||
<a href="" id="exemptfromdisablepolicy"></a>**ExemptFromDisablePolicy**
|
||||
<p> Added back in Windows 10, version 1511. Optional. Type: Int. This should only be specified for special purpose connections whose applications directly manage their disable state (such as MMS). A value of "0" specifies that the connection is subject to the disable policy used by general purpose connections (not exempt). A value of "1" specifies that the connection is exempt. If a value is not specified, the default value is "0" (not exempt).
|
||||
Added back in Windows 10, version 1511.Optional. Type: Int. This should only be specified for special purpose connections whose applications directly manage their disable state (such as MMS). A value of "0" specifies that the connection is subject to the disable policy used by general purpose connections (not exempt). A value of "1" specifies that the connection is exempt. If a value isn't specified, the default value is "0" (not exempt).
|
||||
|
||||
<p> To allow MMS when data is set to OFF, set both ExemptFromDisablePolicy and UseRequiresMappingsPolicy to "1". This indicates that the connection is a dedicated MMS connection and that it should not be disabled when all other connections are disabled. As a result, MMS can be sent and received when data is set to OFF. Note that sending MMS while roaming is still not allowed.
|
||||
To allow MMS when data is set to OFF, set both ExemptFromDisablePolicy and UseRequiresMappingsPolicy to "1". This indicates that the connection is a dedicated MMS connection and that it shouldn't be disabled when all other connections are disabled. As a result, MMS can be sent and received when data is set to OFF.
|
||||
|
||||
>[!Note]
|
||||
> Sending MMS while roaming is still not allowed.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Do not set ExemptFromDisablePolicy to "1", ExemptFromRoaming to "1", or UseRequiresMappingsPolicy to "1" for general purpose connections.
|
||||
|
||||
<p> To avoid UX inconsistency with certain value combinations of ExemptFromDisablePolicy and AllowMmsIfDataIsOff, when you do not set ExemptFromDisablePolicy to 1 (default is 0), you should:
|
||||
To avoid UX inconsistency with certain value combinations of ExemptFromDisablePolicy and AllowMmsIfDataIsOff, when you do not set ExemptFromDisablePolicy to 1 (default is 0), you should:
|
||||
|
||||
- Hide the toggle for AllowMmsIfDataIsOff by setting AllowMmsIfDataIsOffEnabled to 0 (default is 1)
|
||||
- Set AllowMMSIfDataIsOff to 1 (default is 0)
|
||||
|
||||
|
||||
- Hide the toggle for AllowMmsIfDataIsOff by setting AllowMmsIfDataIsOffEnabled to 0 (default is 1)
|
||||
- Set AllowMMSIfDataIsOff to 1 (default is 0)
|
||||
|
||||
<a href="" id="exemptfromroaming"></a>**ExemptFromRoaming**
|
||||
<p> Added back in Windows 10, version 1511. Optional. Type: Int. This should be specified only for special purpose connections whose applications directly manage their roaming state. It should never be used with general purpose connections. A value of "0" specifies that the connection is subject to the roaming policy (not exempt). A value of "1" specifies that the connection is exempt (unaffected by the roaming policy). If a value is not specified, the default value is "0" (not exempt).
|
||||
Added back in Windows 10, version 1511.Optional. Type: Int. This should be specified only for special purpose connections whose applications directly manage their roaming state. It should never be used with general purpose connections. A value of "0" specifies that the connection is subject to the roaming policy (not exempt). A value of "1" specifies that the connection is exempt (unaffected by the roaming policy). If a value is not specified, the default value is "0" (not exempt).
|
||||
|
||||
<a href="" id="tetheringnai"></a>**TetheringNAI**
|
||||
<p> Optional. Type: Int. CDMA only. Specifies if the connection is a tethering connection. A value of "0" specifies that the connection is not a tethering connection. A value of "1" specifies that the connection is a tethering connection. If a value is not specified, the default value is "0".
|
||||
Optional. Type: Int. CDMA only. Specifies if the connection is a tethering connection. A value of "0" specifies that the connection is not a tethering connection. A value of "1" specifies that the connection is a tethering connection. If a value is not specified, the default value is "0".
|
||||
|
||||
<a href="" id="idledisconnecttimeout"></a>**IdleDisconnectTimeout**
|
||||
<p> Optional. Type: Int. Specifies how long an on-demand connection can be unused before Connection Manager tears the connection down. This value is specified in seconds. Valid value range is 5 to 60 seconds. If not specified, the default is 30 seconds.
|
||||
Optional. Type: Int. Specifies how long an on-demand connection can be unused before Connection Manager tears the connection down. This value is specified in seconds. Valid value range is 5 to 60 seconds. If not specified, the default is 30 seconds.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> <p> You must specify the IdleDisconnectTimeout value when updating an on-demand connection to ensure that the desired value is still configured. If it is not specified, the default value of 30 seconds may be used.
|
||||
|
||||
> You must specify the IdleDisconnectTimeout value when updating an on-demand connection to ensure that the desired value is still configured. If it is not specified, the default value of 30 seconds may be used.
|
||||
|
||||
> [!NOTE]
|
||||
> If tear-down/activation requests occur too frequently, this value should be set to greater than 5 seconds.
|
||||
|
||||
|
||||
|
||||
<a href="" id="simiccid"></a>**SimIccId**
|
||||
<p> For single SIM phones, this parm is optional. However, it is highly recommended to include this value when creating future updates. For dual SIM phones, this parm is required. Type: String. Specifies the SIM ICCID that services the connection.
|
||||
For single SIM phones, this parm isOptional. However, it is highly recommended to include this value when creating future updates. For dual SIM phones, this parm is required. Type: String. Specifies the SIM ICCID that services the connection.
|
||||
|
||||
<a href="" id="purposegroups"></a>**PurposeGroups**
|
||||
<p> Required. Type: String. Specifies the purposes of the connection by a comma-separated list of GUIDs representing purpose values. The following purpose values are available:
|
||||
Required. Type: String. Specifies the purposes of the connection by a comma-separated list of GUIDs representing purpose values. The following purpose values are available:
|
||||
|
||||
- Internet - 3E5545D2-1137-4DC8-A198-33F1C657515F
|
||||
- LTE attach - 11A6FE68-5B47-4859-9CB6-1EAC96A8F0BD
|
||||
- MMS - 53E2C5D3-D13C-4068-AA38-9C48FF2E55A8
|
||||
- IMS - 474D66ED-0E4B-476B-A455-19BB1239ED13
|
||||
- SUPL - 6D42669F-52A9-408E-9493-1071DCC437BD
|
||||
- Purchase - 95522B2B-A6D1-4E40-960B-05E6D3F962AB
|
||||
- Administrative - 2FFD9261-C23C-4D27-8DCF-CDE4E14A3364
|
||||
- Application - 52D7654A-00A8-4140-806C-087D66705306
|
||||
- eSIM provisioning - A36E171F-2377-4965-88FE-1F53EB4B47C0
|
||||
- Internet - 3E5545D2-1137-4DC8-A198-33F1C657515F
|
||||
- LTE attach - 11A6FE68-5B47-4859-9CB6-1EAC96A8F0BD
|
||||
- MMS - 53E2C5D3-D13C-4068-AA38-9C48FF2E55A8
|
||||
- IMS - 474D66ED-0E4B-476B-A455-19BB1239ED13
|
||||
- SUPL - 6D42669F-52A9-408E-9493-1071DCC437BD
|
||||
- Purchase - 95522B2B-A6D1-4E40-960B-05E6D3F962AB
|
||||
- Administrative - 2FFD9261-C23C-4D27-8DCF-CDE4E14A3364
|
||||
- Application - 52D7654A-00A8-4140-806C-087D66705306
|
||||
- eSIM provisioning - A36E171F-2377-4965-88FE-1F53EB4B47C0
|
||||
|
||||
## Additional information
|
||||
|
||||
|
||||
To delete a connection, you must first delete any associated proxies and then delete the connection. The following example shows how to delete the proxy and then the connection.
|
||||
|
||||
```xml
|
||||
@ -213,7 +206,6 @@ To delete a connection, you must first delete any associated proxies and then de
|
||||
|
||||
## OMA client provisioning examples
|
||||
|
||||
|
||||
Configuring a GPRS connection:
|
||||
|
||||
```xml
|
||||
|
@ -23,7 +23,7 @@ The CMPolicy configuration service provider defines rules that the Connection Ma
|
||||
|
||||
Each policy entry identifies one or more applications in combination with a host pattern. The policy entry is assigned a list of connection details that Connection Manager uses to satisfy connection requests matching the application and host patterns. CMPolicy configuration service provider can have multiple policies
|
||||
|
||||
**Policy Ordering**: There is no explicit ordering of policies. The general rule is that the most concrete or specific policy mappings take a higher precedence.
|
||||
**Policy Ordering**: There's no explicit ordering of policies. The general rule is that the most concrete or specific policy mappings take a higher precedence.
|
||||
|
||||
**Default Policies**: Policies are applied in order of their scope with the most specific policies considered before the more general policies. The phone’s default behavior applies to all applications and all domains and is only used when no other, more specific policy is available. The default policy is to use any available Wi-Fi network first and then any available APN.
|
||||
|
||||
@ -60,19 +60,19 @@ Specifies the mapping policy type.
|
||||
|
||||
The following list describes the available mapping policy types:
|
||||
|
||||
- Application-based mapping policies are applied to applications. To specify this mapping type, use the value `app`.
|
||||
- Application-based mapping policies are applied to applications. To specify this mapping type, use the value `app`.
|
||||
|
||||
- Host-based mapping policies are applied to all types of clients requesting connections to specified host(s). To specify this mapping type, use the value `*`.
|
||||
- Host-based mapping policies are applied to all types of clients requesting connections to specified host(s). To specify this mapping type, use the value `*`.
|
||||
|
||||
<a href="" id="host"></a>**Host**
|
||||
Specifies the name of a host pattern. The host name is matched to the connection request to select the right policy to use.
|
||||
|
||||
The host pattern can have two wild cards, "\*" and "+". The host pattern is not a URL pattern and there is no concept of transport or paths on the specific host. For example, the host pattern might be "\*.host\_name.com" to match any prefix to the host\_name.com domains. The host pattern will match "www.host\_name.com" and "mail.host\_name.com", but it will not match "host\_name.com".
|
||||
The host pattern can have two wild cards, "\*" and "+". The host pattern is not a URL pattern and there's no concept of transport or paths on the specific host. For example, the host pattern might be "\*.host\_name.com" to match any prefix to the host\_name.com domains. The host pattern will match "www.host\_name.com" and "mail.host\_name.com", but it will not match "host\_name.com".
|
||||
|
||||
<a href="" id="orderedconnections"></a>**OrderedConnections**
|
||||
Specifies whether the list of connections is in preference order.
|
||||
|
||||
A value of "0" specifies that the connections are not listed in order of preference. A value of "1" indicates that the listed connections are in order of preference.
|
||||
A value of "0" specifies that the connections aren't listed in order of preference. A value of "1" indicates that the listed connections are in order of preference.
|
||||
|
||||
<a href="" id="connxxx"></a>**Conn**<strong>*XXX*</strong>
|
||||
Enumerates the connections associated with the policy. Element names begin with "Conn" followed by three digits, which increment starting from "000". For example, a policy, which applied to five connections would have element entries named "Conn000", "Conn001", "Conn002", "Conn003", and "Conn004".
|
||||
@ -93,7 +93,6 @@ For `CMST_CONNECTION_TYPE`, specify the GUID for the desired connection type. Th
|
||||
|Wi-Fi|{8568B401-858E-4B7B-B3DF-0FD4927F131B}|
|
||||
|Wi-Fi hotspot|{072FC7DC-1D93-40D1-9BB0-2114D7D73434}|
|
||||
|
||||
|
||||
For `CMST_CONNECTION_NETWORK_TYPE`, specify the GUID for the desired network type. The curly brackets {} around the GUID are required. The following network types are available:
|
||||
|
||||
|Network type|GUID|
|
||||
@ -112,7 +111,6 @@ For `CMST_CONNECTION_NETWORK_TYPE`, specify the GUID for the desired network typ
|
||||
|Ethernet 10 Mbps|{97D3D1B3-854A-4C32-BD1C-C13069078370}|
|
||||
|Ethernet 100 Mbps|{A8F4FE66-8D04-43F5-9DD2-2A85BD21029B}|
|
||||
|Ethernet Gbps|{556C1E6B-B8D4-448E-836D-9451BA4CCE75}|
|
||||
|
||||
|
||||
For `CMST_CONNECTION_DEVICE_TYPE`, specify the GUID for the desired device type. The curly brackets {} around the GUID are required. The following device types are available:
|
||||
|
||||
@ -123,18 +121,16 @@ For `CMST_CONNECTION_DEVICE_TYPE`, specify the GUID for the desired device type.
|
||||
|Bluetooth|{1D793123-701A-4fd0-B6AE-9C3C57E99C2C}|
|
||||
|Virtual|{EAA02CE5-9C70-4E87-97FE-55C9DEC847D4}|
|
||||
|
||||
|
||||
|
||||
<a href="" id="type"></a>**Type**
|
||||
Specifies the type of connection being referenced. The following list describes the available connection types:
|
||||
|
||||
- `CMST_CONNECTION_NAME` – A connection specified by name.
|
||||
- `CMST_CONNECTION_NAME` – A connection specified by name.
|
||||
|
||||
- `CMST_CONNECTION_TYPE` – Any connection of a specified type.
|
||||
- `CMST_CONNECTION_TYPE` – Any connection of a specified type.
|
||||
|
||||
- `CMST_CONNECTION_NETWORK_TYPE` – Any connection of a specified network type.
|
||||
- `CMST_CONNECTION_NETWORK_TYPE` – Any connection of a specified network type.
|
||||
|
||||
- `CMST_CONNECTION_DEVICE_TYPE` – Any connection of the specified device type.
|
||||
- `CMST_CONNECTION_DEVICE_TYPE` – Any connection of the specified device type.
|
||||
|
||||
## OMA client provisioning examples
|
||||
|
||||
@ -232,7 +228,6 @@ Adding a host-based mapping policy. In this example, the ConnectionId for type C
|
||||
|
||||
## OMA DM examples
|
||||
|
||||
|
||||
Adding an application-based mapping policy:
|
||||
|
||||
```xml
|
||||
|
@ -14,17 +14,14 @@ ms.date: 06/26/2017
|
||||
|
||||
# CMPolicyEnterprise CSP
|
||||
|
||||
|
||||
The CMPolicyEnterprise configuration service provider is used by the enterprise to define rules that the Connection Manager uses to identify the correct connection for a connection request.
|
||||
|
||||
> [!NOTE]
|
||||
> This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_NETWORKING\_ADMIN capabilities to be accessed from a network configuration application.
|
||||
|
||||
|
||||
|
||||
Each policy entry identifies one or more applications in combination with a host pattern. The policy entry is assigned a list of connection details that Connection Manager uses to satisfy connection requests matching the application and host patterns. CMPolicyEnterprise configuration service provider can have multiple policies
|
||||
|
||||
**Policy Ordering**: There is no explicit ordering of policies. The general rule is that the most concrete or specific policy mappings take a higher precedence.
|
||||
**Policy Ordering**: There's no explicit ordering of policies. The general rule is that the most concrete or specific policy mappings take a higher precedence.
|
||||
|
||||
**Default Policies**: Policies are applied in order of their scope with the most specific policies considered before the more general policies. The phone’s default behavior applies to all applications and all domains and is only used when no other, more specific policy is available. The default policy is to use any available Wi-Fi network first and then any available APN.
|
||||
|
||||
@ -60,9 +57,9 @@ Specifies the mapping policy type.
|
||||
|
||||
The following list describes the available mapping policy types:
|
||||
|
||||
- Application-based mapping policies are applied to applications. To specify this mapping type, use the value `app`.
|
||||
- Application-based mapping policies are applied to applications. To specify this mapping type, use the value `app`.
|
||||
|
||||
- Host-based mapping policies are applied to all types of clients requesting connections to specified host(s). To specify this mapping type, use the value `*`.
|
||||
- Host-based mapping policies are applied to all types of clients requesting connections to specified host(s). To specify this mapping type, use the value `*`.
|
||||
|
||||
<a href="" id="host"></a>**Host**
|
||||
Specifies the name of a host pattern. The host name is matched to the connection request to select the right policy to use.
|
||||
@ -72,10 +69,10 @@ The host pattern can have two wild cards, "\*" and "+". The host pattern is not
|
||||
<a href="" id="orderedconnections"></a>**OrderedConnections**
|
||||
Specifies whether the list of connections is in preference order.
|
||||
|
||||
A value of "0" specifies that the connections are not listed in order of preference. A value of "1" indicates that the listed connections are in order of preference.
|
||||
A value of "0" specifies that the connections aren't listed in order of preference. A value of "1" indicates that the listed connections are in order of preference.
|
||||
|
||||
<a href="" id="connxxx"></a>**Conn**<strong>*XXX*</strong>
|
||||
Enumerates the connections associated with the policy. Element names begin with "Conn" followed by three digits which increment starting from "000". For example, a policy which applied to five connections would have element entries named "Conn000", "Conn001", "Conn002", "Conn003", and "Conn004".
|
||||
Enumerates the connections associated with the policy. Element names begin with "Conn" followed by three digits that increment starting from "000". For example, a policy which is applied to five connections would have element entries named "Conn000", "Conn001", "Conn002", "Conn003", and "Conn004".
|
||||
|
||||
<a href="" id="connectionid"></a>**ConnectionID**
|
||||
Specifies a unique identifier for a connection within a group of connections. The exact value is based on the Type parameter.
|
||||
@ -126,13 +123,13 @@ For `CMST_CONNECTION_DEVICE_TYPE`, specify the GUID for the desired device type.
|
||||
<a href="" id="type"></a>**Type**
|
||||
Specifies the type of connection being referenced. The following list describes the available connection types:
|
||||
|
||||
- `CMST_CONNECTION_NAME` – A connection specified by name.
|
||||
- `CMST_CONNECTION_NAME` – A connection specified by name.
|
||||
|
||||
- `CMST_CONNECTION_TYPE` – Any connection of a specified type.
|
||||
- `CMST_CONNECTION_TYPE` – Any connection of a specified type.
|
||||
|
||||
- `CMST_CONNECTION_NETWORK_TYPE` – Any connection of a specified device type.
|
||||
- `CMST_CONNECTION_NETWORK_TYPE` – Any connection of a specified device type.
|
||||
|
||||
- `CMST_CONNECTION_DEVICE_TYPE` – Any connection of the specified network type.
|
||||
- `CMST_CONNECTION_DEVICE_TYPE` – Any connection of the specified network type.
|
||||
|
||||
## OMA client provisioning examples
|
||||
|
||||
|
@ -75,6 +75,7 @@ Defender
|
||||
--------EngineUpdatesChannel (Added with the 4.18.2106.5 Defender platform release)
|
||||
--------SecurityIntelligenceUpdatesChannel (Added with the 4.18.2106.5 Defender platform release)
|
||||
--------DisableGradualRelease (Added with the 4.18.2106.5 Defender platform release)
|
||||
--------PassiveRemediation (Added with the 4.18.2202.X Defender platform release)
|
||||
----Scan
|
||||
----UpdateSignature
|
||||
----OfflineScan (Added in Windows 10 version 1803)
|
||||
@ -821,6 +822,16 @@ More details:
|
||||
- [Manage the gradual rollout process for Microsoft Defender updates](/microsoft-365/security/defender-endpoint/manage-gradual-rollout)
|
||||
- [Create a custom gradual rollout process for Microsoft Defender updates](/microsoft-365/security/defender-endpoint/configure-updates)
|
||||
|
||||
<a href="" id="configuration-passiveremediation"></a>**Configuration/PassiveRemediation**
|
||||
This policy setting enables or disables EDR in block mode (recommended for devices running Microsoft Defender Antivirus in passive mode). For more information, see Endpoint detection and response in block mode | Microsoft Docs. Available with platform release: 4.18.2202.X
|
||||
|
||||
The data type is integer
|
||||
|
||||
Supported values:
|
||||
- 1: Turn EDR in block mode on
|
||||
- 0: Turn EDR in block mode off
|
||||
|
||||
|
||||
<a href="" id="scan"></a>**Scan**
|
||||
Node that can be used to start a Windows Defender scan on a device.
|
||||
|
||||
|
@ -655,12 +655,13 @@ The following list shows the supported values:
|
||||
|
||||
<!--/Scope-->
|
||||
<!--Description-->
|
||||
Don't search the web or display web results in Search.
|
||||
Don't search the web or display web results in Search, or show search highlights in the search box or in search home.
|
||||
|
||||
This policy setting allows you to control whether or not Search can perform queries on the web, and if the web results are displayed in Search.
|
||||
If you enable this policy setting, queries won't be performed on the web and web results won't be displayed when a user performs a query in Search.
|
||||
This policy setting allows you to control whether or not Search can perform queries on the web, if web results are displayed in Search, and if search highlights are shown in the search box and in search home.
|
||||
|
||||
If you disable this policy setting, queries will be performed on the web and web results will be displayed when a user performs a query in Search.
|
||||
- If you enable this policy setting, queries won't be performed on the web, web results won't be displayed when a user performs a query in Search, and search highlights will not be shown in the search box and in search home.
|
||||
|
||||
- If you disable this policy setting, queries will be performed on the web, web results will be displayed when a user performs a query in Search, and search highlights will be shown in the search box and in search home.
|
||||
|
||||
<!--/Description-->
|
||||
<!--ADMXMapped-->
|
||||
@ -674,8 +675,8 @@ ADMX Info:
|
||||
<!--SupportedValues-->
|
||||
The following list shows the supported values:
|
||||
|
||||
- 0 - Not allowed. Queries won't be performed on the web and web results won't be displayed when a user performs a query in Search.
|
||||
- 1 (default) - Allowed. Queries will be performed on the web and web results will be displayed when a user performs a query in Search.
|
||||
- 0 - Not allowed. Queries won't be performed on the web, web results won't be displayed when a user performs a query in Search, and search highlights won't be shown in the search box and in search home.
|
||||
- 1 (default) - Allowed. Queries will be performed on the web, web results will be displayed when a user performs a query in Search, and search highlights will be shown in the search box and in search home.
|
||||
|
||||
<!--/SupportedValues-->
|
||||
<!--/Policy-->
|
||||
|
@ -56,6 +56,7 @@ SurfaceHub
|
||||
----Properties
|
||||
--------FriendlyName
|
||||
--------DefaultVolume
|
||||
--------DefaultAutomaticFraming
|
||||
--------ScreenTimeout
|
||||
--------SessionTimeout
|
||||
--------SleepTimeout
|
||||
@ -196,7 +197,7 @@ SurfaceHub
|
||||
<p>The data type is string. Supported operation is Get and Replace.
|
||||
|
||||
<a href="" id="deviceaccount-exchangemodernauthenabled"></a>**DeviceAccount/ExchangeModernAuthEnabled**
|
||||
<p>Added in <a href="https://support.microsoft.com/en-us/topic/february-2-2021-kb4598291-os-builds-19041-789-and-19042-789-preview-6a766199-a4f1-616e-1f5c-58bdc3ca5e3b" data-raw-source="[KB4598291](https://support.microsoft.com/en-us/topic/february-2-2021-kb4598291-os-builds-19041-789-and-19042-789-preview-6a766199-a4f1-616e-1f5c-58bdc3ca5e3b)">KB4598291</a> for Windows 10, version 20H2. Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server. Default value is True.
|
||||
<p>Added in <a href="https://support.microsoft.com/help/4598291" data-raw-source="[KB4598291](https://support.microsoft.com/help/4598291)">KB4598291</a> for Windows 10, version 20H2. Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server. Default value is True.
|
||||
|
||||
<p>The data type is boolean. Supported operation is Get and Replace.
|
||||
|
||||
@ -336,6 +337,11 @@ The data type is integer. Supported operation is Get.
|
||||
|
||||
<p>The data type is integer. Supported operation is Get and Replace.
|
||||
|
||||
<a href="" id="properties-defaultautomaticframing"></a>**Properties/DefaultAutomaticFraming**
|
||||
<p>Added in <a href="https://support.microsoft.com/help/5010415" data-raw-source="[KB5010415](https://support.microsoft.com/help/5010415)">KB5010415</a> for Windows 10, version 20H2. Specifies whether the Surface Hub 2 Smart Camera feature to automatically zoom and keep users centered in the video is enabled. Default value is True.
|
||||
|
||||
<p>The data type is boolean. Supported operation is Get and Replace.
|
||||
|
||||
<a href="" id="properties-screentimeout"></a>**Properties/ScreenTimeout**
|
||||
<p>Added in Windows 10, version 1703. Specifies the number of minutes until the Hub screen turns off.
|
||||
|
||||
@ -424,7 +430,7 @@ The data type is integer. Supported operation is Get.
|
||||
<p>The data type is boolean. Supported operation is Get and Replace.
|
||||
|
||||
<a href="" id="properties-proxyservers"></a>**Properties/ProxyServers**
|
||||
<p>Added in <a href="https://support.microsoft.com/topic/may-28-2019-kb4499162-os-build-15063-1839-ed6780ab-38d6-f590-d789-5ba873b1e142" data-raw-source="[KB4499162](https://support.microsoft.com/topic/may-28-2019-kb4499162-os-build-15063-1839-ed6780ab-38d6-f590-d789-5ba873b1e142)">KB4499162</a> for Windows 10, version 1703. Specifies FQDNs of proxy servers to provide device account credentials to before any user interaction (if AllowAutoProxyAuth is enabled). This is a semi-colon separated list of server names, without any additional prefixes (e.g. https://).
|
||||
<p>Added in <a href="https://support.microsoft.com/help/4499162" data-raw-source="[KB4499162](https://support.microsoft.com/help/4499162)">KB4499162</a> for Windows 10, version 1703. Specifies FQDNs of proxy servers to provide device account credentials to before any user interaction (if AllowAutoProxyAuth is enabled). This is a semi-colon separated list of server names, without any additional prefixes (e.g. https://).
|
||||
|
||||
<p>The data type is string. Supported operation is Get and Replace.
|
||||
|
||||
|
@ -11,7 +11,7 @@ ms.mktglfcycl: deploy
|
||||
ms.sitesec: library
|
||||
ms.localizationpriority: none
|
||||
author: dansimp
|
||||
ms.date: 09/06/2021
|
||||
ms.date: 03/16/2022
|
||||
ms.technology: windows-sec
|
||||
---
|
||||
|
||||
@ -22,7 +22,7 @@ Audit Process Creation determines whether the operating system generates audit e
|
||||
|
||||
These audit events can help you track user activity and understand how a computer is being used. Information includes the name of the program or the user that created the process.
|
||||
|
||||
**Event volume**: Low to Medium, depending on system usage.
|
||||
**Event volume**: Medium to High, depending on the process activity on the computer.
|
||||
|
||||
This subcategory allows you to audit events generated when a process is created or starts. The name of the application and user that created the process is also audited.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user