Skip to content

Latest commit

 

History

History
354 lines (215 loc) · 22 KB

quickstart-configure-dev-box-service.md

File metadata and controls

354 lines (215 loc) · 22 KB
title description services ms.service ms.topic author ms.author ms.date
Quickstart: Configure Microsoft Dev Box
In this quickstart, you learn how to configure the Microsoft Dev Box service to provide dev boxes for users.
dev-box
dev-box
quickstart
RoseHJM
rosemalcolm
04/25/2023

Quickstart: Configure Microsoft Dev Box

This quickstart describes how to set up Microsoft Dev Box to enable development teams to self-serve their dev boxes. The setup process involves two distinct phases. In the first phase, dev infra admins configure the necessary Microsoft Dev Box resources through the Azure portal. After this phase is complete, users can proceed to the next phase, creating and managing their dev boxes through the developer portal. This quickstart shows you how to complete the first phase.

The following graphic shows the steps required to configure Microsoft Dev Box in the Azure portal.

:::image type="content" source="media/quickstart-configure-dev-box-service/dev-box-build-stages.png" alt-text="Graphic showing the stages required to configure Microsoft Dev Box.":::

First, you create a dev center to organize your dev box resources. Next, you configure network components to enable dev boxes to connect to your organizational resources. Then, you create a dev box definition that is used to create dev boxes. After that, you create a project and a dev box pool. Users who have access to a project can create dev boxes from the pools associated with that project.

After you complete this quickstart, you'll have Microsoft Dev Box set up ready for users to create and connect to dev boxes.

If you already have a Microsoft Dev Box configured and you want to learn how to create and connect to dev boxes, refer to: Quickstart: Create a dev box by using the developer portal.

Prerequisites

To complete this quickstart, you need:

  • An Azure account with an active subscription. If you don't have an Azure subscription, create a free account before you begin.
  • Owner or Contributor role on an Azure subscription or resource group.
  • User licenses. To use Dev Box , each user must be licensed for Windows 11 Enterprise or Windows 10 Enterprise, Microsoft Intune, and Azure Active Directory (Azure AD) P1. These licenses are available independently and are included in the following subscriptions:
    • Microsoft 365 F3
    • Microsoft 365 E3, Microsoft 365 E5
    • Microsoft 365 A3, Microsoft 365 A5
    • Microsoft 365 Business Premium
    • Microsoft 365 Education Student Use Benefit
  • Azure Hybrid Benefit, which allows you to use your Windows licenses on Azure with Dev Box.
  • If your organization routes egress traffic through a firewall, open the appropriate ports. For more information, see Network requirements.

1. Create a dev center

Use the following steps to create a dev center so that you can manage your dev box resources:

  1. Sign in to the Azure portal.

  2. In the search box, enter dev centers. In the list of results, select Dev centers.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/discover-dev-centers.png" alt-text="Screenshot that shows the Azure portal with the search box and the result for dev centers.":::

  3. On the Dev centers page, select Create.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-dev-center.png" alt-text="Screenshot that shows the Azure portal with the Create button on the page for dev centers.":::

  4. On the Create a dev center pane, on the Basics tab, enter the following values:

    Name Value
    Subscription Select the subscription in which you want to create the dev center.
    ResourceGroup Select an existing resource group, or select Create new and then enter a name for the new resource group.
    Name Enter a name for your dev center.
    Location Select the location or region where you want the dev center to be created.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-dev-center-basics.png" alt-text="Screenshot that shows the Basics tab on the pane for creating a dev center.":::

    For a list of the currently supported Azure locations with capacity, see Frequently asked questions about Microsoft Dev Box.

  5. (Optional) On the Tags tab, enter a name/value pair that you want to assign.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-dev-center-tags.png" alt-text="Screenshot that shows the Tags tab on the page for creating a dev center.":::

  6. Select Review + Create.

  7. On the Review tab, select Create.

  8. Track the progress of the dev center creation from any page in the Azure portal by opening the Notifications pane.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/notifications-pane.png" alt-text="Screenshot that shows the Notifications pane in the Azure portal.":::

  9. When the deployment is complete, select Go to resource. Confirm that the dev center page appears.

2. Configure a network connection

Network connections determine the region in which dev boxes are deployed. They also allow dev boxes to be connected to your existing virtual networks. The following steps show you how to create and configure a network connection in Microsoft Dev Box .

Create a virtual network and subnet

You must have a virtual network and subnet available for your network connection. To create them:

  1. Sign in to the Azure portal.

  2. In the search box, enter virtual network. In the list of results, select Virtual Network.

  3. On the Virtual Network page, select Create.

  4. On the Create virtual network pane, on the Basics tab, enter the following values:

    Setting Value
    Subscription Select your subscription.
    Resource group Select an existing resource group, or select Create new and then enter a name for the new resource group.
    Name Enter a name for your virtual network.
    Region Enter the location or region where you want the virtual network to be created.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/vnet-basics-tab.png" alt-text="Screenshot that shows the Basics tab on the pane for creating a virtual network in the Azure portal.":::

  5. On the IP Addresses tab, note the default IP address assignment and subnet. You can accept the defaults unless they conflict with your existing configuration.

  6. Select the Review + create tab. Review the virtual network and subnet configuration.

  7. Select Create.

