Skip to content

Commit 9e794c7

Browse files
Merge pull request #256270 from ntrogh/mdb-seo-202310
[Microsoft Dev Box] Implement changes for SEO
2 parents b3cd183 + 3bd167f commit 9e794c7

16 files changed

Lines changed: 218 additions & 141 deletions

articles/dev-box/concept-dev-box-concepts.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Microsoft Dev Box key concepts
3-
description: Learn key concepts and terminology for Microsoft Dev Box.
3+
description: Learn key concepts and terminology for Microsoft Dev Box. Get an understanding about dev center, dev box, dev box definitions, and dev box pools.
44
services: dev-box
55
ms.service: dev-box
66
author: RoseHJM
@@ -11,12 +11,14 @@ ms.custom: template-concept
1111
#Customer intent: As a platform engineer, I want to understand Dev Box concepts and terminology so that I can set up a Dev Box environment.
1212
---
1313

14-
# Key concepts for Microsoft Dev Box
14+
# Key concepts for Microsoft Dev Box
1515

16-
This article describes the key concepts and components of Microsoft Dev Box.
16+
This article describes the key concepts and components of Microsoft Dev Box to help you set up the service successfully.
1717

18-
As you learn about Microsoft Dev Box, you'll also encounter components of [Azure Deployment Environments](../deployment-environments/overview-what-is-azure-deployment-environments.md), a complementary service that shares certain architectural components. Deployment Environments provides developers with preconfigured cloud-based environments for developing applications.
18+
Microsoft Dev Box gives developers self-service access to preconfigured, and ready-to-code cloud-based workstations. You can configure the service to meet your development team and project structure, and manage security and network settings to access resources securely. Different components play a part in the configuration of Microsoft Dev Box.
1919

