Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. compute
  5. getImage
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.compute.getImage

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets an image. Azure REST API version: 2023-03-01.

Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.

Using getImage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
Copy
def get_image(expand: Optional[str] = None,
              image_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(expand: Optional[pulumi.Input[str]] = None,
              image_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
Copy
func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput
Copy

> Note: This function is named LookupImage in the Go SDK.

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the image.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
The expand expression to apply on the operation.
ImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the image.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
The expand expression to apply on the operation.
imageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the image.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
The expand expression to apply on the operation.
imageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the image.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
The expand expression to apply on the operation.
image_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the image.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
The expand expression to apply on the operation.
imageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the image.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
The expand expression to apply on the operation.

getImage Result

The following output properties are available:

Id string
Resource Id
Location string
Resource location
Name string
Resource name
ProvisioningState string
The provisioning state.
Type string
Resource type
ExtendedLocation Pulumi.AzureNative.Compute.Outputs.ExtendedLocationResponse
The extended location of the Image.
HyperVGeneration string
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
SourceVirtualMachine Pulumi.AzureNative.Compute.Outputs.SubResourceResponse
The source virtual machine from which Image is created.
StorageProfile Pulumi.AzureNative.Compute.Outputs.ImageStorageProfileResponse
Specifies the storage settings for the virtual machine disks.
Tags Dictionary<string, string>
Resource tags
Id string
Resource Id
Location string
Resource location
Name string
Resource name
ProvisioningState string
The provisioning state.
Type string
Resource type
ExtendedLocation ExtendedLocationResponse
The extended location of the Image.
HyperVGeneration string
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
SourceVirtualMachine SubResourceResponse
The source virtual machine from which Image is created.
StorageProfile ImageStorageProfileResponse
Specifies the storage settings for the virtual machine disks.
Tags map[string]string
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
provisioningState String
The provisioning state.
type String
Resource type
extendedLocation ExtendedLocationResponse
The extended location of the Image.
hyperVGeneration String
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
sourceVirtualMachine SubResourceResponse
The source virtual machine from which Image is created.
storageProfile ImageStorageProfileResponse
Specifies the storage settings for the virtual machine disks.
tags Map<String,String>
Resource tags
id string
Resource Id
location string
Resource location
name string
Resource name
provisioningState string
The provisioning state.
type string
Resource type
extendedLocation ExtendedLocationResponse
The extended location of the Image.
hyperVGeneration string
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
sourceVirtualMachine SubResourceResponse
The source virtual machine from which Image is created.
storageProfile ImageStorageProfileResponse
Specifies the storage settings for the virtual machine disks.
tags {[key: string]: string}
Resource tags
id str
Resource Id
location str
Resource location
name str
Resource name
provisioning_state str
The provisioning state.
type str
Resource type
extended_location ExtendedLocationResponse
The extended location of the Image.
hyper_v_generation str
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
source_virtual_machine SubResourceResponse
The source virtual machine from which Image is created.
storage_profile ImageStorageProfileResponse
Specifies the storage settings for the virtual machine disks.
tags Mapping[str, str]
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
provisioningState String
The provisioning state.
type String
Resource type
extendedLocation Property Map
The extended location of the Image.
hyperVGeneration String
Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
sourceVirtualMachine Property Map
The source virtual machine from which Image is created.
storageProfile Property Map
Specifies the storage settings for the virtual machine disks.
tags Map<String>
Resource tags

Supporting Types

DiskEncryptionSetParametersResponse

Id string
Resource Id
Id string
Resource Id
id String
Resource Id
id string
Resource Id
id str
Resource Id
id String
Resource Id

ExtendedLocationResponse

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

ImageDataDiskResponse

Lun This property is required. int
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
BlobUri string
The Virtual Hard Disk.
Caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
DiskEncryptionSet Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskSizeGB int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
ManagedDisk Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The managedDisk.
Snapshot Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The snapshot.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
Lun This property is required. int
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
BlobUri string
The Virtual Hard Disk.
Caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
DiskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskSizeGB int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
ManagedDisk SubResourceResponse
The managedDisk.
Snapshot SubResourceResponse
The snapshot.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
lun This property is required. Integer
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
blobUri String
The Virtual Hard Disk.
caching String
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB Integer
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
lun This property is required. number
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
blobUri string
The Virtual Hard Disk.
caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB number
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
lun This property is required. int
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
blob_uri str
The Virtual Hard Disk.
caching str
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
disk_encryption_set DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
disk_size_gb int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managed_disk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storage_account_type str
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
lun This property is required. Number
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
blobUri String
The Virtual Hard Disk.
caching String
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet Property Map
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB Number
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk Property Map
The managedDisk.
snapshot Property Map
The snapshot.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageOSDiskResponse

OsState This property is required. string
The OS State. For managed images, use Generalized.
OsType This property is required. string
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
BlobUri string
The Virtual Hard Disk.
Caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
DiskEncryptionSet Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskSizeGB int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
ManagedDisk Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The managedDisk.
Snapshot Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The snapshot.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
OsState This property is required. string
The OS State. For managed images, use Generalized.
OsType This property is required. string
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
BlobUri string
The Virtual Hard Disk.
Caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
DiskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskSizeGB int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
ManagedDisk SubResourceResponse
The managedDisk.
Snapshot SubResourceResponse
The snapshot.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
osState This property is required. String
The OS State. For managed images, use Generalized.
osType This property is required. String
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
blobUri String
The Virtual Hard Disk.
caching String
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB Integer
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
osState This property is required. string
The OS State. For managed images, use Generalized.
osType This property is required. string
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
blobUri string
The Virtual Hard Disk.
caching string
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB number
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
os_state This property is required. str
The OS State. For managed images, use Generalized.
os_type This property is required. str
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
blob_uri str
The Virtual Hard Disk.
caching str
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
disk_encryption_set DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed image disk.
disk_size_gb int
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managed_disk SubResourceResponse
The managedDisk.
snapshot SubResourceResponse
The snapshot.
storage_account_type str
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
osState This property is required. String
The OS State. For managed images, use Generalized.
osType This property is required. String
This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows, Linux.
blobUri String
The Virtual Hard Disk.
caching String
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
diskEncryptionSet Property Map
Specifies the customer managed disk encryption set resource id for the managed image disk.
diskSizeGB Number
Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB.
managedDisk Property Map
The managedDisk.
snapshot Property Map
The snapshot.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageStorageProfileResponse

DataDisks List<Pulumi.AzureNative.Compute.Inputs.ImageDataDiskResponse>
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
OsDisk Pulumi.AzureNative.Compute.Inputs.ImageOSDiskResponse
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
ZoneResilient bool
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
DataDisks []ImageDataDiskResponse
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
OsDisk ImageOSDiskResponse
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
ZoneResilient bool
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
dataDisks List<ImageDataDiskResponse>
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
osDisk ImageOSDiskResponse
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
zoneResilient Boolean
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
dataDisks ImageDataDiskResponse[]
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
osDisk ImageOSDiskResponse
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
zoneResilient boolean
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
data_disks Sequence[ImageDataDiskResponse]
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
os_disk ImageOSDiskResponse
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
zone_resilient bool
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
dataDisks List<Property Map>
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
osDisk Property Map
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
zoneResilient Boolean
Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

SubResourceResponse

Id string
Resource Id
Id string
Resource Id
id String
Resource Id
id string
Resource Id
id str
Resource Id
id String
Resource Id

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native