|
1 | 1 | ---
|
2 | 2 | title: Specify mandatory artifacts for lab virtual machines
|
| 3 | +titleSuffix: Azure DevTest Labs |
3 | 4 | description: Learn how to specify mandatory artifacts to install at creation of every lab virtual machine (VM) in Azure DevTest Labs.
|
4 | 5 | ms.topic: how-to
|
5 | 6 | ms.author: rosemalcolm
|
6 | 7 | author: RoseHJM
|
7 |
| -ms.date: 09/30/2023 |
| 8 | +ms.date: 06/04/2024 |
8 | 9 | ms.custom: UpdateFrequency2
|
| 10 | + |
| 11 | +#customer intent: As a developer, I want to specify mandatory artifacts in Azure DevTest Labs so that I can create new virtual machines that automatically have the mandatory artifacts installed. |
9 | 12 | ---
|
10 | 13 |
|
11 |
| -# Specify mandatory artifacts for DevTest Labs VMs |
| 14 | +# Specify mandatory artifacts for Azure DevTest Labs virtual machines |
| 15 | + |
| 16 | +This article describes how to specify _mandatory artifacts_ in Azure DevTest Labs to install on every lab virtual machine (VM). Artifacts are tools and applications that you can add to your VMs. Mandatory artifacts can include any software that every VM in your lab must have. By defining mandatory artifacts, you can ensure all your lab VMs are installed with standardized, up-to-date artifacts. Lab users don't have to spend time and effort to add needed artifacts individually. |
| 17 | + |
| 18 | +You can create a custom image from a VM that has mandatory artifacts applied to it. When you create new VMs from the custom image, the new VMs also have the mandatory artifacts. |
| 19 | + |
| 20 | +Here are some other considerations: |
| 21 | + |
| 22 | +- Mandatory artifacts can't have configurable parameters. This restriction makes it easier for lab users to create VMs. |
| 23 | +- Mandatory artifacts always install first on a VM before any extra or custom artifacts selected by the user. |
| 24 | +- DevTest Labs always installs the most recent versions of the mandatory artifacts on a VM, even when the base is an "older" custom image. |
12 | 25 |
|
13 |
| -This article describes how to specify mandatory *artifacts* in Azure DevTest Labs to install on every lab virtual machine (VM). Artifacts are tools and applications to add to VMs. Installing mandatory artifacts ensures all lab VMs have standardized, up-to-date artifacts. Lab users don't have to spend time and effort to add needed artifacts individually. |
| 26 | +## Define mandatory artifacts |
14 | 27 |
|
15 |
| -Mandatory artifacts can include any software that every VM in your lab must have. If you create a custom image from a VM that has mandatory artifacts applied to it, and create new VMs from that image, those VMs also have the mandatory artifacts. Even if the custom image is old, VM creation applies the most updated versions of the mandatory artifacts. |
16 |
| - |
17 |
| -Only artifacts that have no parameters can be mandatory artifacts. Lab users don't have to enter extra parameter values, making the VM creation process simple. |
| 28 | +You can select mandatory artifacts for Windows and Linux lab machines separately by following these steps: |
18 | 29 |
|
19 |
| -During VM creation, mandatory artifacts install before any artifacts the user chooses to install on the machine. |
| 30 | +1. In the [Azure portal](https://go.microsoft.com/fwlink/p/?LinkID=525040), go to your DevTest Labs lab resource where you want to define the mandatory artifacts. |
20 | 31 |
|
21 |
| -## Specify mandatory artifacts |
| 32 | +1. On your lab **Overview** page, expand the **Settings** section in the left menu, and select **Configuration and policies**. |
22 | 33 |
|
23 |
| -You can select mandatory artifacts for Windows and Linux lab machines separately. |
| 34 | +1. On the **Configuration and policies** screen, expand the **External resources** section in the left menu, and select **Mandatory artifacts**. |
24 | 35 |
|
25 |
| -1. On your lab's home page, under **Settings** in the left navigation, select **Configuration and policies**. |
26 |
| -1. On the **Configuration and policies** screen, under **External resources** in the left navigation, select **Mandatory artifacts**. |
27 |
| -1. For Windows VMs, select **Windows**, and then select **Edit Windows artifacts**. For Linux VMs, select **Linux**, and then select **Edit Linux artifacts**. |
| 36 | +1. Select the VM configuration: |
28 | 37 |
|
29 |
| -  |
| 38 | + - **Windows**: Select the **Windows** tab, and then select **Edit Windows artifacts**. |
| 39 | + - **Linux**: Select the **Linux** tab, and then select **Edit Linux artifacts**. |
| 40 | + |
| 41 | + :::image type="content" source="./media/devtest-lab-mandatory-artifacts/mandatory-artifacts-edit-button.png" border="false" alt-text="Screenshot that shows how to Edit Windows artifacts for lab virtual machines in the Azure portal." lightbox="./media/devtest-lab-mandatory-artifacts/mandatory-artifacts-edit-button-large.png"::: |
30 | 42 |
|
31 | 43 | 1. On the **Mandatory artifacts** page, select the arrow next to each artifact you want to add to the VM.
|
32 |
| -1. On each **Add artifact** pane, select **OK**. The artifact appears under **Selected artifacts**, and the number of configured artifacts updates. |
33 | 44 |
|
34 |
| -  |
| 45 | +1. On each **Add artifact** pane, select **OK**. The artifact appears under **Selected artifacts**, and the number of configured artifacts updates to show the current list: |
| 46 | + |
| 47 | + :::image type="content" source="./media/devtest-lab-mandatory-artifacts/save-artifacts.png" alt-text="Screenshot that shows how to add mandatory artifacts on the Mandatory artifacts screen." lightbox="./media/devtest-lab-mandatory-artifacts/save-artifacts-large.png"::: |
| 48 | + |
| 49 | +1. Select **Save**. |
| 50 | + |
| 51 | +## Change installation order |
35 | 52 |
|
36 |
| -1. By default, artifacts install in the order you add them. To rearrange the order, select the ellipsis **...** next to the artifact in the **Selected artifacts** list, and select **Move up**, **Move down**, **Move to top**, or **Move to bottom**. To delete the artifact from the list, select **Delete**. |
| 53 | +After you add mandatory artifacts, DevTest Labs updates the **Mandatory artifacts** lists for your lab in the Azure portal. From these lists, you can access the artifacts to change the installation order. When you create a new VM, DevTest Labs installs the **top** artifact in the list first and the **bottom** artifact last. |
37 | 54 |
|
38 |
| -1. When you're done adding and arranging artifacts, select **Save**. |
| 55 | +> [!NOTE] |
| 56 | +> When you create a VM, you can't rearrange or change mandatory artifacts, but you can add more artifacts. For more information, see [Add artifacts to DevTest Labs VMs](add-artifact-vm.md). |
39 | 57 |
|
40 |
| -## Delete or rearrange mandatory artifacts |
| 58 | +To rearrange the order of installation for the mandatory artifacts: |
41 | 59 |
|
42 |
| -After you add mandatory artifacts, the lists of selected artifacts appear on the **Configuration and policies | Mandatory artifacts** screen under **Windows** and **Linux**. You can rearrange or delete the specified mandatory artifacts. |
| 60 | +1. On the **External resources** > **Mandatory artifacts** screen for your lab, select the **Windows** or **Linux** tab. |
43 | 61 |
|
44 |
| -To delete a mandatory artifact from the list, select the checkbox next to the artifact, and then select **Delete**. |
| 62 | +1. Select **Edit Windows artifacts** or **Edit Linux artifacts** to open the **Mandatory artifacts** page. |
45 | 63 |
|
46 |
| - |
| 64 | +1. In the **Selected artifacts** list, select **More options** (...) for the artifact that you want to change. |
47 | 65 |
|
48 |
| -To rearrange the order of the mandatory artifacts: |
| 66 | +1. On the artifact menu, select **Move up**, **Move down**, **Move to top**, or **Move to bottom**. |
49 | 67 |
|
50 |
| -1. Select **Edit Windows artifacts** or **Edit Linux artifacts**. |
51 |
| -1. On the **Mandatory artifacts** page, select the ellipsis **...** next to the artifact in the **Selected artifacts** list. |
52 |
| -1. Select **Move up**, **Move down**, **Move to top**, or **Move to bottom**. |
53 | 68 | 1. Select **Save**.
|
54 | 69 |
|
55 |
| -## See mandatory artifacts for a VM |
| 70 | +## Delete mandatory artifacts |
| 71 | + |
| 72 | +You can also delete artifacts in the **Mandatory artifacts** lists. |
| 73 | + |
| 74 | +> [!NOTE] |
| 75 | +> When you create a VM, you can't delete mandatory artifacts. For more information, see [Add artifacts to DevTest Labs VMs](add-artifact-vm.md). |
| 76 | +
|
| 77 | +1. On the **External resources** > **Mandatory artifacts** screen for your lab, select the **Windows** or **Linux** tab. |
| 78 | + |
| 79 | +1. Select the checkbox next to the artifact in the list, and then select **Delete**: |
| 80 | + |
| 81 | + :::image type="content" source="./media/devtest-lab-mandatory-artifacts/remove-artifact.png" alt-text="Screenshot that shows how to select the Delete option to remove a mandatory artifact." lightbox="./media/devtest-lab-mandatory-artifacts/remove-artifact-large.png"::: |
| 82 | + |
| 83 | +## View mandatory artifacts |
| 84 | + |
| 85 | +After you specify mandatory artifacts for a lab, DevTest Labs shows the mandatory artifacts for all lab VMs based on the operating system (Windows or Linux). When a lab user creates a new VM, they can see the mandatory artifacts that DevTest Labs plans to install. |
| 86 | + |
| 87 | +To view the mandatory artifacts for a VM: |
56 | 88 |
|
57 |
| -Once you specify mandatory artifacts for a lab, all lab VMs for that operating system (Windows or Linux) have those artifacts installed at creation. Lab users can see the mandatory artifacts to be installed on their VMs. |
| 89 | +1. On the **Overview** page for your lab, select **Add**. |
58 | 90 |
|
59 |
| -For example, to see the mandatory artifacts specified for lab Windows VMs in the earlier procedure: |
| 91 | +1. On the **Choose a base** page, select a Marketplace image, such as **Windows 11 Pro**. |
60 | 92 |
|
61 |
| -1. On your lab's home page, select **Add**. |
62 |
| -1. On the **Choose a base** page, select a Windows image, such as **Windows 11 Pro**. |
63 |
| -1. On the **Create lab resource** page, under **Artifacts**, note the number of mandatory artifacts. To see what the mandatory artifacts are, select **Add or Remove Artifacts**. |
| 93 | +1. On the **Create lab resource** page, under **Artifacts**, notice the number of mandatory artifacts for the VM: |
64 | 94 |
|
65 |
| -  |
| 95 | + :::image type="content" source="./media/devtest-lab-mandatory-artifacts/select-message-artifacts.png" alt-text="Screenshot that shows the Create lab resource screen with the number of mandatory artifacts and the Add or Remove Artifacts option."::: |
66 | 96 |
|
67 |
| -1. On the **Add artifacts** screen, an informational message lists the mandatory artifacts to be installed, in order. |
| 97 | +1. To see details about the mandatory artifacts, select **Add or Remove Artifacts**. |
68 | 98 |
|
69 |
| -  |
| 99 | +1. On the **Add artifacts** screen, the mandatory artifacts are listed above the available artifacts. The mandatory artifacts are listed in order of installation from top to bottom: |
70 | 100 |
|
71 |
| -You can't remove, rearrange, or change mandatory artifacts when you create an individual VM. However, you can add other available artifacts to the VM. For more information and instructions, see [Add artifacts to DevTest Labs VMs](add-artifact-vm.md). |
| 101 | + :::image type="content" source="./media/devtest-lab-mandatory-artifacts/save-to-lab.png" alt-text="Screenshot that shows the Add artifacts screen with the list of mandatory artifacts that DevTest Labs plans to install." lightbox="./media/devtest-lab-mandatory-artifacts/save-to-lab-large.png"::: |
72 | 102 |
|
73 |
| -You can also create your own artifacts for VMs. For more information, see [Create custom artifacts for DevTest Labs VMs](devtest-lab-artifact-author.md). |
| 103 | + Extra artifacts selected by the user for the VM instance are shown next to the available list. These artifacts are also listed in order of installation from top to bottom. Extra artifacts are always installed after the mandatory artifacts. |
| 104 | + |
| 105 | + The user can also create new artifacts for their VMs. For more information, see [Create custom artifacts for DevTest Labs VMs](devtest-lab-artifact-author.md). |
74 | 106 |
|
75 |
| -## Next steps |
| 107 | +## Related content |
76 | 108 |
|
77 |
| -- Learn how to [add a Git artifact repository to a lab](add-artifact-repository.md). |
| 109 | +- [Add a Git artifact repository to a lab](add-artifact-repository.md) |
0 commit comments