20+
Microsoft Dev Box builds on the same foundations as [Azure Deployment Environments](/azure/deployment-environments/overview-what-is-azure-deployment-environments). Deployment Environments provides developers with preconfigured cloud-based environments for developing applications. Both services are complementary and share certain architectural components, such as a [dev center](#dev-center) or [project](#project).
21+
2022
## Dev center
2123

2224
A dev center is a collection of [Projects](#project) that require similar settings. Dev centers enable platform engineers to:

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

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configure Azure Compute Gallery
33
titleSuffix: Microsoft Dev Box
4-
description: Learn how to create an Azure Compute Gallery repository for managing and sharing Dev Box images.
4+
description: Learn how to create and attach an Azure compute gallery to a dev center in Microsoft Dev Box. Use a compute gallery to manage and share dev box images.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -12,7 +12,11 @@ ms.topic: how-to
1212

1313
# Configure Azure Compute Gallery for Microsoft Dev Box
1414

15-
Azure Compute Gallery is a service for managing and sharing images. A gallery is a repository that's stored in your Azure subscription and helps you build structure and organization around your image resources. You can use a gallery to provide custom images for your dev box users.
15+
In this article, you learn how to configure and attach an Azure compute gallery to a dev center in Microsoft Dev Box. With Azure Compute Gallery, you can give developers customized images for their dev box.
16+
17+
Azure Compute Gallery is a service for managing and sharing images. A gallery is a repository that's stored in your Azure subscription and helps you build structure and organization around your image resources.
18+
19+
After you attach a compute gallery to a dev center in Microsoft Dev Box, you can create dev box definition based on images stored in the compute gallery.
1620

1721
Advantages of using a gallery include:
1822

@@ -29,15 +33,15 @@ To learn more about Azure Compute Gallery and how to create galleries, see:
2933

3034
- A dev center. If you don't have one available, follow the steps in [Create a dev center](quickstart-configure-dev-box-service.md#1-create-a-dev-center).
3135
- A compute gallery. Images stored in a compute gallery can be used in a dev box definition, provided they meet the requirements listed in the [Compute gallery image requirements](#compute-gallery-image-requirements) section.
32-
36+
3337
> [!NOTE]
3438
> Microsoft Dev Box doesn't support community galleries.
3539
3640
## Compute gallery image requirements
3741

3842
A gallery used to configure dev box definitions must have at least [one image definition and one image version](../virtual-machines/image-version.md).
3943

40-
When creating a virtual machine image, select an image from the marketplace that is Dev Box compatible, like the following examples:
44+
When you create a virtual machine image, select an image from the Azure Marketplace that is compatible with Microsoft Dev Box. The following are examples of compatible images:
4145
- [Visual Studio 2019](https://azuremarketplace.microsoft.com/marketplace/apps/microsoftvisualstudio.visualstudio2019plustools?tab=Overview)
4246
- [Visual Studio 2022](https://azuremarketplace.microsoft.com/marketplace/apps/microsoftvisualstudio.visualstudioplustools?tab=Overview)
4347

@@ -63,12 +67,12 @@ The image version must meet the following requirements:
6367
:::image type="content" source="media/how-to-configure-azure-compute-gallery/image-definition.png" alt-text="Screenshot that shows Windows 365 image requirement settings.":::
6468

6569
> [!NOTE]
66-
> - Dev Box image requirements exceed [Windows 365 image requirements](/windows-365/enterprise/device-images) and include settings to optimize dev box creation time and performance.
70+
> - Microsoft Dev Box image requirements exceed [Windows 365 image requirements](/windows-365/enterprise/device-images) and include settings to optimize dev box creation time and performance.
6771
> - Images that do not meet Windows 365 requirements will not be listed for creation.
6872
6973
## Provide permissions for services to access a gallery
7074

71-
When you use an Azure Compute Gallery image to create a dev box definition, the Windows 365 service validates the image to ensure that it meets the requirements to be provisioned for a dev box. The Dev Box service replicates the image to the regions specified in the attached network connections, so the images are present in the region that's required for dev box creation.
75+
When you use an Azure Compute Gallery image to create a dev box definition, the Windows 365 service validates the image to ensure that it meets the requirements to be provisioned for a dev box. Microsoft Dev Box replicates the image to the regions specified in the attached network connections, so the images are present in the region that's required for dev box creation.
7276

7377
To allow the services to perform these actions, you must provide permissions to your gallery as follows.
7478

@@ -85,7 +89,7 @@ To allow the services to perform these actions, you must provide permissions to
8589

8690
### Assign roles
8791

88-
The Dev Box service behaves differently depending how you attach your gallery:
92+
Microsoft Dev Box behaves differently depending how you attach your gallery:
8993

9094
- When you use the Azure portal to attach the gallery to your dev center, the Dev Box service creates the necessary role assignments automatically after you attach the gallery.
9195
- When you use the Azure CLI to attach the gallery to your dev center, you must manually create the Windows 365 service principal and the dev center's managed identity role assignments before you attach the gallery.
@@ -130,7 +134,7 @@ You can use the same managed identity in multiple dev centers and compute galler
130134

131135
## Attach a gallery to a dev center
132136

133-
To use the images from a gallery in dev box definitions, you must first associate the gallery with the dev center by attaching it:
137+
To use the images from a compute gallery in dev box definitions, you must first associate the gallery with the dev center by attaching it:
134138

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

@@ -183,6 +187,6 @@ You can detach galleries from dev centers so that their images can no longer be
183187

184188
The gallery is detached from the dev center. The gallery and its images aren't deleted, and you can reattach it if necessary.
185189

186-
## Next steps
190+
## Related content
187191

188192
- Learn more about [key concepts in Microsoft Dev Box](./concept-dev-box-concepts.md).

articles/dev-box/how-to-configure-dev-box-hibernation.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configure hibernation for Microsoft Dev Box
33
titleSuffix: Microsoft Dev Box
4-
description: Learn how to enable, disable and troubleshoot hibernation for your dev boxes. Configure hibernation settings for your image and dev box definition.
4+
description: Learn how to enable, disable, and troubleshoot hibernation in Microsoft Dev Box. Configure hibernation settings for your image and dev box definition.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -11,19 +11,24 @@ ms.topic: how-to
1111
#Customer intent: As a platform engineer, I want dev box users to be able to hibernate their dev boxes as part of my cost management strategy and so that dev box users can resume their work where they left off.
1212
---
1313

14-
# Configure Dev Box Hibernation (preview) for a dev box definition
14+
# Configure hibernation in Microsoft Dev Box
15+
16+
In this article, you learn how to enable and disable hibernation in Microsoft Dev Box. You control hibernation at the dev box image and dev box definition level.
1517

1618
Hibernating dev boxes at the end of the workday can help you save a substantial portion of your VM costs. It eliminates the need for developers to shut down their dev box and lose their open windows and applications.
1719

1820
With the introduction of Dev Box Hibernation (Preview), you can enable this capability on new dev boxes and hibernate and resume them. This feature provides a convenient way to manage your dev boxes while maintaining your work environment.
1921

20-
There are two steps in enabling hibernation; you must enable hibernation on your dev box image and enable hibernation on your dev box definition.
22+
There are two steps to enable hibernation:
23+
24+
1. Enable hibernation on your dev box image
25+
1. Enable hibernation on your dev box definition
2126

2227
> [!IMPORTANT]
2328
> Dev Box Hibernation is currently in PREVIEW.
2429
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
2530
26-
## Key concepts for hibernation-enabled images
31+
## Considerations for hibernation-enabled images
2732

2833
- The following SKUs support hibernation: 8, 16 vCPU SKUs. 32 vCPU SKUs do not support hibernation.
2934

@@ -63,13 +68,14 @@ These settings are known to be incompatible with hibernation, and aren't support
6368
1. In the start menu, search for *Turn Windows features on or off*
6469
1. In Turn Windows features on or off, select **Virtual Machine Platform**, and then select **OK**
6570

66-
## Enable hibernation on your dev box image
71+
## Enable hibernation on your dev box image
6772

68-
The Visual Studio and Microsoft 365 images that Dev Box provides in the Azure Marketplace are already configured to support hibernation. You don't need to enable hibernation on these images, they're ready to use.
73+
If you plan to use a custom image from an Azure compute gallery, you need to enable hibernation capabilities when you create the new image. You can't enable hibernation for existing images.
6974

70-
If you plan to use a custom image from an Azure Compute Gallery, you need to enable hibernation capabilities as you create the new image. To enable hibernation capabilities, set the IsHibernateSupported flag to true. You must set the IsHibernateSupported flag when you create the image, existing images can't be modified.
75+
> [!NOTE]
76+
> The Visual Studio and Microsoft 365 images that Microsoft Dev Box provides in the Azure Marketplace are already configured to support hibernation. You don't need to enable hibernation on these images, they're ready to use.
7177
72-
To enable hibernation capabilities, set the `IsHibernateSupported` flag to true:
78+
To enable hibernation capabilities, set the `IsHibernateSupported` flag to `true` when you create the image:
7379

7480
```azurecli
7581
az sig image-definition create
@@ -90,15 +96,15 @@ For more information about creating a custom image, see [Configure a dev box by
9096

9197
## Enable hibernation on a dev box definition
9298

93-
You can enable hibernation as you create a dev box definition, providing that the dev box definition uses a hibernation-enabled custom or marketplace image. You can also update an existing dev box definition that uses a hibernation-enabled custom or marketplace image.
99+
In Microsoft Dev Box, you enable hibernation for a dev box definition, providing that the dev box definition uses a hibernation-enabled custom or marketplace image. You can also update an existing dev box definition that uses a hibernation-enabled custom or marketplace image.
94100

95101
All new dev boxes created in dev box pools that use a dev box definition with hibernation enabled can hibernate in addition to shutting down. If a pool has dev boxes that were created before hibernation was enabled, they continue to only support shutdown.
96102

97-
Dev Box validates your image for hibernate support. Your dev box definition might fail validation if hibernation couldn't be successfully enabled using your image.
103+
Microsoft Dev Box validates your image for hibernate support. Your dev box definition might fail validation if hibernation couldn't be successfully enabled using your image.
98104

99105
You can enable hibernation on a dev box definition by using the Azure portal or the CLI.
100106

101-
### Enable hibernation on an existing dev box definition by using the Azure portal
107+
### Enable hibernation for a dev box definition by using the Azure portal
102108

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

@@ -118,7 +124,7 @@ You can enable hibernation on a dev box definition by using the Azure portal or
118124

119125
1. Select **Save**.
120126

121-
### Update an existing dev box definition by using the CLI
127+
### Enable hibernation for a dev box definition by using the Azure CLI
122128

123129
```azurecli
124130
az devcenter admin devbox-definition update
@@ -127,11 +133,11 @@ az devcenter admin devbox-definition update
127133

128134
## Disable hibernation on a dev box definition
129135

130-
If you have issues provisioning new VMs after enabling hibernation on a pool or you want to revert to shut down only dev boxes, you can disable hibernation on the dev box definition.
136+
If you have issues provisioning new VMs after enabling hibernation on a pool or you want to revert to shut down only dev boxes, you can disable hibernation on the dev box definition.
131137

132138
You can disable hibernation on a dev box definition by using the Azure portal or the CLI.
133139

134-
### Disable hibernation on an existing dev box definition by using the Azure portal
140+
### Disable hibernation for a dev box definition by using the Azure portal
135141

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

@@ -147,14 +153,14 @@ You can disable hibernation on a dev box definition by using the Azure portal or
147153

148154
1. Select **Save**.
149155

150-
### Disable hibernation on an existing dev box definition by using the CLI
156+
### Disable hibernation for a dev box definition by using the CLI
151157

152158
```azurecli
153159
az devcenter admin devbox-definition update
154160
--dev-box-definition-name <DevBoxDefinitionName> -–dev-center-name <devcentername> --resource-group <resourcegroupname> –-hibernateSupport disabled
155161
```
156162

157-
## Next steps
163+
## Related content
158164

159165
- [Create a dev box pool](how-to-manage-dev-box-pools.md)
160166
- [Configure a dev box by using Azure VM Image Builder](how-to-customize-devbox-azure-image-builder.md)

articles/dev-box/how-to-configure-network-connections.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configure network connections
33
titleSuffix: Microsoft Dev Box
4-
description: Learn how to create, delete, attach, and remove Microsoft Dev Box network connections.
4+
description: Learn how to manage network connections for a dev center in Microsoft Dev Box. Use network connections to connect to virtual network or enable connecting to on-premises resources from a dev box.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -13,7 +13,9 @@ ms.topic: how-to
1313

1414
# Connect dev boxes to resources by configuring network connections
1515

16-
Network connections allow dev boxes to connect to existing virtual networks. They also determine the region into which dev boxes are deployed.
16+
In this article, you learn how to manage network connections for a dev center in Microsoft Dev Box. Network connections enable dev boxes to connect to existing virtual networks. In addition, you can configure the network settings to enable connecting to on-premises resources from your dev box. The location, or Azure region, of the network connection determines where associated dev boxes are hosted.
17+
18+
You need to add at least one network connection to a dev center in Microsoft Dev Box.
1719

1820
When you're planning network connectivity for your dev boxes, you must:
1921

@@ -48,7 +50,7 @@ To create a network connection, you need an existing virtual network and subnet.
4850
| ------- | ----- |
4951
| **Subscription** | Select your subscription. |
5052
| **Resource group** | Select an existing resource group. Or create a new one by selecting **Create new**, entering **rg-name**, and then selecting **OK**. |
51-
| **Name** | Enter **VNet-name**. |
53+
| **Name** | Enter *VNet-name*. |
5254
| **Region** | Select the region for the virtual network and dev boxes. |
5355

5456
:::image type="content" source="./media/how-to-manage-network-connection/example-basics-tab.png" alt-text="Screenshot of the Basics tab on the pane for creating a virtual network in the Azure portal." border="true":::
@@ -64,7 +66,7 @@ To create a network connection, you need an existing virtual network and subnet.
6466

6567
1. Select **Create**.
6668

67-
## Allow access to Dev Box endpoints from your network
69+
## Allow access to Microsoft Dev Box endpoints from your network
6870

6971
An organization can control network ingress and egress by using a firewall, network security groups, and even Microsoft Defender.
7072

@@ -76,7 +78,7 @@ The following sections show you how to create and configure a network connection
7678

7779
### Types of Active Directory join
7880

79-
The Dev Box service requires a configured and working Active Directory join, which defines how dev boxes join your domain and access resources. There are two choices:
81+
Microsoft Dev Box requires a configured and working Active Directory join, which defines how dev boxes join your domain and access resources. There are two choices:
8082

8183
- **Microsoft Entra join**: If your organization uses Microsoft Entra ID, you can use a Microsoft Entra join (sometimes called a native Microsoft Entra join). Dev box users sign in to Microsoft Entra joined dev boxes by using their Microsoft Entra account and access resources based on the permissions assigned to that account. Microsoft Entra join enables access to cloud-based and on-premises apps and resources.
8284

@@ -201,7 +203,7 @@ You can remove a network connection from a dev center if you no longer want to u
201203

202204
The network connection is no longer available for use in the dev center.
203205

204-
## Next steps
206+
## Related content
205207

206208
- [Manage a dev box definition](how-to-manage-dev-box-definitions.md)
207209
- [Manage a dev box pool](how-to-manage-dev-box-pools.md)

0 commit comments

Comments
 (0)