Skip to content

Commit c07f823

Browse files
authored
Merge pull request #230143 from ShawnJackson/microsoft-dev-box-docset-how-to
[AQ] edit pass: Microsoft Dev Box how-to articles
2 parents 282ffd2 + 37b03a9 commit c07f823

11 files changed

+527
-448
lines changed

articles/dev-box/how-to-configure-azure-compute-gallery.md

Lines changed: 98 additions & 84 deletions
Large diffs are not rendered by default.

articles/dev-box/how-to-customize-devbox-azure-image-builder.md

Lines changed: 67 additions & 56 deletions
Large diffs are not rendered by default.
Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Provide access to dev box users
2+
title: Provide access for dev box users
33
titleSuffix: Microsoft Dev Box Preview
44
description: Learn how to provide access to projects for dev box users so that they can create and manage dev boxes.
55
services: dev-box
@@ -12,7 +12,7 @@ ms.topic: how-to
1212

1313
# Provide access to projects for dev box users
1414

15-
Team members must have access to a specific Microsoft Dev Box Preview project before they can create dev boxes. By using the built-in DevCenter Dev Box User role, you can assign permissions to Active Directory Users or Groups at the project level.
15+
Team members must have access to a specific Microsoft Dev Box Preview project before they can create dev boxes. By using the built-in DevCenter Dev Box User role, you can assign permissions to Active Directory users or groups at the project level.
1616

1717
[!INCLUDE [supported accounts note](./includes/note-supported-accounts.md)]
1818

@@ -27,30 +27,31 @@ A DevCenter Dev Box User can:
2727
## Assign permissions to dev box users
2828

2929
1. Sign in to the [Azure portal](https://portal.azure.com).
30-
31-
1. In the search box, type *Dev box* and select **Projects**.
3230

33-
1. Select the project you want to provide your team members access to.
34-
35-
:::image type="content" source="./media/how-to-dev-box-user/projects-grid.png" alt-text="Screenshot showing the list of existing projects.":::
31+
1. In the search box, enter **projects**. In the list of results, select **Projects**.
32+
33+
1. Select the project that you want to give your team members access to.
34+
35+
:::image type="content" source="./media/how-to-dev-box-user/projects-grid.png" alt-text="Screenshot that shows a list of existing projects.":::
36+
37+
1. On the left menu, select **Access Control (IAM)**.
3638

37-
1. Select **Access Control (IAM)** from the left menu.
38-
3939
1. Select **Add** > **Add role assignment**.
4040

4141
1. Assign the following role. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.md).
42-
42+
4343
| Setting | Value |
4444
| --- | --- |
4545
| **Role** | Select **DevCenter Dev Box User**. |
4646
| **Assign access to** | Select **User, group, or service principal**. |
47-
| **Members** | Select the users or groups you want to have access to the project. |
47+
| **Members** | Select the users or groups that you want to have access to the project. |
4848

49-
:::image type="content" source="media/how-to-dev-box-user/add-role-assignment-user.png" alt-text="Screenshot that shows the Add role assignment pane.":::
49+
:::image type="content" source="media/how-to-dev-box-user/add-role-assignment-user.png" alt-text="Screenshot that shows the pane for adding role assignments.":::
5050