Create the network connection

You now need a network connection to associate the virtual network and subnet with the dev center. A network connection specifies the type of join dev boxes use to join your Azure AD domain, either an Azure AD join or a hybrid Active Directory join.

To create the network connection, complete the steps on the relevant tab.

Azure AD join

  1. Sign in to the Azure portal.

  2. In the search box, enter network connections. In the list of results, select Network connections.

  3. On the Network connections page, select Create.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-network-connection.png" alt-text="Screenshot that shows the page for network connections and the button for creating a connection.":::

  4. On the Create a network connection pane, on the Basics tab, enter the following values:

    Name Value
    Domain join type Select Azure active directory join.
    Subscription Select the subscription in which you want to create the network connection.
    ResourceGroup Select an existing resource group, or select Create new and then enter a name for the new resource group.
    Name Enter a descriptive name for your network connection.
    Virtual network Select the virtual network that you want the network connection to use.
    Subnet Select the subnet that you want the network connection to use.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-nc-native-join.png" alt-text="Screenshot that shows the Basics tab on the pane for creating a network connection, including the option for Azure Active Directory join.":::

  5. Select Review + Create.

  6. On the Review tab, select Create.

  7. When the deployment is complete, select Go to resource. The network connection appears on the Network connections page.

Hybrid Azure AD join

  1. Sign in to the Azure portal.

  2. In the search box, enter network connections. In the list of results, select Network connections.

  3. On the Network connections page, select Create.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-network-connection.png" alt-text="Screenshot that shows the page for network connections and the Create button.":::

  4. On the Create a network connection pane, on the Basics tab, enter the following values:

    Name Value
    Domain join type Select Hybrid Azure active directory join.
    Subscription Select the subscription in which you want to create the network connection.
    ResourceGroup Select an existing resource group, or select Create new and then enter a name for the new resource group.
    Name Enter a descriptive name for your network connection.
    Virtual network Select the virtual network that you want the network connection to use.
    Subnet Select the subnet that you want the network connection to use.
    AD DNS domain name Enter the DNS name of the Active Directory domain that you want to use for connecting and provisioning Cloud PCs. For example: corp.contoso.com.
    Organizational unit Enter the organizational unit (OU). An OU is a container within an Active Directory domain that can hold users, groups, and computers.
    AD username UPN Enter the username, in user principal name (UPN) format, that you want to use for connecting the Cloud PCs to your Active Directory domain. For example: svcDomainJoin@corp.contoso.com. This service account must have permission to join computers to the domain and the target OU (if one is set).
    AD domain password Enter the password for the user.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-nc-hybrid-join.png" alt-text="Screenshot that shows the Basics tab on the pane for creating a network connection, including the option for hybrid Azure Active Directory join.":::

  5. Select Review + Create.

  6. On the Review tab, select Create.

  7. When the deployment is complete, select Go to resource. The network connection appears on the Network connections page.

Attach a network connection to a dev center

To provide network configuration information for dev boxes, associate a network connection with a dev center:

  1. Sign in to the Azure portal.

  2. In the search box, enter dev centers. In the list of results, select Dev centers.

  3. Select the dev center that you created, and then select Networking.

  4. Select + Add.

  5. On the Add network connection pane, select the network connection that you created, and then select Add.

After you attach a network connection, the Azure portal runs several health checks on the network. You can view the status of the checks on the resource overview page. You can add network connections that pass all health checks to a dev center and use them to create dev box pools. Dev boxes that are in dev box pools are created and domain joined in the location of the virtual network that's assigned to the network connection.

:::image type="content" source="./media/quickstart-configure-dev-box-service/network-connection-grid-populated.png" alt-text="Screenshot that shows the status of a network connection.":::

To resolve any errors, see Troubleshoot Azure network connections.

3. Create a dev box definition

Dev box definitions define the image and SKU (compute + storage) that's used in the creation of the dev boxes. To create and configure a dev box definition:

  1. Open the dev center in which you want to create the dev box definition.

  2. Select Dev box definitions.

  3. On the Dev box definitions page, select Create.

  4. On the Create dev box definition page, enter the following values:

    Name Value Note
    Name Enter a descriptive name for your dev box definition.
    Image Select the base operating system for the dev box. You can select an image from Azure Marketplace or from Azure Compute Gallery.
    If you're creating a dev box definition for testing purposes, consider using the Visual Studio 2022 Enterprise on Windows 11 Enterprise + Microsoft 365 Apps 22H2 image.    		 To access custom images when you create a dev box definition, you can use Azure Compute Gallery. For more information, see Configure Azure Compute Gallery.
    Image version Select a specific, numbered version to ensure that all the dev boxes in the pool always use the same version of the image. Select Latest to ensure that new dev boxes use the latest image available. Selecting the Latest image version enables the dev box pool to use the most recent version of your chosen image from the gallery. This way, the created dev boxes stay up to date with the latest tools and code for your image. Existing dev boxes aren't modified when an image version is updated.
    Compute Select the compute combination for your dev box definition.
    Storage Select the amount of storage for your dev box definition.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/recommended-test-image.png" alt-text="Screenshot that shows the page for creating a dev box definition.":::

  5. Select Create.

