Azure Classic v5.43.0, May 6 23

azure.compute.getImages

Explore with Pulumi AI

Use this data source to access information about existing Images within a Resource Group.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Compute.GetImages.Invoke(new()
    {
        ResourceGroupName = "example-resources",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetImages(ctx, &compute.GetImagesArgs{
			ResourceGroupName: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.compute.ComputeFunctions;
import com.pulumi.azure.compute.inputs.GetImagesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = ComputeFunctions.getImages(GetImagesArgs.builder()
            .resourceGroupName("example-resources")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example = azure.compute.get_images(resource_group_name="example-resources")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.compute.getImages({
    resourceGroupName: "example-resources",
});

variables:
  example:
    fn::invoke:
      Function: azure:compute:getImages
      Arguments:
        resourceGroupName: example-resources

Using getImages

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 getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>

def get_images(resource_group_name: Optional[str] = None,
               tags_filter: Optional[Mapping[str, str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetImagesResult
def get_images_output(resource_group_name: Optional[pulumi.Input[str]] = None,
               tags_filter: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]

func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput

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

public static class GetImages 
{
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:compute/getImages:getImages
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the Resource Group in which the Image exists.
TagsFilter Dictionary<string, string>: A mapping of tags to filter the list of images against.

ResourceGroupName string: The name of the Resource Group in which the Image exists.
TagsFilter map[string]string: A mapping of tags to filter the list of images against.

resourceGroupName String: The name of the Resource Group in which the Image exists.
tagsFilter Map<String,String>: A mapping of tags to filter the list of images against.

resourceGroupName string: The name of the Resource Group in which the Image exists.
tagsFilter {[key: string]: string}: A mapping of tags to filter the list of images against.

resource_group_name str: The name of the Resource Group in which the Image exists.
tags_filter Mapping[str, str]: A mapping of tags to filter the list of images against.

resourceGroupName String: The name of the Resource Group in which the Image exists.
tagsFilter Map<String>: A mapping of tags to filter the list of images against.

getImages Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Images List<GetImagesImage>: One or more images blocks as defined below:
ResourceGroupName string
TagsFilter Dictionary<string, string>

Id string: The provider-assigned unique ID for this managed resource.
Images []GetImagesImage: One or more images blocks as defined below:
ResourceGroupName string
TagsFilter map[string]string

id String: The provider-assigned unique ID for this managed resource.
images List<GetImagesImage>: One or more images blocks as defined below:
resourceGroupName String
tagsFilter Map<String,String>

id string: The provider-assigned unique ID for this managed resource.
images GetImagesImage[]: One or more images blocks as defined below:
resourceGroupName string
tagsFilter {[key: string]: string}

id str: The provider-assigned unique ID for this managed resource.
images Sequence[GetImagesImage]: One or more images blocks as defined below:
resource_group_name str
tags_filter Mapping[str, str]

id String: The provider-assigned unique ID for this managed resource.
images List<Property Map>: One or more images blocks as defined below:
resourceGroupName String
tagsFilter Map<String>

Supporting Types

GetImagesImage

DataDisks List<GetImagesImageDataDisk>: One or more data_disk blocks as defined below.
Location string: The supported Azure location where the Image exists.
Name string: The name of the Image.
OsDisks List<GetImagesImageOsDisk>: An os_disk block as defined below.
Tags Dictionary<string, string>: A mapping of tags assigned to the Image.
ZoneResilient bool: Is zone resiliency enabled?

DataDisks []GetImagesImageDataDisk: One or more data_disk blocks as defined below.
Location string: The supported Azure location where the Image exists.
Name string: The name of the Image.
OsDisks []GetImagesImageOsDisk: An os_disk block as defined below.
Tags map[string]string: A mapping of tags assigned to the Image.
ZoneResilient bool: Is zone resiliency enabled?

dataDisks List<GetImagesImageDataDisk>: One or more data_disk blocks as defined below.
location String: The supported Azure location where the Image exists.
name String: The name of the Image.
osDisks List<GetImagesImageOsDisk>: An os_disk block as defined below.
tags Map<String,String>: A mapping of tags assigned to the Image.
zoneResilient Boolean: Is zone resiliency enabled?

dataDisks GetImagesImageDataDisk[]: One or more data_disk blocks as defined below.
location string: The supported Azure location where the Image exists.
name string: The name of the Image.
osDisks GetImagesImageOsDisk[]: An os_disk block as defined below.
tags {[key: string]: string}: A mapping of tags assigned to the Image.
zoneResilient boolean: Is zone resiliency enabled?

data_disks Sequence[GetImagesImageDataDisk]: One or more data_disk blocks as defined below.
location str: The supported Azure location where the Image exists.
name str: The name of the Image.
os_disks Sequence[GetImagesImageOsDisk]: An os_disk block as defined below.
tags Mapping[str, str]: A mapping of tags assigned to the Image.
zone_resilient bool: Is zone resiliency enabled?

dataDisks List<Property Map>: One or more data_disk blocks as defined below.
location String: The supported Azure location where the Image exists.
name String: The name of the Image.
osDisks List<Property Map>: An os_disk block as defined below.
tags Map<String>: A mapping of tags assigned to the Image.
zoneResilient Boolean: Is zone resiliency enabled?

GetImagesImageDataDisk

BlobUri string: the URI in Azure storage of the blob used to create the image.
Caching string: the caching mode for the Data Disk.
Lun int: the logical unit number of the data disk.
ManagedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
SizeGb int: the size of this Data Disk in GB.

BlobUri string: the URI in Azure storage of the blob used to create the image.
Caching string: the caching mode for the Data Disk.
Lun int: the logical unit number of the data disk.
ManagedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
SizeGb int: the size of this Data Disk in GB.

blobUri String: the URI in Azure storage of the blob used to create the image.
caching String: the caching mode for the Data Disk.
lun Integer: the logical unit number of the data disk.
managedDiskId String: the ID of the Managed Disk used as the Data Disk Image.
sizeGb Integer: the size of this Data Disk in GB.

blobUri string: the URI in Azure storage of the blob used to create the image.
caching string: the caching mode for the Data Disk.
lun number: the logical unit number of the data disk.
managedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
sizeGb number: the size of this Data Disk in GB.

blob_uri str: the URI in Azure storage of the blob used to create the image.
caching str: the caching mode for the Data Disk.
lun int: the logical unit number of the data disk.
managed_disk_id str: the ID of the Managed Disk used as the Data Disk Image.
size_gb int: the size of this Data Disk in GB.

blobUri String: the URI in Azure storage of the blob used to create the image.
caching String: the caching mode for the Data Disk.
lun Number: the logical unit number of the data disk.
managedDiskId String: the ID of the Managed Disk used as the Data Disk Image.
sizeGb Number: the size of this Data Disk in GB.

GetImagesImageOsDisk

BlobUri string: the URI in Azure storage of the blob used to create the image.
Caching string: the caching mode for the Data Disk.
ManagedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
OsState string: the State of the OS used in the Image.
OsType string: the type of Operating System used on the OS Disk.
SizeGb int: the size of this Data Disk in GB.

BlobUri string: the URI in Azure storage of the blob used to create the image.
Caching string: the caching mode for the Data Disk.
ManagedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
OsState string: the State of the OS used in the Image.
OsType string: the type of Operating System used on the OS Disk.
SizeGb int: the size of this Data Disk in GB.

blobUri String: the URI in Azure storage of the blob used to create the image.
caching String: the caching mode for the Data Disk.
managedDiskId String: the ID of the Managed Disk used as the Data Disk Image.
osState String: the State of the OS used in the Image.
osType String: the type of Operating System used on the OS Disk.
sizeGb Integer: the size of this Data Disk in GB.

blobUri string: the URI in Azure storage of the blob used to create the image.
caching string: the caching mode for the Data Disk.
managedDiskId string: the ID of the Managed Disk used as the Data Disk Image.
osState string: the State of the OS used in the Image.
osType string: the type of Operating System used on the OS Disk.
sizeGb number: the size of this Data Disk in GB.

blob_uri str: the URI in Azure storage of the blob used to create the image.
caching str: the caching mode for the Data Disk.
managed_disk_id str: the ID of the Managed Disk used as the Data Disk Image.
os_state str: the State of the OS used in the Image.
os_type str: the type of Operating System used on the OS Disk.
size_gb int: the size of this Data Disk in GB.

blobUri String: the URI in Azure storage of the blob used to create the image.
caching String: the caching mode for the Data Disk.
managedDiskId String: the ID of the Managed Disk used as the Data Disk Image.
osState String: the State of the OS used in the Image.
osType String: the type of Operating System used on the OS Disk.
sizeGb Number: the size of this Data Disk in GB.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.