1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. getSharedImage

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.compute.getSharedImage

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Use this data source to access information about an existing Shared Image within a Shared Image Gallery.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Compute.GetSharedImage.InvokeAsync(new Azure.Compute.GetSharedImageArgs
        {
            GalleryName = "my-image-gallery",
            Name = "my-image",
            ResourceGroupName = "example-resources",
        }));
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupSharedImage(ctx, &compute.LookupSharedImageArgs{
			GalleryName:       "my-image-gallery",
			Name:              "my-image",
			ResourceGroupName: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const example = pulumi.output(azure.compute.getSharedImage({
    galleryName: "my-image-gallery",
    name: "my-image",
    resourceGroupName: "example-resources",
}));

    import pulumi
import pulumi_azure as azure

example = azure.compute.get_shared_image(gallery_name="my-image-gallery",
    name="my-image",
    resource_group_name="example-resources")

    Example coming soon!

    Using getSharedImage

    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 getSharedImage(args: GetSharedImageArgs, opts?: InvokeOptions): Promise<GetSharedImageResult>
function getSharedImageOutput(args: GetSharedImageOutputArgs, opts?: InvokeOptions): Output<GetSharedImageResult>
    def get_shared_image(gallery_name: Optional[str] = None,
                     name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSharedImageResult
def get_shared_image_output(gallery_name: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSharedImageResult]
    func LookupSharedImage(ctx *Context, args *LookupSharedImageArgs, opts ...InvokeOption) (*LookupSharedImageResult, error)
func LookupSharedImageOutput(ctx *Context, args *LookupSharedImageOutputArgs, opts ...InvokeOption) LookupSharedImageResultOutput

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

    public static class GetSharedImage 
{
    public static Task<GetSharedImageResult> InvokeAsync(GetSharedImageArgs args, InvokeOptions? opts = null)
    public static Output<GetSharedImageResult> Invoke(GetSharedImageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSharedImageResult> getSharedImage(GetSharedImageArgs args, InvokeOptions options)
public static Output<GetSharedImageResult> getSharedImage(GetSharedImageArgs args, InvokeOptions options)

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

    The following arguments are supported:

    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    Name string
    The name of the Shared Image.
    ResourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    Name string
    The name of the Shared Image.
    ResourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists.
    name String
    The name of the Shared Image.
    resourceGroupName String
    The name of the Resource Group in which the Shared Image Gallery exists.
    galleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    name string
    The name of the Shared Image.
    resourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    gallery_name str
    The name of the Shared Image Gallery in which the Shared Image exists.
    name str
    The name of the Shared Image.
    resource_group_name str
    The name of the Resource Group in which the Shared Image Gallery exists.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists.
    name String
    The name of the Shared Image.
    resourceGroupName String
    The name of the Resource Group in which the Shared Image Gallery exists.

    getSharedImage Result

    The following output properties are available:

    Description string
    The description of this Shared Image.
    Eula string
    The End User Licence Agreement for the Shared Image.
    GalleryName string
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifiers List<GetSharedImageIdentifier>
    An identifier block as defined below.
    Location string
    The supported Azure location where the Shared Image Gallery exists.
    Name string
    OsType string
    The type of Operating System present in this Shared Image.
    PrivacyStatementUri string
    The URI containing the Privacy Statement for this Shared Image.
    ReleaseNoteUri string
    The URI containing the Release Notes for this Shared Image.
    ResourceGroupName string
    Specialized bool
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Shared Image.
    Description string
    The description of this Shared Image.
    Eula string
    The End User Licence Agreement for the Shared Image.
    GalleryName string
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifiers []GetSharedImageIdentifier
    An identifier block as defined below.
    Location string
    The supported Azure location where the Shared Image Gallery exists.
    Name string
    OsType string
    The type of Operating System present in this Shared Image.
    PrivacyStatementUri string
    The URI containing the Privacy Statement for this Shared Image.
    ReleaseNoteUri string
    The URI containing the Release Notes for this Shared Image.
    ResourceGroupName string
    Specialized bool
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    Tags map[string]string
    A mapping of tags assigned to the Shared Image.
    description String
    The description of this Shared Image.
    eula String
    The End User Licence Agreement for the Shared Image.
    galleryName String
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    id String
    The provider-assigned unique ID for this managed resource.
    identifiers List<GetSharedImageIdentifier>
    An identifier block as defined below.
    location String
    The supported Azure location where the Shared Image Gallery exists.
    name String
    osType String
    The type of Operating System present in this Shared Image.
    privacyStatementUri String
    The URI containing the Privacy Statement for this Shared Image.
    releaseNoteUri String
    The URI containing the Release Notes for this Shared Image.
    resourceGroupName String
    specialized Boolean
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    tags Map<String,String>
    A mapping of tags assigned to the Shared Image.
    description string
    The description of this Shared Image.
    eula string
    The End User Licence Agreement for the Shared Image.
    galleryName string
    hyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    id string
    The provider-assigned unique ID for this managed resource.
    identifiers GetSharedImageIdentifier[]
    An identifier block as defined below.
    location string
    The supported Azure location where the Shared Image Gallery exists.
    name string
    osType string
    The type of Operating System present in this Shared Image.
    privacyStatementUri string
    The URI containing the Privacy Statement for this Shared Image.
    releaseNoteUri string
    The URI containing the Release Notes for this Shared Image.
    resourceGroupName string
    specialized boolean
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    tags {[key: string]: string}
    A mapping of tags assigned to the Shared Image.
    description str
    The description of this Shared Image.
    eula str
    The End User Licence Agreement for the Shared Image.
    gallery_name str
    hyper_v_generation str
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    id str
    The provider-assigned unique ID for this managed resource.
    identifiers Sequence[GetSharedImageIdentifier]
    An identifier block as defined below.
    location str
    The supported Azure location where the Shared Image Gallery exists.
    name str
    os_type str
    The type of Operating System present in this Shared Image.
    privacy_statement_uri str
    The URI containing the Privacy Statement for this Shared Image.
    release_note_uri str
    The URI containing the Release Notes for this Shared Image.
    resource_group_name str
    specialized bool
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    tags Mapping[str, str]
    A mapping of tags assigned to the Shared Image.
    description String
    The description of this Shared Image.
    eula String
    The End User Licence Agreement for the Shared Image.
    galleryName String
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on.
    id String
    The provider-assigned unique ID for this managed resource.
    identifiers List<Property Map>
    An identifier block as defined below.
    location String
    The supported Azure location where the Shared Image Gallery exists.
    name String
    osType String
    The type of Operating System present in this Shared Image.
    privacyStatementUri String
    The URI containing the Privacy Statement for this Shared Image.
    releaseNoteUri String
    The URI containing the Release Notes for this Shared Image.
    resourceGroupName String
    specialized Boolean
    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run).
    tags Map<String>
    A mapping of tags assigned to the Shared Image.

    Supporting Types

    GetSharedImageIdentifier

    Offer string
    The Offer Name for this Shared Image.
    Publisher string
    The Publisher Name for this Gallery Image.
    Sku string
    The Name of the SKU for this Gallery Image.
    Offer string
    The Offer Name for this Shared Image.
    Publisher string
    The Publisher Name for this Gallery Image.
    Sku string
    The Name of the SKU for this Gallery Image.
    offer String
    The Offer Name for this Shared Image.
    publisher String
    The Publisher Name for this Gallery Image.
    sku String
    The Name of the SKU for this Gallery Image.
    offer string
    The Offer Name for this Shared Image.
    publisher string
    The Publisher Name for this Gallery Image.
    sku string
    The Name of the SKU for this Gallery Image.
    offer str
    The Offer Name for this Shared Image.
    publisher str
    The Publisher Name for this Gallery Image.
    sku str
    The Name of the SKU for this Gallery Image.
    offer String
    The Offer Name for this Shared Image.
    publisher String
    The Publisher Name for this Gallery Image.
    sku String
    The Name of the SKU for this Gallery Image.

    Package Details

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

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.