Not able to use custom image from the Compute Gallery (formerly known as Shared Image Gallery)

martin-hlousek_kyndr · August 18, 2023, 1:06pm

Hello,

I would like to use our custom made image (various OS) from the Azure compute Gallery (formerly known as Shared Image Gallery) for machine creation. All details such as ID, sku, provider etc. obtained via Azure CLI.

However when I use respective block in virtual machine definition supreme block:
"source_image_reference {
publisher = “OurCompanyName”
offer = “OurCustomName”
sku = “OurCustomSKU”
version = “latest”
}"

I am getting this error:
“Failure sending request: StatusCode=404 – Original Error: Code=“PlatformImageNotFound” Message=“The platform image ‘Kyndryl:rh91-1:rh91-1:latest’ is not available. Verify that all fields in the storage profile are correct. For more details about storage profile information, please refer to StorageProfile Class (Microsoft.Azure.Management.Compute.Models) - Azure for .NET Developers | Microsoft Learn” Target=“imageReference””

I have find out that this method cannot be used for Compute Gallery (Shared Image Gallery) anymore because there has been changes made in Compute API which the block is using for API calls and therefore it is not able to properly reference the custom image, see:

github.com/hashicorp/terraform-provider-azurerm

Support for Azure Compute Gallery when deploying Virtual Machines

opened 10:44PM - 03 Feb 22 UTC

closed 09:38AM - 04 Feb 22 UTC

masonhuemmer

question

### Community Note * Please vote on this issue by adding a 👍 [reaction](https…://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request * Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request * If you are interested in working on this issue or have submitted a pull request, please leave a comment ### Description When provisioning a windows virtual machine, I am required to pass in a source image ID, instead of being able to provide the publisher, offer, sku, and version. Users should be able to pull images from a private gallery, rather then having to pass in the resource ID to the shared image. ### New or Affected Resource(s) * azurerm_windows_virtual_machine * azurerm_linux_virtual_machine ### Potential Terraform Configuration ``` provider "azurerm" { features {} } data "azurerm_shared_image" "example" { name = "my-image" gallery_name = "my-image-gallery" resource_group_name = "example-resources-imageRG" } resource "azurerm_resource_group" "example" { name = "example-resources" location = "xxxxximageregion" } resource "azurerm_virtual_network" "example" { name = "example-network" address_space = ["10.0.0.0/16"] location = azurerm_resource_group.example.location resource_group_name = azurerm_resource_group.example.name } resource "azurerm_subnet" "example" { name = "internal" resource_group_name = azurerm_resource_group.example.name virtual_network_name = azurerm_virtual_network.example.name address_prefixes = ["10.0.2.0/24"] } resource "azurerm_network_interface" "example" { name = "example-nic" location = azurerm_resource_group.example.location resource_group_name = azurerm_resource_group.example.name ip_configuration { name = "internal" subnet_id = azurerm_subnet.example.id private_ip_address_allocation = "Dynamic" } } resource "azurerm_windows_virtual_machine" "example" { name = "example-machine" resource_group_name = azurerm_resource_group.example.name location = azurerm_resource_group.example.location size = "Standard_F2" admin_username = "adminuser" admin_password = "P@$$w0rd1234!" network_interface_ids = [ azurerm_network_interface.example.id, ] os_disk { caching = "ReadWrite" storage_account_type = "Standard_LRS" } source_image_reference { gallery = "Private" publisher = "CompanyName" offer = "WindowsServer" sku = "2022-Datacenter" version = "latest" } } ``` ### References  * https://stackoverflow.com/questions/67178590/deploy-azure-vm-based-on-customize-image-available-on-shared-image-gallery

As alternative I was suggested to use “storage_image_reference” block instead, however when I used that I have got this error:
“Error: Unsupported block type”
“Blocks of type “storage_image_reference” are not expected here.”

So my question is what is currently functional solution to use custom image from Compute Gallery (Shared Image Gallery) when creating a new vm with Terraform? Thank you.

martin-hlousek_kyndr · August 18, 2023, 4:32pm

Update: I seem to have been successful after using this combination:

1/ Data Source: azurerm_shared_image
https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/shared_image

"data “azurerm_shared_image” “example” {

name = “my-image”
gallery_name = “my-image-gallery”
resource_group_name = “example-resources”
}"

2/ Argument Reference: source_image_id
https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/windows_virtual_machine.html

“source_image_id = data.azurerm_shared_image.example.id”

However, now I’m getting this ‘os_profile’ error. Apparently there is a conflict with our custom image with the admin user already predefined:
“Error: creating Linux Virtual Machine: (Name “dev-001-rh91” / Resource Group “rg-RV-Kyndryl-Delivery-kcl-eastus-001”): compute.VirtualMachinesClient#CreateOrUpdate: Failure sending request: StatusCode=400 – Original Error: Code=“InvalidParameter” Message=“Parameter ‘osProfile’ is not allowed.” Target=“osProfile””

Contrary to this, the ‘admin_username’ argument must be specified in the ‘os_profile’ block according to the TF, otherwise an error is returned:
“The argument “admin_username” is required, but no definition was found.”

Any suggestion now please?

swin · July 8, 2024, 7:16pm

@martin-hlousek_kyndr , did you ever figure this out?