Skip to content

Commit 6345564

Browse files
paolomatarazzopaolomatarazzo
committed
split content
1 parent 9e59c15 commit 6345564

File tree

7 files changed

+343
-353
lines changed

7 files changed

+343
-353
lines changed

‎includes/licensing/assigned-access.md

-14
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,8 @@ ms.date: 09/18/2023
55
ms.topic: include
66
---
77

8-
<!--## Windows edition and licensing requirements-->
9-
108
## Windows edition requirements
119

12-
The following table lists the Windows editions that support Assigned Access:
13-
14-
||Windows Edition|
15-
|---:|:---|
16-
|✅|Education|
17-
|✅|Enterprise |
18-
|✅|Enterprise LTSC|
19-
|✅|IoT Enterprise |
20-
|✅|IoT Enterprise LTSC|
21-
|✅|Pro Education|
22-
|✅|Pro|
23-
2410
The following list contains the Windows editions that support Assigned Access:
2511

2612
✅ Pro<br>✅ Enterprise / Enterprise LTSC<br>

‎includes/licensing/shell-launcher.md

-15
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,8 @@ ms.date: 09/18/2023
55
ms.topic: include
66
---
77

8-
<!--## Windows edition and licensing requirements-->
9-
108
## Windows edition requirements
119

12-
The following table lists the Windows editions that support Shell Launcher:
13-
14-
||Edition|
15-
|---:|:---|
16-
|✅|Education|
17-
|✅|Enterprise |
18-
|✅|Enterprise LTSC|
19-
|✅|IoT Enterprise |
20-
|✅|IoT Enterprise LTSC|
21-
|❌|Pro Education|
22-
|❌|Pro|
23-
|❌|Home|
24-
2510
The following list contains the Windows editions that support Shell Launcher:
2611

2712
❌ Home<br>❌ Pro / Pro Education<br>✅ Enterprise / Enterprise LTSC<br>✅ Education<br>✅ IoT Enterprise / IoT Enterprise LTSC

‎windows/configuration/assigned-access/index.md

-282
Original file line numberDiff line numberDiff line change
@@ -31,285 +31,3 @@ Here are the requirements for Assigned Access:
3131
- To use a kiosk experience, you must sign in from the console. The kiosk experience isn't supported over a remote desktop connection
3232

