Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
This CSP contains some settings that are under development and only applicable for Windows Insider Preview builds. These settings are subject to change and may have dependencies on other features or services in preview.
The SurfaceHub configuration service provider (CSP) is used to configure Microsoft Surface Hub settings.
The following list shows the SurfaceHub configuration service provider nodes:
- ./Vendor/MSFT/SurfaceHub
DeviceAccount
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount
Node for setting device account information. A device account is a Microsoft Exchange account that's connected with Skype for Business, which allows people to join scheduled meetings, make Skype for Business calls, and share content from the device. See the Surface Hub administrator guide for more information about setting up a device account. To use a device account from Microsoft Entra ID: 1. Set the UserPrincipalName (for Microsoft Entra ID). 2. Set a valid Password. 3. Execute ValidateAndCommit to validate the specified username and password combination against Microsoft Entra ID. 4. Get the ErrorContext in case something goes wrong during validation.
Note
If the device cannot auto-discover the Exchange server and Session Initiation Protocol (SIP) address from this information, you should specify the ExchangeServer and SipAddress.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
| Case Sensitive | True |
Example:
<SyncML xmlns="SYNCML:SYNCML1.2">
<SyncBody>
<Replace>
<CmdID>1</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/UserPrincipalName</LocURI>
</Target>
<Meta>
<Format xmlns="syncml:metinf">chr</Format>
</Meta>
<Data>user@contoso.com</Data>
</Item>
</Replace>
<Replace>
<CmdID>2</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/Password</LocURI>
</Target>
<Meta>
<Format xmlns="syncml:metinf">chr</Format>
</Meta>
<Data>password</Data>
</Item>
</Replace>
<Exec>
<CmdID>3</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/ValidateAndCommit</LocURI>
</Target>
</Item>
</Exec>
<Get>
<CmdID>4</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/ErrorContext</LocURI>
</Target>
</Item>
</Get>
<Final/>
</SyncBody>
</SyncML>
DeviceAccount/CalendarSyncEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/CalendarSyncEnabled
Specifies whether calendar sync and other Exchange server services is enabled.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true | Enabled. |
DeviceAccount/DomainName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/DomainName
Domain of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/Email
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/Email
Email address of the device account.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/ErrorContext
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ErrorContext
If there is an error calling ValidateAndCommit, there will be additional context for that error in this node.
Possible error values:
| ErrorContext value | Stage where error occurred | Description and suggestions |
|---|---|---|
| 1 | Unknown | |
| 2 | Populating account | Unable to retrieve account details using the username and password you provided. For Microsoft Entra accounts, ensure that UserPrincipalName and Password are valid. For AD accounts, ensure that DomainName, UserName, and Password are valid. Ensure that the specified account has an Exchange server mailbox. |
| 3 | Populating Exchange server address | Unable to auto-discover your Exchange server address. Try to manually specify the Exchange server address using the ExchangeServer field. |
| 4 | Validating Exchange server address | Unable to validate the Exchange server address. Ensure the ExchangeServer field is valid. |
| 5 | Saving account information | Unable to save account details to the system. |
| 6 | Validating EAS policies | The device account uses an unsupported EAS policy. Ensure the EAS policy is configured correctly according to the admin guide. |
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
DeviceAccount/ExchangeModernAuthEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 2004 with KB4598291 [10.0.19041.789] and later ✅ Windows 10, version 20H2 with KB4598291 [10.0.19042.789] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ExchangeModernAuthEnabled
Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
| Default Value | True |
Allowed values:
| Value | Description |
|---|---|
| False | Disabled. |
| True (Default) | Enabled. |
DeviceAccount/ExchangeServer
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ExchangeServer
Exchange server of the device account. Normally, the device will try to auto-discover the Exchange server. This field is only required if auto-discovery fails.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/Password
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/Password
Password for the device account. Get is allowed here, but will always return a blank.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/PasswordRotationEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/PasswordRotationEnabled
Specifies whether automatic password rotation is enabled. If you enforce a password expiration policy on the device account, use this setting to allow the device to manage its own password by changing it frequently, without requiring you to manually update the account information when the password expires. You can reset the password at any time using Active Directory (or Microsoft Entra ID).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| 0 | Password rotation enabled. |
| 1 | Disabled. |
DeviceAccount/SipAddress
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/SipAddress
Session Initiation Protocol (SIP) address of the device account. Normally, the device will try to auto-discover the SIP. This field is only required if auto-discovery fails.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/UserName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/UserName
Username of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/UserPrincipalName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/UserPrincipalName
User principal name (UPN) of the device account. To use a device account from Microsoft Entra ID or a hybrid deployment, you should specify the UPN of the device account.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/ValidateAndCommit
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ValidateAndCommit
This method validates the data provided and then commits the changes.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Exec |
Dot3
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./Vendor/MSFT/SurfaceHub/Dot3
Parent node.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
Dot3/EapUserData
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./Vendor/MSFT/SurfaceHub/Dot3/EapUserData
Used to specify credentials to authenticate device to the network.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
Dot3/LanProfile
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./Vendor/MSFT/SurfaceHub/Dot3/LanProfile
Used to specify credentials to authenticate device to the network.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
InBoxApps
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps
Node for the in-box app settings.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/Connect
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Connect
Node for the Connect app.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/Connect/AutoLaunch
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Connect/AutoLaunch
Specifies whether to automatically launch the Connect app whenever a projection is initiated. If this setting is true, the Connect app will be automatically launched. If false, the user will need to launch the Connect app manually from the Hub's settings.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true | Enabled. |
InBoxApps/SkypeForBusiness
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/SkypeForBusiness
Node for the Skype for Business settings.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/SkypeForBusiness/DomainName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/SkypeForBusiness/DomainName
Specifies the domain of the Skype for Business account when you are using Active Directory. For more information, see Set up your domain and users.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
InBoxApps/Teams
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 2004 with KB4566782 [10.0.19041.450] and later ✅ Windows 10, version 20H2 [10.0.19042] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Teams
This node controls policies specific to the Teams App on Surface Hub.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |