Microsoft.Compute galleries/images/versions 2021-10-01
Bicep resource definition
The galleries/images/versions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/galleries/images/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/galleries/images/versions@2021-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
publishingProfile: {
endOfLifeDate: 'string'
excludeFromLatest: bool
replicaCount: int
replicationMode: 'string'
storageAccountType: 'string'
targetExtendedLocations: [
{
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
extendedLocation: {
name: 'string'
type: 'string'
}
extendedLocationReplicaCount: int
name: 'string'
storageAccountType: 'string'
}
]
targetRegions: [
{
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
name: 'string'
regionalReplicaCount: int
storageAccountType: 'string'
}
]
}
storageProfile: {
dataDiskImages: [
{
hostCaching: 'string'
lun: int
source: {
id: 'string'
uri: 'string'
}
}
]
osDiskImage: {
hostCaching: 'string'
source: {
id: 'string'
uri: 'string'
}
}
source: {
id: 'string'
uri: 'string'
}
}
}
}
Property values
galleries/images/versions
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 32-bit integer Valid characters: Numbers and periods. (Each segment is converted to an int32. So each segment has a max value of 2,147,483,647.) |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: images |
| properties | Describes the properties of a gallery image version. | GalleryImageVersionProperties |
GalleryImageVersionProperties
| Name | Description | Value |
|---|---|---|
| publishingProfile | The publishing profile of a gallery image Version. | GalleryImageVersionPublishingProfile |
| storageProfile | This is the storage profile of a Gallery Image Version. | GalleryImageVersionStorageProfile (required) |
GalleryImageVersionPublishingProfile
| Name | Description | Value |
|---|---|---|
| endOfLifeDate | The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. | string |
| excludeFromLatest | If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. | bool |
| replicaCount | The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. | int |
| replicationMode | Optional parameter which specifies the mode to be used for replication. This property is not updatable. | 'Full' 'Shallow' |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
| targetExtendedLocations | The target extended locations where the Image Version is going to be replicated to. This property is updatable. | GalleryTargetExtendedLocation[] |
| targetRegions | The target regions where the Image Version is going to be replicated to. This property is updatable. | TargetRegion[] |
GalleryTargetExtendedLocation
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| extendedLocation | The name of the extended location. | GalleryExtendedLocation |
| extendedLocationReplicaCount | The number of replicas of the Image Version to be created per extended location. This property is updatable. | int |
| name | The name of the region. | string |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
EncryptionImages
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of encryption specifications for data disk images. | DataDiskImageEncryption[] |
| osDiskImage | Contains encryption settings for an OS disk image. | OSDiskImageEncryption |
DataDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
OSDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| securityProfile | This property specifies the security profile of an OS disk image. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
| Name | Description | Value |
|---|---|---|
| confidentialVMEncryptionType | confidential VM encryption types | 'EncryptedVMGuestStateOnlyWithPmk' 'EncryptedWithCmk' 'EncryptedWithPmk' |
| secureVMDiskEncryptionSetId | secure VM disk encryption set id | string |
GalleryExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | string | |
| type | It is type of the extended location. | 'EdgeZone' 'Unknown' |
TargetRegion
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| name | The name of the region. | string (required) |
| regionalReplicaCount | The number of replicas of the Image Version to be created per region. This property is updatable. | int |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
GalleryImageVersionStorageProfile
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of data disk images. | GalleryDataDiskImage[] |
| osDiskImage | This is the OS disk image. | GalleryOSDiskImage |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryDataDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | 'None' 'ReadOnly' 'ReadWrite' |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryArtifactVersionSource
| Name | Description | Value |
|---|---|---|
| id | The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. | string |
| uri | The uri of the gallery artifact version source. Currently used to specify vhd/blob source. | string |
GalleryOSDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | 'None' 'ReadOnly' 'ReadWrite' |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an Image Version in a Azure Compute Gallery |
This template allows you to create a simple Image Version in a Azure Compute Gallery. Please ensure that you have run the Azure Compute Gallery 101 Template and the Image Definition 101 Template before you deploy this. |
ARM template resource definition
The galleries/images/versions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/galleries/images/versions resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/galleries/images/versions",
"apiVersion": "2021-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"publishingProfile": {
"endOfLifeDate": "string",
"excludeFromLatest": "bool",
"replicaCount": "int",
"replicationMode": "string",
"storageAccountType": "string",
"targetExtendedLocations": [
{
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"extendedLocation": {
"name": "string",
"type": "string"
},
"extendedLocationReplicaCount": "int",
"name": "string",
"storageAccountType": "string"
}
],
"targetRegions": [
{
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"name": "string",
"regionalReplicaCount": "int",
"storageAccountType": "string"
}
]
},
"storageProfile": {
"dataDiskImages": [
{
"hostCaching": "string",
"lun": "int",
"source": {
"id": "string",
"uri": "string"
}
}
],
"osDiskImage": {
"hostCaching": "string",
"source": {
"id": "string",
"uri": "string"
}
},
"source": {
"id": "string",
"uri": "string"
}
}
}
}
Property values
galleries/images/versions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Compute/galleries/images/versions' |
| apiVersion | The resource api version | '2021-10-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 32-bit integer Valid characters: Numbers and periods. (Each segment is converted to an int32. So each segment has a max value of 2,147,483,647.) |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| properties | Describes the properties of a gallery image version. | GalleryImageVersionProperties |
GalleryImageVersionProperties
| Name | Description | Value |
|---|---|---|
| publishingProfile | The publishing profile of a gallery image Version. | GalleryImageVersionPublishingProfile |
| storageProfile | This is the storage profile of a Gallery Image Version. | GalleryImageVersionStorageProfile (required) |
GalleryImageVersionPublishingProfile
| Name | Description | Value |
|---|---|---|
| endOfLifeDate | The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. | string |
| excludeFromLatest | If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. | bool |
| replicaCount | The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. | int |
| replicationMode | Optional parameter which specifies the mode to be used for replication. This property is not updatable. | 'Full' 'Shallow' |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
| targetExtendedLocations | The target extended locations where the Image Version is going to be replicated to. This property is updatable. | GalleryTargetExtendedLocation[] |
| targetRegions | The target regions where the Image Version is going to be replicated to. This property is updatable. | TargetRegion[] |
GalleryTargetExtendedLocation
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| extendedLocation | The name of the extended location. | GalleryExtendedLocation |
| extendedLocationReplicaCount | The number of replicas of the Image Version to be created per extended location. This property is updatable. | int |
| name | The name of the region. | string |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
EncryptionImages
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of encryption specifications for data disk images. | DataDiskImageEncryption[] |
| osDiskImage | Contains encryption settings for an OS disk image. | OSDiskImageEncryption |
DataDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
OSDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| securityProfile | This property specifies the security profile of an OS disk image. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
| Name | Description | Value |
|---|---|---|
| confidentialVMEncryptionType | confidential VM encryption types | 'EncryptedVMGuestStateOnlyWithPmk' 'EncryptedWithCmk' 'EncryptedWithPmk' |
| secureVMDiskEncryptionSetId | secure VM disk encryption set id | string |
GalleryExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | string | |
| type | It is type of the extended location. | 'EdgeZone' 'Unknown' |
TargetRegion
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| name | The name of the region. | string (required) |
| regionalReplicaCount | The number of replicas of the Image Version to be created per region. This property is updatable. | int |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
GalleryImageVersionStorageProfile
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of data disk images. | GalleryDataDiskImage[] |
| osDiskImage | This is the OS disk image. | GalleryOSDiskImage |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryDataDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | 'None' 'ReadOnly' 'ReadWrite' |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryArtifactVersionSource
| Name | Description | Value |
|---|---|---|
| id | The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. | string |
| uri | The uri of the gallery artifact version source. Currently used to specify vhd/blob source. | string |
GalleryOSDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | 'None' 'ReadOnly' 'ReadWrite' |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create an Image Version in a Azure Compute Gallery |
This template allows you to create a simple Image Version in a Azure Compute Gallery. Please ensure that you have run the Azure Compute Gallery 101 Template and the Image Definition 101 Template before you deploy this. |
Terraform (AzAPI provider) resource definition
The galleries/images/versions 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.Compute/galleries/images/versions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/galleries/images/versions@2021-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
publishingProfile = {
endOfLifeDate = "string"
excludeFromLatest = bool
replicaCount = int
replicationMode = "string"
storageAccountType = "string"
targetExtendedLocations = [
{
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
extendedLocation = {
name = "string"
type = "string"
}
extendedLocationReplicaCount = int
name = "string"
storageAccountType = "string"
}
]
targetRegions = [
{
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
name = "string"
regionalReplicaCount = int
storageAccountType = "string"
}
]
}
storageProfile = {
dataDiskImages = [
{
hostCaching = "string"
lun = int
source = {
id = "string"
uri = "string"
}
}
]
osDiskImage = {
hostCaching = "string"
source = {
id = "string"
uri = "string"
}
}
source = {
id = "string"
uri = "string"
}
}
}
})
}
Property values
galleries/images/versions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Compute/galleries/images/versions@2021-10-01" |
| name | The resource name | string (required) Character limit: 32-bit integer Valid characters: Numbers and periods. (Each segment is converted to an int32. So each segment has a max value of 2,147,483,647.) |
| location | Resource location | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: images |
| tags | Resource tags | Dictionary of tag names and values. |
| properties | Describes the properties of a gallery image version. | GalleryImageVersionProperties |
GalleryImageVersionProperties
| Name | Description | Value |
|---|---|---|
| publishingProfile | The publishing profile of a gallery image Version. | GalleryImageVersionPublishingProfile |
| storageProfile | This is the storage profile of a Gallery Image Version. | GalleryImageVersionStorageProfile (required) |
GalleryImageVersionPublishingProfile
| Name | Description | Value |
|---|---|---|
| endOfLifeDate | The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. | string |
| excludeFromLatest | If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. | bool |
| replicaCount | The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. | int |
| replicationMode | Optional parameter which specifies the mode to be used for replication. This property is not updatable. | "Full" "Shallow" |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
| targetExtendedLocations | The target extended locations where the Image Version is going to be replicated to. This property is updatable. | GalleryTargetExtendedLocation[] |
| targetRegions | The target regions where the Image Version is going to be replicated to. This property is updatable. | TargetRegion[] |
GalleryTargetExtendedLocation
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| extendedLocation | The name of the extended location. | GalleryExtendedLocation |
| extendedLocationReplicaCount | The number of replicas of the Image Version to be created per extended location. This property is updatable. | int |
| name | The name of the region. | string |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
EncryptionImages
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of encryption specifications for data disk images. | DataDiskImageEncryption[] |
| osDiskImage | Contains encryption settings for an OS disk image. | OSDiskImageEncryption |
DataDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
OSDiskImageEncryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | A relative URI containing the resource ID of the disk encryption set. | string |
| securityProfile | This property specifies the security profile of an OS disk image. | OSDiskImageSecurityProfile |
OSDiskImageSecurityProfile
| Name | Description | Value |
|---|---|---|
| confidentialVMEncryptionType | confidential VM encryption types | "EncryptedVMGuestStateOnlyWithPmk" "EncryptedWithCmk" "EncryptedWithPmk" |
| secureVMDiskEncryptionSetId | secure VM disk encryption set id | string |
GalleryExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | string | |
| type | It is type of the extended location. | "EdgeZone" "Unknown" |
TargetRegion
| Name | Description | Value |
|---|---|---|
| encryption | Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. | EncryptionImages |
| name | The name of the region. | string (required) |
| regionalReplicaCount | The number of replicas of the Image Version to be created per region. This property is updatable. | int |
| storageAccountType | Specifies the storage account type to be used to store the image. This property is not updatable. | "Premium_LRS" "StandardSSD_LRS" "Standard_LRS" "Standard_ZRS" |
GalleryImageVersionStorageProfile
| Name | Description | Value |
|---|---|---|
| dataDiskImages | A list of data disk images. | GalleryDataDiskImage[] |
| osDiskImage | This is the OS disk image. | GalleryOSDiskImage |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryDataDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | "None" "ReadOnly" "ReadWrite" |
| lun | This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. | int (required) |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |
GalleryArtifactVersionSource
| Name | Description | Value |
|---|---|---|
| id | The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. | string |
| uri | The uri of the gallery artifact version source. Currently used to specify vhd/blob source. | string |
GalleryOSDiskImage
| Name | Description | Value |
|---|---|---|
| hostCaching | The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' | "None" "ReadOnly" "ReadWrite" |
| source | The gallery artifact version source. | GalleryArtifactVersionSource |