51-
The user will now be able to view the project and all the pools within it. Dev box users can create dev boxes from any of the pools and manage those dev boxes from the [developer portal](https://aka.ms/devbox-portal).
51+
The users can now view the project and all the pools within it. Dev box users can create dev boxes from any of the pools and manage those dev boxes from the [developer portal](https://aka.ms/devbox-portal).
5252

5353
[!INCLUDE [dev box runs on creation note](./includes/note-dev-box-runs-on-creation.md)]
54+
5455
## Next steps
5556

5657
- [Quickstart: Create a dev box by using the developer portal](quickstart-create-dev-box.md)

articles/dev-box/how-to-manage-dev-box-definitions.md

Lines changed: 58 additions & 54 deletions
Large diffs are not rendered by default.
Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,96 @@
11
---
2-
title: How to manage a dev box pool
2+
title: Manage a dev box pool
33
titleSuffix: Microsoft Dev Box Preview
4-
description: This article describes how to create, and delete Microsoft Dev Box Preview dev box pools.
4+
description: This article describes how to create and delete Microsoft Dev Box Preview dev box pools.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
88
ms.author: rosemalcolm
99
ms.date: 10/12/2022
1010
ms.topic: how-to
11+
#Customer intent: As a dev infrastructure manager, I want to be able to manage dev box pools so that I can provide appropriate dev boxes to my users.
1112
---
1213

13-
<!-- Intent: As a dev infrastructure manager, I want to be able to manage dev box pools so that I can provide appropriate dev boxes to my users. -->
14-
1514
# Manage a dev box pool
16-
To enable developers to self-serve dev boxes from projects, you must configure dev box pools that specify the dev box definitions and network connections used when dev boxes are created. Dev box users create dev boxes from the dev box pools they have access to through their project memberships.
15+
16+
To enable developers to self-serve dev boxes from projects, you must configure dev box pools that specify the dev box definitions and network connections for newly created dev boxes. Dev box users create dev boxes from the dev box pools that their project memberships give them access to.
1717

1818
## Permissions
19+
1920
To manage a dev box pool, you need the following permissions:
2021

21-
|Action|Permission required|
22+
|Action|Permissions required|
2223
|-----|-----|
23-
|Create, delete, or update dev box pool|Owner or Contributor permissions on an Azure Subscription or a specific resource group. </br> DevCenter Project Admin for the project.|
24+
|Create, delete, or update a dev box pool|Owner or Contributor permissions on an Azure subscription or a specific resource group. </br> DevCenter Project Admin permissions for the project.|
2425

2526
## Create a dev box pool
26-
A dev box pool is a collection of dev boxes that you manage together. You must have a pool before users can create a dev box.
2727

28-
The following steps show you how to create a dev box pool associated with a project. You'll use an existing dev box definition and network connection in the dev center to configure a dev box pool.
28+
A dev box pool is a collection of dev boxes that you manage together. You must have a pool before users can create a dev box.
2929

30-
<!-- how many dev box pools can you create -->
30+
The following steps show you how to create a dev box pool that's associated with a project. You'll use an existing dev box definition and network connection in the dev center to configure the pool.
3131

32-
If you don't have an available dev center with an existing dev box definition and network connection, follow the steps in [Quickstart: Configure the Microsoft Dev Box Preview service](quickstart-configure-dev-box-service.md) to create them.
32+
If you don't have an available dev center with an existing dev box definition and network connection, follow the steps in [Quickstart: Configure Microsoft Dev Box Preview](quickstart-configure-dev-box-service.md) to create them.
3333

3434
1. Sign in to the [Azure portal](https://portal.azure.com).
3535

36-
1. In the search box, type *Projects* and then select **Projects** from the list.
36+
1. In the search box, enter **projects**. In the list of results, select **Projects**.
3737

38-
:::image type="content" source="./media/how-to-manage-dev-box-pools/discover-projects.png" alt-text="Screenshot showing a search for projects from the Azure portal search box.":::
38+
:::image type="content" source="./media/how-to-manage-dev-box-pools/discover-projects.png" alt-text="Screenshot that shows a search for projects from the Azure portal search box.":::
3939

4040
1. Open the project with which you want to associate the new dev box pool.
4141

4242
:::image type="content" source="./media/how-to-manage-dev-box-pools/projects-grid.png" alt-text="Screenshot of the list of existing projects.":::
4343

44-
1. Select **Dev box pools** and then select **+ Create**.
45-
46-
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-grid-empty.png" alt-text="Screenshot of the list of dev box pools within a project. The list is empty.":::
44+
1. Select **Dev box pools**, and then select **Create**.
4745

48-
1. On the **Create a dev box pool** page, enter the following values:
46+
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-grid-empty.png" alt-text="Screenshot of the empty list of dev box pools within a project, along with the Create button.":::
47+
48+
1. On the **Create a dev box pool** pane, enter the following values:
4949

5050
|Name|Value|
5151
|----|----|
52-
|**Name**|Enter a name for the pool. The pool name is visible to developers to select when they're creating dev boxes, and must be unique within a project.|
53-
|**Dev box definition**|Select an existing dev box definition. The definition determines the base image and size for the dev boxes created within this pool.|
54-
|**Network connection**|Select an existing network connection. The network connection determines the region of the dev boxes created within this pool.|
55-
|**Dev Box Creator Privileges**|Select Local Administrator or Standard User.|
56-
|**Enable Auto-stop**|Yes is the default. Select No to disable an Auto-stop schedule. You can configure an Auto-stop schedule after the pool has been created.|
57-
|**Stop time**| Select a time to shutdown all the dev boxes in the pool.|
52+
|**Name**|Enter a name for the pool. The pool name is visible to developers to select when they're creating dev boxes. It must be unique within a project.|
53+
|**Dev box definition**|Select an existing dev box definition. The definition determines the base image and size for the dev boxes that are created in this pool.|
54+
|**Network connection**|Select an existing network connection. The network connection determines the region of the dev boxes that are created in this pool.|
55+
|**Dev box Creator Privileges**|Select **Local Administrator** or **Standard User**.|
56+
|**Enable Auto-stop**|**Yes** is the default. Select **No** to disable an auto-stop schedule. You can configure an auto-stop schedule after the pool is created.|
57+
|**Stop time**| Select a time to shut down all the dev boxes in the pool.|
5858
|**Time zone**| Select the time zone that the stop time is in.|
59-
|**Licensing**| Select this check box to confirm that your organization has Azure Hybrid Benefit licenses that you want to apply to the dev boxes in this pool. |
60-
59+
|**Licensing**| Select this checkbox to confirm that your organization has Azure Hybrid Benefit licenses that you want to apply to the dev boxes in this pool. |
6160

62-
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-create.png" alt-text="Screenshot of the Create dev box pool dialog.":::
61+
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-create.png" alt-text="Screenshot of the pane for creating a dev box pool.":::
6362

6463
1. Select **Add**.
65-
66-
1. Verify that the new dev box pool appears in the list. You may need to refresh the screen.
6764

68-
The dev box pool will be deployed and health checks will be run to ensure the image and network pass the validation criteria to be used for dev boxes. The screenshot below shows four dev box pools, each with a different status.
65+
1. Verify that the new dev box pool appears in the list. You might need to refresh the screen.
6966

70-
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-grid-populated.png" alt-text="Screenshot showing a list of existing pools.":::
67+
The Azure portal deploys the dev box pool and runs health checks to ensure that the image and network pass the validation criteria for dev boxes. The following screenshot shows four dev box pools, each with a different status.
7168

69+
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-grid-populated.png" alt-text="Screenshot that shows a list of dev box pools and status information.":::
7270

7371
## Delete a dev box pool
74-
You can delete a dev box pool when you're no longer using it.
72+
73+
You can delete a dev box pool when you're no longer using it.
7574

7675
> [!CAUTION]
77-
> When you delete a dev box pool, all existing dev boxes within the pool will be permanently deleted.
76+
> When you delete a dev box pool, all existing dev boxes within the pool are permanently deleted.
7877
7978
1. Sign in to the [Azure portal](https://portal.azure.com).
8079

81-
1. In the search box, type *Projects* and then select **Projects** from the list.
80+
1. In the search box, enter **projects**. In the list of results, select **Projects**.
8281

8382
1. Open the project from which you want to delete the dev box pool.
8483

85-
1. Select the dev box pool you want to delete and then select **Delete**.
86-
87-
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-delete.png" alt-text="Screenshot of the list of existing dev box pools, with the one to be deleted selected.":::
84+
1. Select the dev box pool you that you want to delete, and then select **Delete**.
85+
86+
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-delete.png" alt-text="Screenshot of a selected dev box pool in the list of dev box pools, along with the Delete button.":::
8887

89-
1. In the confirmation message, select **Confirm**.
88+
1. In the confirmation message, select **Continue**.
9089

91-
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-delete-confirm.png" alt-text="Screenshot of the Delete dev box pool confirmation message.":::
90+
:::image type="content" source="./media/how-to-manage-dev-box-pools/dev-box-pool-delete-confirm.png" alt-text="Screenshot of the confirmation message for deleting a dev box pool.":::
9291

9392
## Next steps
9493

9594
- [Provide access to projects for project admins](./how-to-project-admin.md)
9695
- [Create dev box definitions](./quickstart-configure-dev-box-service.md#create-a-dev-box-definition)
97-
- [Configure an Azure Compute Gallery](./how-to-configure-azure-compute-gallery.md)
96+
- [Configure Azure Compute Gallery](./how-to-configure-azure-compute-gallery.md)
Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: How to manage a dev box using the developer portal
2+
title: Manage a dev box by using the developer portal
33
titleSuffix: Microsoft Dev Box
4-
description: This article describes how to create, delete, and connect to Microsoft Dev Box dev boxes using the developer portal.
4+
description: Learn how to create, delete, and connect to Microsoft Dev Box Preview dev boxes by using the developer portal.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -10,56 +10,54 @@ ms.date: 09/18/2022
1010
ms.topic: how-to
1111
---
1212

13+
# Manage a dev box by using the developer portal
1314

14-
# Manage a dev box using the developer portal
15-
You can pre-configure a dev box to manage all of your tools, services, source-code and pre-built binaries specific to your project so you can immediately start working. Dev box enables you to get started quickly with an environment that's ready to build on so you can run your app in minutes.
15+
You can preconfigure a dev box to manage all of your tools, services, source code, and prebuilt binaries that are specific to your project. Microsoft Dev Box Preview provides an environment that's ready to build on, so you can run your app in minutes.
1616

1717
## Permissions
1818

19-
As a dev box developer, you can:
20-
- Create, view, and delete dev boxes you create
21-
- View pools within a project
22-
- Connect to dev boxes
19+
As a dev box developer, you can:
20+
21+
- Create, view, and delete dev boxes that you create.
22+
- View pools within a project.
23+
- Connect to dev boxes.
2324

2425
## Create a dev box
2526

26-
Create a dev box through the developer portal. You can create as many dev boxes as you need, however there are common ways to split up your workload.
27+
Create a dev box through the developer portal. You can create as many dev boxes as you need, but there are common ways to split up your workload.
2728

28-
You could create a dev box for your front-end work and a separate dev box for your back-end work. You could also create multiple dev boxes for your back-end.
29+
You could create a dev box for your front-end work and a separate dev box for your back-end work. You could also create multiple dev boxes for your back end.
2930

30-
For example, say you were working on a bug. You could a separate dev box for the bug fix to work on the specific task, troubleshoot the issue and avoid poisoning your primary machine.
31+
For example, say you're working on a bug. You could use a separate dev box for the bug fix to work on the specific task and troubleshoot the issue without poisoning your primary machine.
3132

33+
To create a dev box:
3234

3335
[!INCLUDE [create a dev box](./includes/create-dev-box.md)]
3436

35-
3637
## Connect to a dev box
37-
Once you create your dev box, you can connect to it through the remote desktop app, or through the browser.
3838

39-
:::image type="content" source="./media/how-to-manage-dev-boxes/open-rdp-client.jpg" alt-text="Screenshot of dev box showing open an RDP client.":::
39+
After you create your dev box, you can connect to it through a Remote Desktop app or through a browser.
4040

41-
For most cases, use the remote desktop app when accessing a dev box. The remote desktop provides the highest performance and best user-experience for heavy workloads.
41+
:::image type="content" source="./media/how-to-manage-dev-boxes/open-rdp-client.jpg" alt-text="Screenshot of the option to open a dev box in an RDP client.":::
4242

43-
- [Quickstart: Use a remote desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md)
43+
For most cases, use the Remote Desktop app when you're accessing a dev box. Remote Desktop provides the highest performance and best user experience for heavy workloads. For more information, see [Quickstart: Use a Remote Desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md).
4444

45-
Use the browser for lighter workloads. When you access your dev box via your phone or chrome book, you can use the browser. The browser is useful for tasks such as a quick bug fix, or a pull request (PR) review.
46-
47-
- [Use a browser to connect to a dev box](./quickstart-create-dev-box.md#connect-to-a-dev-box)
45+
Use the browser for lighter workloads. When you access your dev box via your phone or laptop, you can use the browser. The browser is useful for tasks such as a quick bug fix or a review of a GitHub pull request. For more information, see the [steps for using a browser to connect to a dev box](./quickstart-create-dev-box.md#connect-to-a-dev-box).
4846

4947
## Delete a dev box
48+
5049
When you no longer need a dev box, you can delete it.
5150

52-
There are many reasons why you might not need a dev box anymore. Maybe you're finished testing, or you finished working on a specific project within your product.
51+
There are many reasons why you might not need a dev box anymore. Maybe you finished testing, or you finished working on a specific project within your product.
5352

54-
You can delete dev boxes once you finish your tasks. Say you finished fixing your bug and merged your pull request. Now, you can delete your dev box and create new dev boxes to work on new items.
53+
You can delete dev boxes after you finish your tasks. Say you finished fixing your bug and merged your pull request. Now, you can delete your dev box and create new dev boxes to work on new items.
5554

56-
> [!NOTE]
57-
> Ensure that neither you, nor your team members need the dev box before deleting as dev boxes cannot be retrieved after deletion.
55+
> [!NOTE]
56+
> Ensure that neither you nor your team members need the dev box before deleting. You can't retrieve dev boxes after deletion.
5857
5958
[!INCLUDE [clean up resources](./includes/clean-up-resources.md)]
60-
6159

6260
## Next steps
6361

64-
- [Quickstart: Use a remote desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md)
62+
- [Use a remote desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md)
6563
- [Use a browser to connect to a dev box](./quickstart-create-dev-box.md#connect-to-a-dev-box)

0 commit comments

Comments
 (0)