Create Azure Local VM image using Azure Marketplace images

• Review and complete the prerequisites.

• Assign the Azure Connected Machine Resource Manager role to the Microsoft.AzureStackHCI resource provider app for the resource group where you want to download the image. For more information, see Assign Azure roles.

• Register your subscription with the Microsoft.EdgeMarketplace resource provider. For more information, see Register resource provider.

• If you're using a client to connect to your Azure Local instance, see Connect to the system remotely.

• Review and complete the prerequisites.

• Assign the Azure Connected Machine Resource Manager role to the Microsoft.AzureStackHCI resource provider app for the resource group where you want to download the image. For more information, see Assign Azure roles.

• Register your subscription with the Microsoft.EdgeMarketplace resource provider. For more information, see Register resource provider.

Follow these steps to create a VM image using the Azure CLI.

Sign in and set subscription

1. Connect to a machine on your Azure Local.

2. Sign in. Type:

   az login --use-device-code
   

3. Set your subscription.

   az account set --subscription <Subscription ID>
   

Set some parameters

1. Set parameters for your subscription, resource group, location, and OS type for the image. Replace the parameters in < > with the appropriate values.

   $subscription = "<Subscription ID>"
   $resource_group = "<Resource group>"
   $mktplaceImage = "<Marketplace image name>"
   $customLocationName = "<Custom location name>"
   $customLocationID = (az customlocation show --resource-group $resource_group --name "<custom_location_name_for_Azure_Local>" --query id -o tsv)
   $location = "<Location for your Azure Local>"
   $osType = "<OS of source image>"
   $version = "<OS version of Marketplace image>"
   

   The parameters are described in the following table:

   Parameter	Description
   subscription	Subscription associated with your Azure Local.
   resource-group	Resource group for your Azure Local that you associate with the Marketplace image.
   name	Name of the Marketplace image for Azure Local.
   customLocation	Resource ID of custom location for your Azure Local.
   location	Location for your Azure Local. For example, eastus.
   os-type	Operating system associated with the source image. For example, Windows or Linux.
   version	(Optional) Specify the OS version for Marketplace image. If left empty, it defaults to the latest version.

   Here's a sample output:

   PS C:\Users\azcli> $subscription = "<Subscription ID>"
   PS C:\Users\azcli> $resource_group = "mylocal-rg"
   PS C:\Users\azcli> $mktplaceImage= "mylocal-marketplaceimage"
   PS C:\Users\azcli> $customLocationName = "mylocal-cl"
   PS C:\Users\azcli> $customerLocationID /subscriptions$subscription/resourcegroups/$resource_group/providers/microsoft.extendedlocation/customlocations/$customLocationName
   PS C:\Users\azcli> $location = "eastus"
   PS C:\Users\azcli> $ostype = "Windows"
   PS C:\Users\azcli> $version = "26100.4652.250808"
   

Create VM image from Marketplace image

1. Set additional parameters that specify the intended VM image you want to create. You need to include the offer, publisher, SKU, and version for the marketplace image. Replace the parameters in < > with the appropriate values:

   $publisher = "<Publisher name>"
   $offer = "<OS offer>"
   $sku = "<Image SKU>"
   

   Use the following table to find the available marketplace images and their attribute values:

   Name	Publisher	Offer	SKU
   Windows 11 Enterprise multi-session + Microsoft 365	microsoftwindowsdesktop	office-365	win11-23h2-avd-m365 win11-24h2-avd-m365
   Windows 10 Enterprise multi-session + Microsoft 365	microsoftwindowsdesktop	office-365	win10-21h2-avd-m365
   Windows 11 Pro	microsoftwindowsdesktop	windows-11	win11-23h2-pro
   Windows 11 Enterprise	microsoftwindowsdesktop	windows-11	win11-22h2-ent win11-23h2-ent win11-24h2-ent
   Windows 11 Enterprise multi-session	microsoftwindowsdesktop	windows-11	win11-22h2-avd win11-23h2-avd win11-24h2-avd
   Windows 10 Pro	microsoftwindowsdesktop	windows-10	win10-22h2-pro-g2
   Windows 10 Enterprise	microsoftwindowsdesktop	windows-10	win10-22h2-ent-g2
   Windows 10 Enterprise multi-session	microsoftwindowsdesktop	windows-10	win10-22h2-avd
   Windows Server 2025 Datacenter: Azure Edition	microsoftwindowsserver	windowsserver	2025-datacenter-azure-edition-smalldisk 2025-datacenter-azure-edition-core 2025-datacenter-azure-edition
   Windows Server 2022 Datacenter: Azure Edition	microsoftwindowsserver	windowsserver	2022-datacenter-azure-edition-hotpatch 2022-datacenter-azure-edition-core 2022-datacenter-azure-edition
   Windows Server 2019	microsoftwindowsserver	windowsserver	2019-datacenter-gensecond 2019-datacenter-core-g2
   SQL Server 2022 Enterprise on Windows Server 2022	microsoftsqlserver	sql2022-ws2022	enterprise-gen2 standard-gen2

   If you want to create a Windows Server 2019 Datacenter image, use the following parameters:

   $publisher = "microsoftwindowsserver" 
   $offer = "windowsserver" 
   $sku = "2019-datacenter-gensecond"
   

2. Create the VM image starting with a specified marketplace image:

   az stack-hci-vm image create --resource-group $resource_group --custom-location $customLocationID --name $mktplaceImage --os-type $ostype --offer $offer --publisher $publisher --sku $sku --version $version
   

Here's a sample output:

PS C:\Users\azcli> az stack-hci-vm image create --custom-location $cl --name $mktplaceImage --os-type $ostype --resource-group $rg --publisher $publisher --offer $offer --sku $sku  --version $version

{
  "extendedLocation": { 
    "name": "/subscriptions/<Subscription ID>/resourceGroups/mylocal-rg/providers/Microsoft.ExtendedLocation/customLocations/mylocal-cl", 
    "type": "CustomLocation" 
  }, 
  "id": "/subscriptions/<Subscription ID>/resourceGroups/mylocal-rg/providers/Microsoft.AzureStackHCI/marketplacegalleryimages/myhci-marketplaceimage", 
  "location": "eastus", 
  "name": "myhci-marketplaceimage", 
  "properties": { 
    "cloudInitDataSource": null, 
    "containerId": null, 
    "hyperVGeneration": null, 
    "identifier": { 
      "offer": "windowsserver", 
      "publisher": "microsoftwindowsserver", 
      "sku": "2019-datacenter-gensecond" 
    }, 
    "osType": "Windows", 
    "provisioningState": "Succeeded", 
    "status": { 
      "downloadStatus": { 
        "downloadSizeInMb": 10832 
      }, 
      "errorCode": "", 
      "errorMessage": "", 
      "progressPercentage": 100, 
      "provisioningStatus": { 
        "operationId": "13efc468-7473-429f-911b-858c1e6fc1d5*B11A62EE76B08EF194F8293CDD40F7BC71BFB93255D5A99DD11B4167690752D9", 
        "status": "Succeeded" 
      } 
    },
    "version": {
      "name": "17763.7922.251021",
      "properties": {
        "storageProfile": {
          "osDiskImage": {
            "sizeInMB": 130050
          }
        }
      }
    }
  },
  "resourceGroup": "mylocal-rg", 
  "systemData": { 
    "createdAt": "2024-09-23T18:53:13.734389+00:00", 
    "createdBy": "[email protected]", 
    "createdByType": "User", 
    "lastModifiedAt": "2024-09-23T19:06:07.532276+00:00", 
    "lastModifiedBy": "319f651f-7ddb-4fc6-9857-7aef9250bd05", 
    "lastModifiedByType": "Application" 
  },
  "tags": null, 
  "type": "microsoft.azurestackhci/marketplacegalleryimages" 
}

For more information on this CLI command, see az stack-hci-vm image.

Follow these steps to create a VM image using Azure portal. In Azure portal for your Azure Local resource, take the following steps:

1. Go to Resources > VM images.

2. Select + Add VM Image, then from the dropdown list, select Add VM image from Azure Marketplace.

   

3. In the Create an image page, on the Basics tab, enter the following information:

   1. Subscription: Select a subscription to associate with your VM image.

   2. Resource group: Create new or select an existing resource group that you associate with the VM image.

   3. Custom location: Select a custom location to deploy your VM image. The custom location should correspond to the custom location for your Azure Local.

   4. Image to download: Select a VM image from the list of images in Azure Marketplace. The dropdown list shows all Azure Marketplace images that are compatible with your Azure Local.

   5. Save image as: Enter a name for your VM image.

   6. Storage path: Select the storage path for your VM image. Select Choose automatically to have a storage path with high availability automatically selected. Select Choose manually to specify a storage path to store VM images and configuration files on the Azure Local instance. In this case, ensure that the specified storage path has sufficient storage space.

4. Select Review + Create to create your VM image.

   

5. The input parameters are validated. If the validations succeed, you can review the VM image details and select Create.

   

6. An Azure Resource Manager template deployment job starts for the VM image. The image deployment takes a few minutes to complete. The time taken to download the image depends on the size of the Marketplace image and the network bandwidth available for the download.

   

   You can track the image deployment on the VM image grid. You can see the list of the VM images that are already downloaded and the ones that are being downloaded on the system.

   To view more details of any image, select the VM image name from the list of VM images.

7. When the image download is complete, the VM image shows up in the list of images, and the Status shows as Available.

   

   If the download of the VM image fails, the error details are shown in the portal.