Aracılığıyla paylaş


Microsoft.AzureStackHCI galleryImages 2024-02-01-preview

Bicep resource definition

The galleryImages 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/galleryImages resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/galleryImages@2024-02-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    cloudInitDataSource: 'string'
    containerId: 'string'
    hyperVGeneration: 'string'
    identifier: {
      offer: 'string'
      publisher: 'string'
      sku: 'string'
    }
    imagePath: 'string'
    osType: 'string'
    version: {
      name: 'string'
      properties: {
        storageProfile: {
          osDiskImage: {}
        }
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

ExtendedLocation

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

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)

GalleryImageProperties

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 gallery image string
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
identifier This is the gallery image definition identifier. GalleryImageIdentifier
imagePath location of the image the gallery image should be created from string

Constraints:
Sensitive value. Pass in as a secure parameter.
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

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

Name Description Value

Microsoft.AzureStackHCI/galleryImages

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. GalleryImageProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

ARM template resource definition

The galleryImages 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/galleryImages resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/galleryImages",
  "apiVersion": "2024-02-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "cloudInitDataSource": "string",
    "containerId": "string",
    "hyperVGeneration": "string",
    "identifier": {
      "offer": "string",
      "publisher": "string",
      "sku": "string"
    },
    "imagePath": "string",
    "osType": "string",
    "version": {
      "name": "string",
      "properties": {
        "storageProfile": {
          "osDiskImage": {
          }
        }
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

ExtendedLocation

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

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)

GalleryImageProperties

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 gallery image string
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
identifier This is the gallery image definition identifier. GalleryImageIdentifier
imagePath location of the image the gallery image should be created from string

Constraints:
Sensitive value. Pass in as a secure parameter.
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

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

Name Description Value

Microsoft.AzureStackHCI/galleryImages

Name Description Value
apiVersion The api version '2024-02-01-preview'
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. GalleryImageProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.AzureStackHCI/galleryImages'

TrackedResourceTags

Name Description Value

Kullanım Örnekleri

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

To create a Microsoft.AzureStackHCI/galleryImages resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/galleryImages@2024-02-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      cloudInitDataSource = "string"
      containerId = "string"
      hyperVGeneration = "string"
      identifier = {
        offer = "string"
        publisher = "string"
        sku = "string"
      }
      imagePath = "string"
      osType = "string"
      version = {
        name = "string"
        properties = {
          storageProfile = {
            osDiskImage = {
            }
          }
        }
      }
    }
  }
}

Property Values

ExtendedLocation

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

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)

GalleryImageProperties

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 gallery image string
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
identifier This is the gallery image definition identifier. GalleryImageIdentifier
imagePath location of the image the gallery image should be created from string

Constraints:
Sensitive value. Pass in as a secure parameter.
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

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

Name Description Value

Microsoft.AzureStackHCI/galleryImages

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. GalleryImageProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.AzureStackHCI/galleryImages@2024-02-01-preview"

TrackedResourceTags

Name Description Value