Skip to content

Commit 501ae67

Browse files
authored
Merge pull request #244124 from MicrosoftDocs/release-ga-dev-box
Release ga dev box--scheduled release at 8am of 7/10
2 parents 8ccad4b + 0b28dae commit 501ae67

File tree

74 files changed

+377
-59
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+377
-59
lines changed

articles/dev-box/concept-common-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: rosemalcolm
88
author: RoseHJM
99
ms.date: 06/23/2023
1010
---
11-
# Components common to Microsoft Dev Box and Azure Deployment Environments
11+
# Components common to Microsoft Dev Box and Azure Deployment Environments
1212

1313
> [!TIP]
1414
> Welcome to the **Microsoft Dev Box** documentation. If you're looking for information about **Azure Deployment Environments**, follow this link: [*Components common to Azure Deployment Environments and Microsoft Dev Box*](../deployment-environments/concept-common-components.md).

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom: template-concept
1111
#Customer intent: As a developer, 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 Preview
14+
# Key concepts for Microsoft Dev Box
1515

1616
This article describes the key concepts and components of Microsoft Dev Box.
1717

@@ -26,7 +26,7 @@ As a dev box user, you have control over your own dev boxes. You can create more
2626
A dev center is a collection of projects that require similar settings. Dev centers enable dev infrastructure managers to:
2727

2828
- Manage the images and SKUs available to the projects by using dev box definitions.
29-
- Configure the networks that the development teams consume by using network connections.
29+
- Configure the networks that the development teams consume by using network connections.
3030

3131
## Project
3232