4. Create a project

Dev box projects enable you to manage team-level settings. These settings include providing access to development teams so that developers can create dev boxes.

To create and configure a project in a dev box:

  1. Sign in to the Azure portal.

  2. In the search box, enter projects. In the list of results, select Projects.

  3. On the Projects page, select Create.

  4. On the Create a project pane, on the Basics tab, enter the following values:

    Name Value
    Subscription Select the subscription in which you want to create the project.
    Resource group Select an existing resource group, or select Create new and then enter a name for the new resource group.
    Dev center Select the dev center that you want to associate with this project. All the settings at the dev center level apply to the project.
    Name Enter a name for the project.
    Description Enter a brief description of the project.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/dev-box-project-create.png" alt-text="Screenshot that shows the Basics tab on the pane for creating a dev box project.":::

  5. (Optional) On the Tags tab, enter a name/value pair that you want to assign.

  6. Select Review + Create.

  7. On the Review tab, select Create.

  8. Confirm that the project is created successfully by checking the notifications. Select Go to resource.

  9. Verify that the project appears on the Projects page.

5. Create a dev box pool

A dev box pool is a collection of dev boxes that have similar settings. Dev box pools specify the dev box definitions and network connections that dev boxes use. You must associate at least one pool with your project before users can create a dev box.

To create a dev box pool that's associated with a project:

  1. Sign in to the Azure portal.

  2. In the search box, enter projects. In the list of results, select Projects.

  3. Open the project in which you want to create the dev box pool.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/select-project.png" alt-text="Screenshot that shows the list of existing projects.":::

  4. Select Dev box pools, and then select Create.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-pool.png" alt-text="Screenshot of an empty list of dev box pools within a project, along with selections to start creating a pool.":::

  5. On the Create a dev box pool pane, enter the following values:

    Name Value
    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.
    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.
    Network connection Select an existing network connection. The network connection determines the region of the dev boxes that are created in this pool.
    Dev box Creator Privileges Select Local Administrator or Standard User.
    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.
    Stop time Select a time to shut down all the dev boxes in the pool. All dev boxes in this pool will shut down at this time every day.
    Time zone Select the time zone that the stop time is in.
    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.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/create-pool-details.png" alt-text="Screenshot of the pane for creating a dev box pool.":::

  6. Select Create.

  7. Verify that the new dev box pool appears in the list. You might need to refresh the screen.

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.

:::image type="content" source="./media/quickstart-configure-dev-box-service/dev-box-pool-grid-populated.png" alt-text="Screenshot that shows a list of dev box pools and status information.":::

6. Provide access to a dev box project

Before users can create dev boxes based on the dev box pools in a project, you must provide access for them through a role assignment. The Dev Box User role enables dev box users to create, manage, and delete their own dev boxes. You must have sufficient permissions to a project before you can add users to it.

To assign roles:

  1. Sign in to the Azure portal.

  2. In the search box, enter projects. In the list of results, select Projects.

  3. Select the project that you want to give team members access to.

    :::image type="content" source="./media/quickstart-configure-dev-box-service/select-project.png" alt-text="Screenshot of the list of existing projects.":::

  4. On the left menu, select Access control (IAM).

    :::image type="content" source="./media/quickstart-configure-dev-box-service/project-permissions.png" alt-text="Screenshot that shows the page for project access control.":::

  5. On the command bar, select Add > Add role assignment.

  6. Assign the following role. For detailed steps, see Assign Azure roles using the Azure portal.

    Setting Value
    Role Select DevCenter Dev Box User.
    Assign access to Select User, group, or service principal.
    Members Select the users or groups that you want to be able to access to the project.

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

    The user can now view the project and all the pools within it. The user can create dev boxes from any of the pools and manage those dev boxes from the developer portal.

[!INCLUDE supported accounts note]

Project Admins

Microsoft Dev Box makes it possible for you to delegate administration of projects to a member of the project team. Project administrators can assist with the day-to-day management of projects for their teams, like creating and managing dev box pools. To give users permissions to manage projects, assign the DevCenter Project Admin role to them.

You can assign the DevCenter Project Admin role by using the steps described earlier in 6. Provide access to a dev box project and select the Project Admin role instead of the Dev Box User role. For more information, see Provide access to projects for project admins.

[!INCLUDE permissions note]

Next steps

In this quickstart, you configured the Microsoft Dev Box resources that are required to enable users to create their own dev boxes. To learn how to create and connect to a dev box, advance to the next quickstart:

[!div class="nextstepaction"] Create a dev box