Microsoft.AzureStackHCI marketplaceGalleryImages

ARM template resource definition

The marketplaceGalleryImages resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/marketplaceGalleryImages resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "extendedLocation": {
    "name": "string",
    "type": "CustomLocation"
  },
  "properties": {
    "cloudInitDataSource": "string",
    "containerId": "string",
    "hyperVGeneration": "string",
    "identifier": {
      "offer": "string",
      "publisher": "string",
      "sku": "string"
    },
    "osType": "string",
    "version": {
      "name": "string",
      "properties": {
        "storageProfile": {
          "osDiskImage": {}
        }
      }
    }
  }
}

Property values

marketplaceGalleryImages

Name Description Value
type The resource type 'Microsoft.AzureStackHCI/marketplaceGalleryImages'
apiVersion The resource api version '2023-09-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
extendedLocation The extendedLocation of the resource. ExtendedLocation
properties Properties under the marketplace gallery image resource MarketplaceGalleryImageProperties

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

MarketplaceGalleryImageProperties

Name Description Value
cloudInitDataSource Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] 'Azure'
'NoCloud'
containerId Storage ContainerID of the storage container to be used for marketplace gallery image string
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
identifier This is the gallery image definition identifier. GalleryImageIdentifier
osType Operating system type that the gallery image uses [Windows, Linux] 'Linux'
'Windows' (required)
version Specifies information about the gallery image version that you want to create or update. GalleryImageVersion

GalleryImageIdentifier

Name Description Value
offer The name of the gallery image definition offer. string (required)
publisher The name of the gallery image definition publisher. string (required)
sku The name of the gallery image definition SKU. string (required)

GalleryImageVersion

Name Description Value
name This is the version of the gallery image. string
properties Describes the properties of a gallery image version. GalleryImageVersionProperties

GalleryImageVersionProperties

Name Description Value
storageProfile This is the storage profile of a Gallery Image Version. GalleryImageVersionStorageProfile (required)

GalleryImageVersionStorageProfile

Name Description Value
osDiskImage This is the OS disk image. GalleryOSDiskImage

GalleryOSDiskImage

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
creates an Azure Stack HCI Image from Marketplace Image

Deploy to Azure
This template creates an Azure Stack HCI Image from an Azure Marketplace Gallery Image.