| title | description | ms.topic | ms.date | ms.custom |
|---|---|---|---|---|
Attach or detach an Azure Compute Gallery in Azure Lab Services | Microsoft Docs |
This article describes how to attach an Azure Compute Gallery to a lab in Azure Lab Services. |
how-to |
04/06/2022 |
devdivchpfy22 |
[!INCLUDE preview note]
Note
If using a version of Azure Lab Services prior to the April 2022 Update (preview), see Attach or detach a shared image gallery to a lab account in Azure Lab Services.
This article shows you how to attach or detach an Azure Compute Gallery to a lab plan.
Important
Lab plan administrators must manually replicate images to other regions in the compute gallery. Replicate an Azure Compute Gallery image to the same region as the lab plan to be shown in the list of virtual machine images during lab creation.
Saving images to a compute gallery and replicating those images incurs additional cost. This cost is separate from the Azure Lab Services usage cost. For more information about Azure Compute Gallery pricing, see Azure Compute Gallery – Billing.
Here are a couple of scenarios supported by attaching a compute gallery.
- A lab plan admin attaches a compute gallery to the lab plan. An image is uploaded to the compute gallery outside the context of a lab. The image is enabled on the lab plan by the lab plan admin. Then, lab creators can use that image from the compute gallery to create labs.
- A lab plan admin attaches a compute gallery to the lab plan. A lab creator (educator) saves the customized image of their lab to the compute gallery. Then, other lab creators can select this image from the compute gallery to create a template for their labs.
When you save a template image of a lab in Azure Lab Services, the image is uploaded to the compute gallery as a specialized image. Specialized images keep machine-specific information and user profiles. You can still directly upload a generalized image to the gallery outside of Azure Lab Services.
A lab creator can create a template VM based on both generalized and specialized images in Azure Lab Services.
Important
While using an Azure Compute Gallery, Azure Lab Services supports only images that use less than 128 GB of disk space on their OS drive. Images with more than 128 GB of disk space or multiple disks won't be shown in the list of virtual machine images during lab creation.
Important
Your user account must have permission to create a new Azure Compute Gallery.
-
Open your lab plan in the Azure portal.
-
Select Azure compute gallery on the menu.
-
Select the Create Azure compute gallery button.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/no-gallery-create-new.png" alt-text="Screenshot of the Create Azure compute gallery button.":::
-
In the Create Azure compute gallery window, enter a name for the gallery, and then select Create.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/create-azure-compute-gallery-window.png" alt-text="Screenshot of the Create compute gallery window.":::
Azure Lab Services creates the compute gallery and attaches it to the lab plan. All labs created using this lab plan can now use images from the attached compute gallery.
In the bottom pane, you see images in the compute gallery. There are no images in this new gallery. When you upload images to the gallery, you see them on this page.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/attached-gallery-empty-list.png" alt-text="Attached image gallery list of images.":::
The following procedure shows you how to attach an existing compute gallery to a lab plan.
-
Open your lab plan in the Azure portal.
-
Select Azure compute gallery on the menu.
-
Select the Attach existing gallery button.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/no-gallery-attach-existing.png" alt-text="Screenshot of the Attach existing gallery button.":::
-
On the Attach an existing compute gallery page, select your compute gallery, and then select the Select button.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/attach-existing-compute-gallery.png" alt-text="Azure compute gallery page for lab plan when gallery has been attached.":::
Note
The Azure Lab Services app must be assigned the Owner role on the compute gallery to show in the list.
All labs created using this lab plan can now use images from the attached compute gallery.
All images in the attached compute gallery are disabled by default. To enable selected images:
- Check images you want to enable.
- Select Enable image button.
- Select Apply.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/enable-attached-gallery-image.png" alt-text="Enable an imaged for an attached compute gallery.":::
To disable selected images:
- Check images you want to disable.
- Select Disable image button.
- Select Apply.
To detach a compute gallery from your lab, select Detach on the toolbar. Confirm the detach operation.
Only one Azure Compute Gallery can be attached to a lab. To attach another compute gallery, follow the below steps:
- Select Change gallery on the toolbar.
- Confirm the change operation.
- On the Attach an existing compute gallery page, select your compute gallery, and then select the Select button.
:::image type="content" source="./media/how-to-attach-detach-shared-image-gallery/attached-gallery-detach.png" alt-text="Detach the compute gallery from the lab plan":::
To learn how to save a template image to the compute gallery or use an image from the compute gallery, see How to use a compute gallery.
To explore other options for bringing custom images to compute gallery outside of the context of a lab, see Recommended approaches for creating custom images.
For more information about compute galleries in general, see compute gallery.