3333
[!INCLUDE [assigned-access](../../../includes/licensing/assigned-access.md)]
34-
35-
## Configure a kiosk experience
36-
37-
There are several options to configure a kiosk experience. If you need to configure a single device with a local account, you can use:
38-
39-
- PowerShell: you can use the `Set-AssignedAccess` PowerShell cmdlet to configure a kiosk experience using a local standard account
40-
- Settings: use this option when you need a simple method to configure a single device with a local standard user account
41-
42-
For advanced customizations, you can use the [Assigned Access CSP](/windows/client-management/mdm/assignedaccess-csp) to configure the kiosk experience. The CSP allows you to configure the kiosk app, the user account, and the kiosk app's behavior. When you use the CSP, you must create an XML configuration file that specifies the kiosk app and the user account. The XML file is applied to the device using one of the following options:
43-
44-
- A Mobile Device Management (MDM) solution, like Microsoft Intune
45-
- Provisioning packages
46-
- PowerShell, with the MDM Bridge WMI Provider
47-
48-
To learn how to configure the Shell Launcher XML file, see [Create an Assigned Access configuration file](configuration-file.md).
49-
50-
[!INCLUDE [tab-intro](../../../includes/configure/tab-intro.md)]
51-
52-
#### [:::image type="icon" source="../images/icons/intune.svg"::: **Intune/CSP**](#tab/intune)
53-
54-
You can configure devices using a [custom policy][MEM-1] with the [AssignedAccess CSP][WIN-3].
55-
56-
- **Setting:** `./Vendor/MSFT/AssignedAccess/Configuration`
57-
- **Value:** content of the XML configuration file
58-
59-
Assign the policy to a group that contains as members the devices that you want to configure.
60-
61-
#### [:::image type="icon" source="../images/icons/provisioning-package.svg"::: **PPKG**](#tab/ppkg)
62-
63-
[!INCLUDE [provisioning-package-1](../../../includes/configure/provisioning-package-1.md)]
64-
65-
- **Path:** `AssignedAccess/AssignedAccessSettings`
66-
- **Value:** Enter the account and the application you want to use for Assigned access, using the AUMID of the app. Example:
67-
- `{"Account":"domain\user", "AUMID":"Microsoft.WindowsCalculator_8wekyb3d8bbwe!App"}`
68-
69-
[!INCLUDE [provisioning-package-2](../../../includes/configure/provisioning-package-2.md)]
70-
71-
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/ps)
72-
73-
To configure a device using Windows PowerShell:
74-
75-
1. Sign in as administrator
76-
1. [Create the user account](https://support.microsoft.com/help/4026923/windows-create-a-local-user-or-administrator-account-in-windows-10) for Assigned Access
77-
1. Sign in as the Assigned Access user account
78-
1. Install the required UWP app
79-
1. Sign out as the Assigned Access user account
80-
1. Sign in as administrator and from an elevated PowerShell prompt use one of the following commands:
81-
82-
```PowerShell
83-
#Configure Assigned Access by AppUserModelID and user name
84-
Set-AssignedAccess -AppUserModelId <AUMID> -UserName <username>
85-
86-
#Configure Assigned Access by AppUserModelID and user SID
87-
Set-AssignedAccess -AppUserModelId <AUMID> -UserSID <usersid>
88-
89-
#Configure Assigned Access by app name and user name
90-
Set-AssignedAccess -AppName <CustomApp> -UserName <username>
91-
92-
#Configure Assigned Access by app name and user SID**:
93-
Set-AssignedAccess -AppName <CustomApp> -UserSID <usersid>
94-
95-
> [!NOTE]
96-
> To set up Assigned Access using `-AppName`, the user account that you enter for Assigned Access must have signed in at least once.
97-
98-
For more information:
99-
100-
- [Find the Application User Model ID of an installed app](../store/find-aumid.md)
101-
- [Set-AssignedAccess](/powershell/module/assignedaccess/set-assignedaccess)
102-
103-
To remove assigned access, using PowerShell, run the following cmdlet:
104-
105-
```powershell
106-
Clear-AssignedAccess
107-
```
108-
109-
For advanced customizations that use the XML configuration file, you can use PowerShell scripts via the [MDM Bridge WMI Provider](/windows/win32/dmwmibridgeprov/mdm-bridge-wmi-provider-portal).
110-
111-
> [!IMPORTANT]
112-
> For all device settings, the WMI Bridge client must be executed as SYSTEM (LocalSystem) account.
113-
114-
To test the PowerShell script, you can:
115-
116-
1. [Download the psexec tool](/sysinternals/downloads/psexec)
117-
1. Open an elevated command prompt and run: `psexec.exe -i -s powershell.exe`
118-
1. Run the script in the PowerShell session
119-
120-
```PowerShell
121-
$shellLauncherConfiguration = @"
122-
123-
# content of the XML configuration file
124-
125-
"@
126-
127-
$namespaceName="root\cimv2\mdm\dmmap"
128-
$className="MDM_AssignedAccess"
129-
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
130-
$obj.ShellLauncher = [System.Net.WebUtility]::HtmlEncode($shellLauncherConfiguration)
131-
$obj = Set-CimInstance -CimInstance $obj -ErrorVariable cimSetError -ErrorAction SilentlyContinue
132-
if($cimSetError) {
133-
Write-Output "An ERROR occurred. Displaying error record and attempting to retrieve error logs...`n"
134-
Write-Error -ErrorRecord $cimSetError[0]
135-
136-
$timeout = New-TimeSpan -Seconds 30
137-
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
138-
do{
139-
$events = Get-WinEvent -FilterHashtable $eventLogFilterHashTable -ErrorAction Ignore
140-
} until ($events.Count -or $stopwatch.Elapsed -gt $timeout) # wait for the log to be available
141-
142-
if($events.Count) {
143-
$events | ForEach-Object {
144-
Write-Output "$($_.TimeCreated) [$($_.LevelDisplayName.ToUpper())] $($_.Message -replace "`n|`r")"
145-
}
146-
} else {
147-
Write-Warning "Timed-out attempting to retrieve event logs..."
148-
}
149-
150-
Exit 1
151-
}
152-
153-
Write-Output "Successfully applied Shell Launcher configuration"
154-
```
155-
156-
[!INCLUDE [powershell-wmi-bridge-2](../../../includes/configure/powershell-wmi-bridge-2.md)]
157-
158-
#### [:::image type="icon" source="../images/icons/settings-app.svg"::: **Settings**](#tab/settings)
159-
160-
Here are the steps to configure a kiosk using the Settings app:
161-
162-
1. Open the Settings app to view and configure a device as a kiosk. Go to **Settings > Accounts > Other Users**, or use the following shortcut:
163-
164-
> [!div class="nextstepaction"]
165-
>
166-
> [Other Users](ms-settings:otherusers)
167-
168-
1. Under **Set up a kiosk**, select **Get Started**
169-
1. In the **Create an account** dialog, enter the account name, and select **Next**
170-
>[!NOTE]
171-
>If there are any local standard user accounts already, the **Create an account** dialog offers the option to **Choose an existing account**
172-
173-
1. Choose the application to run when the kiosk account signs in. Only apps that can run above the lock screen are available in the list of apps to choose from. If you select **Microsoft Edge** as the kiosk app, you configure the following options:
174-
175-
- Whether Microsoft Edge should display your website full-screen (digital sign) or with some browser controls available (public browser)
176-
- Which URL should be open when the kiosk accounts signs in
177-
- When Microsoft Edge should restart after a period of inactivity (if you select to run as a public browser)
178-
179-
1. Select **Close**
180-
181-
When the device isn't joined to an Active Directory domain or Microsoft Entra ID, automatic sign-in of the kiosk account is configured automatically:
182-
183-
- If you want the kiosk account to sign in automatically, and the kiosk app launched when the device restarts, then you don't need to do anything
184-
- If you don't want the kiosk account to sign in automatically when the device restarts, then you must change the default setting before you configure the device as a kiosk. Sign in with the account that you want to use as the kiosk account. Open **Settings** > **Accounts** > **Sign-in options**. Set the **Use my sign-in info to automatically finish setting up my device after an update or restart** setting to **Off**. After you change the setting, you can apply the kiosk configuration to the device
185-
186-
---
187-
188-
> [!TIP]
189-
> For practical examples, see the [Quickstart: Configure a kiosk with Assigned Access](quickstart-kiosk.md).
190-
191-
## Configure a restricted user experience
192-
193-
To configure a restricted user experience with Assigned Access, you must create an XML configuration file with the settings for the desired experience. The XML file is applied to the device via the [Assigned Access CSP](/windows/client-management/mdm/assignedaccess-csp#shelllauncher), using one of the following options:
194-
195-
- A Mobile Device Management (MDM) solution, like Microsoft Intune
196-
- Provisioning packages
197-
- PowerShell, with the MDM Bridge WMI Provider
198-
199-
To learn how to configure the Assigned Access XML file, see [Create an Assigned Access configuration file](configuration-file.md).
200-
201-
[!INCLUDE [tab-intro](../../../includes/configure/tab-intro.md)]
202-
203-
#### [:::image type="icon" source="../images/icons/intune.svg"::: **Intune/CSP**](#tab/intune)
204-
205-
You can configure devices using a [custom policy][MEM-1] with the [AssignedAccess CSP][WIN-3].
206-
207-
- **Setting:** `./Vendor/MSFT/AssignedAccess/ShellLauncher`
208-
- **Value:** content of the XML configuration file
209-
210-
Assign the policy to a group that contains as members the devices that you want to configure.
211-
212-
#### [:::image type="icon" source="../images/icons/provisioning-package.svg"::: **PPKG**](#tab/ppkg)
213-
214-
[!INCLUDE [provisioning-package-1](../../../includes/configure/provisioning-package-1.md)]
215-
216-
- **Path:** `AssignedAccess/MultiAppAssignedAccessSettings`
217-
- **Value:** content of the XML configuration file
218-
219-
[!INCLUDE [provisioning-package-2](../../../includes/configure/provisioning-package-2.md)]
220-
221-
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/ps)
222-
223-
[!INCLUDE [powershell-wmi-bridge-1](../../../includes/configure/powershell-wmi-bridge-1.md)]
224-
225-
```PowerShell
226-
$assignedAccessConfiguration = @"
227-
228-
# content of the XML configuration file
229-
230-
"@
231-
232-
$namespaceName="root\cimv2\mdm\dmmap"
233-
$className="MDM_AssignedAccess"
234-
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
235-
$obj.Configuration = [System.Net.WebUtility]::HtmlEncode($assignedAccessConfiguration)
236-
$obj = Set-CimInstance -CimInstance $obj -ErrorVariable cimSetError -ErrorAction SilentlyContinue
237-
if($cimSetError) {
238-
Write-Output "An ERROR occurred. Displaying error record and attempting to retrieve error logs...`n"
239-
Write-Error -ErrorRecord $cimSetError[0]
240-
241-
$timeout = New-TimeSpan -Seconds 30
242-
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
243-
do{
244-
$events = Get-WinEvent -FilterHashtable $eventLogFilterHashTable -ErrorAction Ignore
245-
} until ($events.Count -or $stopwatch.Elapsed -gt $timeout) # wait for the log to be available
246-
247-
if($events.Count) {
248-
$events | ForEach-Object {
249-
Write-Output "$($_.TimeCreated) [$($_.LevelDisplayName.ToUpper())] $($_.Message -replace "`n|`r")"
250-
}
251-
} else {
252-
Write-Warning "Timed-out attempting to retrieve event logs..."
253-
}
254-
255-
Exit 1
256-
}
257-
258-
Write-Output "Successfully applied Assigned Access configuration"
259-
```
260-
261-
[!INCLUDE [powershell-wmi-bridge-2](../../../includes/configure/powershell-wmi-bridge-2.md)]
262-
263-
#### [:::image type="icon" source="../images/icons/settings-app.svg"::: **Settings**](#tab/settings)
264-
265-
This option isn't available using Settings.
266-
267-
---
268-
269-
> [!TIP]
270-
> For practical examples, see the [Quickstart: Configure a restricted user experience with Assigned Access](quickstart-restricted-user-experience.md)
271-
272-
## User experience
273-
274-
To validate the kiosk or restricted user experience, sign in with the user account you specified in the configuration file.
275-
276-
The Assigned Access configuration takes effect the next time the targeted user signs in. If that user account is signed in when you apply the configuration, sign out and sign back in to validate the experience.
277-
278-
> [!NOTE]
279-
> Starting in Windows 11, a restricted user experience supports the use of multiple monitors.
280-
281-
### Autotrigger touch keyboard
282-
283-
The touch keyboard is automatically triggered when there's an input needed and no physical keyboard is attached on touch-enabled devices. You don't need to configure any other setting to enforce this behavior.
284-
285-
> [!TIP]
286-
> The touch keyboard is triggered only when tapping a textbox. Mouse clicks don't trigger the touch keyboard. If you're testing this feature, use a physical device instead of a virtual machine (VM), as the touch keyboard is not triggered on VMs.
287-
288-
### Sign out of assigned access
289-
290-
By default, to exit the kiosk experience, press <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Del</kbd>. The kiosk app exits automatically. If you sign in again as the Assigned Access account, or wait for the sign in screen timeout, the kiosk app relaunches. The default timeout is 30 seconds, but you can change the timeout with the registry key:
291-
292-
`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Authentication\LogonUI`
293-
294-
To change the default time for Assigned Access to resume, add *IdleTimeOut* (DWORD) and enter the value data as milliseconds in hexadecimal.
295-
296-
> [!NOTE]
297-
> `IdleTimeOut` doesn't apply to the Microsoft Edge kiosk mode.
298-
299-
The Breakout Sequence of <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Del</kbd> is the default, but this sequence can be configured to be a different sequence of keys. The breakout sequence uses the format **modifiers + keys**. An example breakout sequence is <kbd>CTRL</kbd> + <kbd>ALT</kbd> + <kbd>A</kbd>, where <kbd>CTRL</kbd> + <kbd>ALT</kbd> are the modifiers, and <kbd>A</kbd> is the key value. To learn more, see [Create an Assigned Access configuration XML file](configuration-file.md).
300-
301-
## Remove Assigned Access
302-
303-
Deleting the restricted user experience removes the policy settings associated with the users, but it can't revert all the configurations. For example, the Start menu configuration is maintained.
304-
305-
## Next steps
306-
307-
> [!div class="nextstepaction"]
308-
> Review the recommendations before you deploy Assigned Access:
309-
>
310-
> [Assigned Access recommendations](recommendations.md)
311-
312-
<!--links-->
313-
314-
[MEM-1]: /mem/intune/configuration/custom-settings-windows-10
315-
[WIN-3]: /windows/client-management/mdm/assignedaccess-csp

0 commit comments

Comments
 (0)