Add Version to an Existing Microsoft Azure Compute Gallery Image

There are two types of existing image versions, Microsoft Azure Compute Gallery and Microsoft Azure Custom VM. Select the appropriate one and follow it's procedure below.

Add a Version to an Existing Compute Gallery Image

You can add new versions to your existing Microsoft Azure Compute Gallery images, without the need to clone a version. Only a similar type of image can be added as a version of an existing image.

Procedure

1. From the Horizon Cloud Console Home page, select Images in the left menu.

2. On the Images page, select the Image Name you want to version. Click Add.

3. Under Source, you will see a box that says Microsoft Azure Compute Gallery, click Next.

4. Under Source Details, in the Destination sub-section, select the Site, Horizon Edge, and Provider.

5. Under Source image version details sub-section, add the Microsoft Entra ID Tenant ID from the Microsoft Azure portal. Add the Resource ID obtained from the Microsoft Azure portal Active Directory properties by clicking on the JSON View link located on the image version of the image definition. If image was published using Horizon Universal Console, this ID can be obtained in the console from the Location Path column of the Image Copies grid on the Image version details page.

   Ensure that the primary provider of selected destination Horizon Edge has Microsoft Azure RBAC read access to the source image or resource group containing the image. Also, ensure that the source image is already published with the Horizon agent.

6. For Image Attributes, select either Copy from source image or Override.

   • If you select Copy from source for image, add the Organization ID of the account which published the image using Horizon Universal Console. You can obtain this ID in the User/Organization Settings of that account. For the Copy from source for image option, attributes from the source image version are used.

     The OS Name, OS Type, and Session Type are automatically copied from the source image. If you are supported by a Managed Services Provider (MSP), you can copy the image from the MSP Organization provider to your provider. This process leverages a published source image in the Horizon catalog corresponding to an external organization (MSP) other than your own organization. The MSP provides a complete image including the details of the application residing in the server or multi-session image.

     The Copy from source for image option is applicable when you want to add a version by using an existing Horizon image version available in your MSP Organization's catalog.

     When a Linux operating system is selected, select the appropriate license type based on the OS distribution:

     • Red Hat Enterprise Linux: Choose either Pay as you go (PAYG) or Bring your own subscription (BYOS).

       The BYOS option requires Red Hat products for Cloud Access on Azure to be enabled for the subscription.

     • Ubuntu: Only Pay as you go (PAYG) is available.

   • If you select Override, you must select the OS, OS Type, and Session type. The Override option is applicable when you want to copy a source image that is not in your Horizon catalog. For example, you might want to copy an image from an external subscription that is readable by the Horizon provider’s subscription.

     When you add an external image, make sure that the source image has the latest Horizon agent installed. Otherwise, the VMs that are created as part of desktop/server pools on this image might encounter an error.

     Make sure that the publisher, offer, and SKU of the Microsoft Azure Marketplace Image used for source image creation is set in Image definition under source Azure Compute Gallery. Publisher, offer, and SKU values must match the existing list of supported images listed when importing a new Azure Marketplace Image.

     A source image is an already published image that is generalized with the necessary agent and software. Thus, a copy of the same image into customer organization can be directly used by pools. It could also be re-published to other subscriptions or regions. Your provider must have appropriate RBAC access to the source image.

7. Under the VM details sub-section, select the VM Model Type and VM Model. Note: In the VM Model list, only VM models that have the same generation type as the image are listed.

8. Under the Admin credentials for VM sub-section, add a unique Username and Password for the local admin account to access the image operating system, and to use during the image conversion process.

9. Select Windows license with Software Assurance when adding Windows-based images and click Next.

10. Under the Target Version section, select the Version Type as Major or Minor.

    • If you select Major, the Expected Version Number gets populated automatically, based on your selection and the previously existing versions of the image.
    • If you select Minor, select Add Version first to add the Major Version number that the Minor version will then go under. The Minor version will automatically populate the next Expected Version Number.

11. In the Markers field, add unique names to any new markers and they will be saved when the image is saved.

Adding a Version to an Existing Image with Microsoft Azure Custom VM

You can add new versions into your existing Microsoft Azure Compute Gallery Images, without the need to clone a version. Only a similar type of image can be added as a version of an existing image.

Note: We also support adding a new version to an existing image using a custom VM that is on a Microsoft Azure dedicated host.

Procedure

1. From the Horizon Universal Console, select Images in the left menu.

2. On the Images page, click on the Image Name you want to version. Click Add.

3. Under Source, you will see a box that says Microsoft Azure Custom VM, click Next.

4. Under Source Details in the Destination sub-section, select the Site, Horizon Edge, and Provider.

5. Under General Information, add a unique Image Name and click Next.

   The image version is automatically appended to the name with dashes to create the image copy name (Image-1-0, Image-1-100).

6. Add a unique Description of the image.

7. In the Markers field, add unique names to any new markers and they will be saved when the image is saved.

8. Under the Image Source section, select Microsoft Azure Custom VM and click Next.

9. Under the Destination sub-section, select the Site, Horizon Edge, and Provider.

10. Under the VM details sub-section, select a VM.

    For this VM selection, the Azure resource group must be selected beforehand from the drop-down list. While both resource groups contain the name pattern hcs-<ProviderInstance_Id>-base-vms, select the appropriate resource group that is applicable to your existing Microsoft Azure Edge. All custom VMs must be part of the selected resource group. Also, the image and any other related resources will be in the same resource group. You can obtain the resource group name in the Microsoft Azure portal, on the VM details page.

    Note: In the Select VM list, only custom VMs that have the same generation type as the image are listed.

11. Select the OS type of this Custom VM. Important: You can not verify the OS type of your Custom VM, so make sure to selecte it accurately.

    When you import an external image, first verify that the source image has the latest Horizon agent installed. If it does not, the VMs that are created as part of the desktop/server pools on this image might encounter an error.

    When a Linux operating system is selected, select the appropriate license type based on the OS distribution:

    • Red Hat Enterprise Linux: Choose either Pay as you go (PAYG) or Bring your own subscription (BYOS).

      The BYOS option requires Red Hat products for Cloud Access on Azure to be enabled for the subscription.

    • Ubuntu: Only Pay as you go (PAYG) is available.

12. Under the Admin credentials for VM sub-section, add a Username and Password for the local admin account. This will be used during the image customization process to access the image's operating system.

    • The Username cannot end in a period(.) or exceed 19 characters.
    • Generic Usernames like "guest" or "administrator" are prohibited by Microsoft Azure.
    • Passwords must be 12 to 123 characters and meet 3 of the following requirements: lowercase letter [a-z], uppercase letter [A-Z], number, special character (!@#$%/^&*).
    • Generic Passwords like "Password1" are prohibited.

13. Select Windows license with Software Assurance when adding Windows-based images and click Add.

14. In the Target Version section, choose the Version Type as Major or Minor.

    • If you select Major, the Expected Version Number gets populated automatically, based on your selection and previously existing versions of the image.

    • If you select Minor, add the Major Version number in Add Version Under, under which you want to add the Minor version to automatically populate the Expected Version Number.

15. In the Markers field, add unique names to new markers. New markers are saved when the image is saved.