Skip to content

Commit 0a790bf

Browse files
author
RoseHJM
committed
MDB - Display Names
1 parent 318812b commit 0a790bf

File tree

9 files changed

+66
-0
lines changed

9 files changed

+66
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
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/21/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.png" alt-text="Screenshot showing the properties panel." lightbox="media/how-to-add-project-pool-display-name/properties-panel.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+
> [!Note]
38+
> If there are duplicate display names for a project, the resource name also surfaces in the developer portal to differentiate projects. This is not the case for pools; we recommend creating unique pool names. You can view your changes to the display name in the Azure portal next to the resource name.  
39+
40+
> [!Important]
41+
> Resources created before the rollout of this feature will not have a display name. However, you can still add a display name to these resources.  
42+
43+
44+
## Find resource names in the developer portal
45+
46+
Developers see the display names for projects on the dev box tiles in the Developer Portal.
47+
48+
:::image type="content" source="media/how-to-add-project-pool-display-name/dev-portal-display-names.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.png":::
49+
50+
Developers also see the display names for projects and pools during dev box creation.
51+
52+
:::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":::
53+
54+
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.
55+
56+
:::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":::
57+
58+
> [!Note]
59+
> Changes to display names in the Azure portal may take a few minutes to update everywhere.
60+
61+
## Related content
62+
- [Manage a Microsoft Dev Box project](how-to-manage-dev-box-projects.md)
63+
- [Manage a dev box pool in Microsoft Dev Box](how-to-manage-dev-box-pools.md)
64+
- [Manage a dev box by using the Microsoft Dev Box developer portal](how-to-create-dev-boxes-developer-portal.md)
50.5 KB
Loading
75.9 KB
Loading
292 KB
Loading
3.52 KB
Loading
48.2 KB
Loading
89.7 KB
Loading
10.7 KB
Loading

articles/dev-box/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ items:
4141
href: how-to-manage-dev-box-definitions.md
4242
- name: Manage a dev box pool
4343
href: how-to-manage-dev-box-pools.md
44+
- name: Display names for a project or pool
45+
href: how-to-add-project-pool-display-name.md
4446
- name: Limit number of dev boxes per project
4547
href: tutorial-dev-box-limits.md
4648
- name: Configure Visual Studio caches

0 commit comments

Comments
 (0)