articles/dev-box/dev-box-faq.yml

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,14 @@ sections:
2727
When you create a generalized VM to capture to an image, the following issues can impact provisioning and startup times:
2828
1. Enable the Read/Write cache on the OS disk.
2929
- To verify, open the Azure portal and navigate to the image. Select **JSON view**, and make sure `properties.storageProfile.osDisk.caching` value is `ReadWrite`.
30-
2. Create the image using the following sysprep options: `/mode:vm flag: Sysprep /generalize /oobe /mode:vm`.
31-
- This prevents a lengthy search for and installation of drivers during the first boot.
30+
2. Create the image using the following sysprep options:
31+
`/mode:vm flag: Sysprep /generalize /oobe /mode:vm`.
32+
- These options prevent a lengthy search for and installation of drivers during the first boot.
3233
3. Enable nested virtualization in your base image.
3334
- In the UI, open **Turn Windows features on or off** and select **Virtual Machine Platform**.
3435
- Or run the following PowerShell command, Enable-WindowsOptionalFeature -FeatureName VirtualMachinePlatform -Online
35-
4. Disable the reserved storage state feature in the image by using the following command: `DISM.exe /Online /Set-ReservedStorageState /State:Disabled`.
36+
4. Disable the reserved storage state feature in the image by using the following command:
37+
`DISM.exe /Online /Set-ReservedStorageState /State:Disabled`.
3638
3739
For more information, see: [Compute gallery image requirements](how-to-configure-azure-compute-gallery.md#compute-gallery-image-requirements).
3840
@@ -42,6 +44,21 @@ sections:
4244
- REST API - [Usages - List By Location - REST API (Azure Dev Center) | Microsoft Learn](/rest/api/devcenter/administrator/usages/list-by-location?tabs=HTTP)
4345
- CLI - [az devcenter admin usage | Microsoft Learn |](/cli/azure/devcenter/admin/usage?view=azure-cli-latest)
4446
47+
- name: Dev Box hibernation
48+
questions:
49+
- question: Can I use auto-stop schedules to hibernate Dev Boxes on a schedule? # Question.
50+
answer:
51+
The ability to use auto-stop schedules to initiate hibernation is in Preview.
52+
53+
- question: I enabled hibernation on a Dev Box definition, but my Dev Box definition reports that hibernation couldn't be enabled. # Question.
54+
answer: |
55+
- We recommend using the Visual Studio for Dev Box marketplace images, either directly, or as base images for generating your custom image.
56+
- The Windows + OS optimizations image contain optimized power settings, and they can't be used with hibernation.
57+
- If you're using a custom Azure Compute Gallery image, enable hibernation on your Azure Compute Gallery image before enabling hibernation on your Dev Box definition.
58+
- If hibernation can't be enabled on the definition even after you enable it on your gallery image, your custom image likely has a Windows configuration that prevents hibernation.
59+
60+
For more information, see [Settings not compatible with hibernation](how-to-configure-dev-box-hibernation.md#settings-not-compatible-with-hibernation).
61+
4562
additionalContent: |
4663
## Next steps
4764

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To learn more about Azure Compute Gallery and how to create galleries, see:
3131
- 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.
3232

3333
> [!NOTE]
34-
> Microsoft Dev Box Preview doesn't support community galleries.
34+
> Microsoft Dev Box doesn't support community galleries.
3535
3636
## Compute gallery image requirements
3737

@@ -62,13 +62,13 @@ The image version must meet the following requirements:
6262
6363
## Provide permissions for services to access a gallery
6464

65-
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 Preview 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.
65+
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.
6666

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

6969
### Add a user-assigned identity to the dev center
7070

71-
1. [Follow the steps to create a user-assigned managed identity](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity).
71+
1. [Follow the steps to create a user-assigned managed identity](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity).
7272
1. Sign in to the [Azure portal](https://portal.azure.com).
7373
1. In the search box, enter **dev box**. In the list of results, select **Dev centers**.
7474
1. Open your dev center. On the left menu, select **Identity**.
@@ -179,4 +179,4 @@ The gallery is detached from the dev center. The gallery and its images aren't d
179179

180180
## Next steps
181181

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

articles/dev-box/how-to-configure-dev-box-azure-diagnostic-logs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ ms.date: 04/28/2023
1212

1313
# Configure Azure diagnostic logs for a dev center
1414

15-
With Azure diagnostic logs for DevCenter, you can view audit logs for dataplane operations in your dev center. These logs can be routed to any of the following destinations:
15+
With Azure diagnostic logs for DevCenter, you can view audit logs for dataplane operations in your dev center. These logs can be routed to any of the following destinations:
1616

1717
* Azure Storage account
1818
* Log Analytics workspace
1919

2020
This feature is available on all dev centers.
2121

22-
Diagnostics logs allow you to export basic usage information from your dev center to different kinds sources so that you can consume them in a customized way. The dataplane audit logs expose information around CRUD operations for dev boxes within your dev center. Including, for example, start and stop commands executed on dev boxes. Some sample ways you can choose to export this data:
22+
Diagnostics logs allow you to export basic usage information from your dev center to different kinds sources so that you can consume them in a customized way. The dataplane audit logs expose information around CRUD operations for dev boxes within your dev center. Including, for example, start and stop commands executed on dev boxes. Some sample ways you can choose to export this data:
2323

2424
* Export data to blob storage, export to CSV.
2525
* Export data to Azure Monitor logs and view and query data in your own Log Analytics workspace
@@ -127,7 +127,7 @@ DevCenter stores data in the following tables.
127127
128128
| Table | Description |
129129
|:---|:---|
130-
| DevCenterDiagnosticLogs | Table used to store dataplane request/response information on dev box or environments within the dev center. |
130+
| DevCenterDiagnosticLogs | Table used to store dataplane request/response information on dev box or environments within the dev center. |
131131
132132
133133
### Sample Kusto Queries
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
title: Configure hibernation for Microsoft Dev Box
3+
titleSuffix: Microsoft Dev Box
4+
description: Learn how to enable, disable and troubleshoot hibernation for your dev boxes.
5+
services: dev-box
6+
ms.service: dev-box
7+
author: RoseHJM
8+
ms.author: rosemalcolm
9+
ms.date: 07/05/2023
10+
ms.topic: how-to
11+
#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.
12+
---
13+
14+
# How to configure Dev Box Hibernation (preview)
15+
16+
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.
17+
18+
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.
19+
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.
21+
22+
> [!IMPORTANT]
23+
> Dev Box Hibernation is currently in PREVIEW.
24+
> 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.
25+
26+
27+
## Key concepts for hibernation-enabled images
28+
29+
- The following SKUs support hibernation: 8, 16 vCPU SKUs. 32 vCPU SKUs do not support hibernation.
30+
31+
- You can enable hibernation only on new dev boxes created with hibernation-enabled dev box definitions. You cannot enable hibernation on existing dev boxes.
32+
33+
- You can hibernate a dev box only using the dev Portal, CLI, PowerShell, SDKs, and API. Hibernating from within the dev box in Windows is not supported.
34+
35+
- If you use a marketplace image, we recommend using the Visual Studio for dev box images.
36+
37+
- The Windows 11 Enterprise CloudPC + OS Optimizations image contains optimized power settings, and they cannot be used with hibernation.
38+
39+
- Once enabled, you cannot disable hibernation on a dev box. However, you can disable hibernation support on the dev box definition so that future dev boxes do not have hibernation.
40+
41+
- To enable hibernation, you need to enable nested virtualization in your Windows OS. If the "Virtual Machine Platform" feature is not enabled in your DevBox image, DevBox will automatically enable nested virtualization for you if you choose to enable hibernation.
42+
43+
- Hibernation doesn't support hypervisor-protected code integrity (HVCI)/ Memory Integrity features. Dev box disables this feature automatically.
44+
45+
- Auto-stop schedules still shutdown the dev boxes. If you want to hibernate your dev box, you can do it through the developer portal or using the CLI.
46+
47+
### Settings not compatible with hibernation
48+
49+
These settings are known to be incompatible with hibernation, and aren't supported for hibernation scenarios:
50+
51+
- **Memory Integrity/Hypervisor Code Integrity.**
52+
53+
To disable Memory Integrity/Hypervisor Code Integrity:
54+
1. In the start menu, search for *memory integrity*
55+
1. Select **Core Isolation**
56+
1. Under **Memory integrity**, ensure that memory integrity is set to Off.
57+
58+
- **Guest Virtual Secure Mode based features without Nested Virtualization enabled.**
59+
60+
To enable Nested Virtualization:
61+
1. In the start menu, search for *Turn Windows features on or off*
62+
1. In Turn Windows features on or off, select **Virtual Machine Platform**, and then select **OK**
63+
64+
## Enable hibernation on your dev box image
65+
66+
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.
67+
68+
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 cannot be modified.
69+
70+
To enable hibernation capabilities, set the `IsHibernateSupported` flag to true:
71+
72+
```azurecli-interactive
73+
az sig image-definition create /
74+
--resource-group <resourcegroupname> --gallery-name <galleryname> --gallery-image-definition <imageName> --location <location> /
75+
--publisher <publishername> --offer <offername> --sku <skuname> --os-type windows --os-state Generalized /
76+
--features "IsHibernateSupported=true SecurityType=TrustedLaunch" --hyper-v-generation V2
77+
```
78+
79+
For more information about creating a custom image, see [Configure a dev box by using Azure VM Image Builder](how-to-customize-devbox-azure-image-builder.md).
80+
81+
## Enable hibernation on a dev box definition
82+
83+
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.
84+
85+
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.
86+
87+
Dev Box validates your image for hibernate support. Your dev box definition may fail validation if hibernation couldn't be successfully enabled using your image.
88+
89+
### Enable hibernation on an existing dev box definition by using the Azure portal
90+
91+
1. Sign in to the [Azure portal](https://portal.azure.com).
92+
93+
1. In the search box, enter **dev center**. In the list of results, select **Dev centers**.
94+
95+
1. Open the dev center that contains the dev box definition that you want to update, and then select **Dev box definitions**.
96+
97+
:::image type="content" source="./media/how-to-configure-dev-box-hibernation/select-dev-box-definitions.png" alt-text="Screenshot that shows the dev center overview page and the menu option for dev box definitions.":::
98+
99+
1. Select the dev box definition that you want to update, and then select the edit button.
100+
101+
:::image type="content" source="./media/how-to-configure-dev-box-hibernation/update-dev-box-definition.png" alt-text="Screenshot of the list of existing dev box definitions and the edit button.":::
102+
103+
1. On the Editing \<dev box definition\> page, select **Enable hibernation**.
104+
105+
:::image type="content" source="./media/how-to-configure-dev-box-hibernation/dev-box-pool-enable-hibernation.png" alt-text="Screenshot of the page for editing a dev box definition, with Enable hibernation selected..":::
106+
107+
1. Select **Save**.
108+
109+
### Update an existing dev box definition by using the CLI
110+
111+
```azurecli-interactive
112+
az devcenter admin devbox-definition update --dev-box-definition-name <DevBoxDefinitionName> -–dev-center-name <devcentername> --resource-group <resourcegroupname> –-hibernateSupport enabled
113+
```
114+
115+
## Disable hibernation on a dev box definition
116+
117+
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.
118+
119+
### Disable hibernation on an existing dev box definition by using the Azure portal
120+
121+
1. Sign in to the [Azure portal](https://portal.azure.com).
122+
123+
1. In the search box, enter **dev center**. In the list of results, select **Dev centers**.
124+
125+
1. Open the dev center that contains the dev box definition that you want to update, and then select **Dev box definitions**.
126+
127+
1. Select the dev box definition that you want to update, and then select the edit button.
128+
129+
1. On the Editing \<dev box definition\> page, clear **Enable hibernation**.
130+
131+
:::image type="content" source="./media/how-to-configure-dev-box-hibernation/dev-box-pool-disable-hibernation.png" alt-text="Screenshot of the page for editing a dev box definition, with Enable hibernation not selected.":::
132+
133+
1. Select **Save**.
134+
135+
### Disable hibernation on an existing dev box definition by using the CLI
136+
137+
```azurecli-interactive
138+
az devcenter admin devbox-definition update --dev-box-definition-name <DevBoxDefinitionName> -–dev-center-name <devcentername> --resource-group <resourcegroupname> –-hibernateSupport disabled
139+
```
140+
141+
## Next steps
142+
143+
- [Create a dev box pool](how-to-manage-dev-box-pools.md)
144+
- [Configure a dev box by using Azure VM Image Builder](how-to-customize-devbox-azure-image-builder.md)
145+
- [How to hibernate your dev box](how-to-hibernate-your-dev-box.md)
146+
- [CLI Reference for az devcenter admin devbox-definition update](/cli/azure/devcenter/admin/devbox-definition?view=azure-cli-latest&preserve-view=true)

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

Lines changed: 4 additions & 4 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 Preview network connections.
4+
description: Learn how to create, delete, attach, and remove Microsoft Dev Box network connections.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -68,11 +68,11 @@ To create a network connection, you need an existing virtual network and subnet.
6868

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

71-
If your organization routes egress traffic through a firewall, you need to open certain ports to allow the Microsoft Dev Box Preview service to function. For more information, see [Network requirements](/windows-365/enterprise/requirements-network).
71+
If your organization routes egress traffic through a firewall, you need to open certain ports to allow the Microsoft Dev Box service to function. For more information, see [Network requirements](/windows-365/enterprise/requirements-network).
7272

7373
## Plan a network connection
7474

75-
The following sections show you how to create and configure a network connection in Microsoft Dev Box Preview.
75+
The following sections show you how to create and configure a network connection in Microsoft Dev Box .
7676

7777
### Types of Active Directory join
7878

@@ -165,7 +165,7 @@ You need to attach a network connection to a dev center before you can use it in
165165

166166
1. Select the dev center that you created, and then select **Networking**.
167167

168-
1. Select **+ Add**.
168+
1. Select **+ Add**.
169169

170170
1. On the **Add network connection** pane, select the network connection that you created earlier, and then select **Add**.
171171

0 commit comments

Comments
 (0)