|
| 1 | +--- |
| 2 | +title: Add a display name to projects and pools |
| 3 | +description: Learn how to add clarity for developers by adding a display name to Projects and Pools to rename resources. |
| 4 | +author: iyervarsha |
| 5 | +ms.author: varshaiyer |
| 6 | +ms.service: devbox |
| 7 | +ms.topic: article |
| 8 | +ms.date: 05/28/2024 |
| 9 | +--- |
| 10 | + |
| 11 | +# Add a display name to projects and pools |
| 12 | + |
| 13 | +Display names create a friendly name to use for resources that developers can view and use in the developer portal. You can add a display name to projects and pools after creating resources. Display names are helpful in several circumstances like: |
| 14 | + |
| 15 | +- **Renaming projects/ resources:** If your current resource names are confusing dev box users, you can create a separate display name to communicate to developers. |
| 16 | + |
| 17 | +- **Reorganizations:** Rename your projects and pools as developers move to new teams. |
| 18 | + |
| 19 | +- **Resource Degradation:** Mark your projects and pools to communicate legacy resources to developers. |
| 20 | + |
| 21 | +## Edit display names |
| 22 | + |
| 23 | +The display name for your projects and pools automatically defaults to its resource name during project creation. The resource name and display name are initially the same. |
| 24 | + |
| 25 | +To edit the project display name, go to the properties panel of the project. Modify the display name under the **Display Name** text box, then select **Apply**. |
| 26 | + |
| 27 | +:::image type="content" source="media/how-to-add-project-pool-display-name/properties-panel-small.png" alt-text="Screenshot showing the properties panel." lightbox="media/how-to-add-project-pool-display-name/properties-panel-large.png"::: |
| 28 | + |
| 29 | +To edit the display name for a pool, select the ellipses associated with the pool, and then select **Edit**. |
| 30 | + |
| 31 | +:::image type="content" source="media/how-to-add-project-pool-display-name/pool-edit.png" alt-text="Screenshot showing the edit button for a pool." lightbox="media/how-to-add-project-pool-display-name/pool-edit.png"::: |
| 32 | + |
| 33 | +You see a similar **Display Name** text box for pools as you did for projects. Enter a display name and save your changes. |
| 34 | + |
| 35 | +:::image type="content" source="media/how-to-add-project-pool-display-name/pool-properties.png" alt-text="Screenshot showing the properties for a pool." lightbox="media/how-to-add-project-pool-display-name/pool-properties.png"::: |
| 36 | + |
| 37 | +> [!Important] |
| 38 | +> Resources created before the release of the display names feature will not have a display name. However, you can still add a display name to these resources. |
| 39 | +
|
| 40 | +### Duplicate display names |
| 41 | + |
| 42 | +You should create unique display names for projects and pools. |
| 43 | + |
| 44 | +When you're creating a dev box in the developer portal, if there are duplicate display names for a project the resource name appears in the project list alongside the display name to differentiate projects. |
| 45 | + |
| 46 | +Pools with duplicate names don't show the resource name in the developer portal; you should create unique pool names to avoid confusion. You can view your changes to the display name in the Azure portal next to the resource name. |
| 47 | + |
| 48 | +## Find resource names in the developer portal |
| 49 | + |
| 50 | +Developers see the display names for projects on the dev box tiles in the Developer Portal. |
| 51 | + |
| 52 | +:::image type="content" source="media/how-to-add-project-pool-display-name/dev-portal-display-names-small.png" alt-text="Screenshot showing the dev box tile in the developer portal." lightbox="media/how-to-add-project-pool-display-name/dev-portal-display-names-large.png"::: |
| 53 | + |
| 54 | +Developers also see the display names for projects and pools during dev box creation. |
| 55 | + |
| 56 | +:::image type="content" source="media/how-to-add-project-pool-display-name/dev-portal-display-names-during-creation.png" alt-text="Screenshot showing display names on the dev box creation pane." lightbox="media/how-to-add-project-pool-display-name/dev-portal-display-names-during-creation.png"::: |
| 57 | + |
| 58 | +To view information on the pool resource name for the associated dev box, view the Support panel of the developer portal. You see both the resource name and display name for the associated pool. |
| 59 | + |
| 60 | +:::image type="content" source="media/how-to-add-project-pool-display-name/dev-portal-support-panel.png" alt-text="Screenshot showing the support panel in the developer portal." lightbox="media/how-to-add-project-pool-display-name/dev-portal-support-panel.png"::: |
| 61 | + |
| 62 | +> [!Note] |
| 63 | +> Changes to display names in the Azure portal may take a few minutes to update everywhere. |
| 64 | +
|
| 65 | +## Related content |
| 66 | +- [Manage a Microsoft Dev Box project](how-to-manage-dev-box-projects.md) |
| 67 | +- [Manage a dev box pool in Microsoft Dev Box](how-to-manage-dev-box-pools.md) |
| 68 | +- [Manage a dev box by using the Microsoft Dev Box developer portal](how-to-create-dev-boxes-developer-portal.md) |
0 commit comments