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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.compute.getSharedImageVersion

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.compute.getSharedImageVersion({
        name: "1.0.0",
        imageName: "my-image",
        galleryName: "my-image-gallery",
        resourceGroupName: "example-resources",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.compute.get_shared_image_version(name="1.0.0",
        image_name="my-image",
        gallery_name="my-image-gallery",
        resource_group_name="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.LookupSharedImageVersion(ctx, &compute.LookupSharedImageVersionArgs{
    			Name:              "1.0.0",
    			ImageName:         "my-image",
    			GalleryName:       "my-image-gallery",
    			ResourceGroupName: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.Compute.GetSharedImageVersion.Invoke(new()
        {
            Name = "1.0.0",
            ImageName = "my-image",
            GalleryName = "my-image-gallery",
            ResourceGroupName = "example-resources",
        });
    
    });
    
    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.GetSharedImageVersionArgs;
    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.getSharedImageVersion(GetSharedImageVersionArgs.builder()
                .name("1.0.0")
                .imageName("my-image")
                .galleryName("my-image-gallery")
                .resourceGroupName("example-resources")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:compute:getSharedImageVersion
          Arguments:
            name: 1.0.0
            imageName: my-image
            galleryName: my-image-gallery
            resourceGroupName: example-resources
    

    Using getSharedImageVersion

    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 getSharedImageVersion(args: GetSharedImageVersionArgs, opts?: InvokeOptions): Promise<GetSharedImageVersionResult>
    function getSharedImageVersionOutput(args: GetSharedImageVersionOutputArgs, opts?: InvokeOptions): Output<GetSharedImageVersionResult>
    def get_shared_image_version(gallery_name: Optional[str] = None,
                                 image_name: Optional[str] = None,
                                 name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 sort_versions_by_semver: Optional[bool] = None,
                                 tags: Optional[Mapping[str, str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetSharedImageVersionResult
    def get_shared_image_version_output(gallery_name: Optional[pulumi.Input[str]] = None,
                                 image_name: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 sort_versions_by_semver: Optional[pulumi.Input[bool]] = None,
                                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetSharedImageVersionResult]
    func LookupSharedImageVersion(ctx *Context, args *LookupSharedImageVersionArgs, opts ...InvokeOption) (*LookupSharedImageVersionResult, error)
    func LookupSharedImageVersionOutput(ctx *Context, args *LookupSharedImageVersionOutputArgs, opts ...InvokeOption) LookupSharedImageVersionResultOutput

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

    public static class GetSharedImageVersion 
    {
        public static Task<GetSharedImageVersionResult> InvokeAsync(GetSharedImageVersionArgs args, InvokeOptions? opts = null)
        public static Output<GetSharedImageVersionResult> Invoke(GetSharedImageVersionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSharedImageVersionResult> getSharedImageVersion(GetSharedImageVersionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:compute/getSharedImageVersion:getSharedImageVersion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    ImageName string
    The name of the Shared Image in which this Version exists.
    Name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    ResourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    SortVersionsBySemver bool
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Shared Image.
    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    ImageName string
    The name of the Shared Image in which this Version exists.
    Name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    ResourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    SortVersionsBySemver bool
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    Tags map[string]string
    A mapping of tags assigned to the Shared Image.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists.
    imageName String
    The name of the Shared Image in which this Version exists.
    name String

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    resourceGroupName String
    The name of the Resource Group in which the Shared Image Gallery exists.
    sortVersionsBySemver Boolean
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    tags Map<String,String>
    A mapping of tags assigned to the Shared Image.
    galleryName string
    The name of the Shared Image Gallery in which the Shared Image exists.
    imageName string
    The name of the Shared Image in which this Version exists.
    name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    resourceGroupName string
    The name of the Resource Group in which the Shared Image Gallery exists.
    sortVersionsBySemver boolean
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    tags {[key: string]: string}
    A mapping of tags assigned to the Shared Image.
    gallery_name str
    The name of the Shared Image Gallery in which the Shared Image exists.
    image_name str
    The name of the Shared Image in which this Version exists.
    name str

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    resource_group_name str
    The name of the Resource Group in which the Shared Image Gallery exists.
    sort_versions_by_semver bool
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    tags Mapping[str, str]
    A mapping of tags assigned to the Shared Image.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists.
    imageName String
    The name of the Shared Image in which this Version exists.
    name String

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    resourceGroupName String
    The name of the Resource Group in which the Shared Image Gallery exists.
    sortVersionsBySemver Boolean
    Sort available versions taking SemVer versioning scheme into account. Defaults to false.
    tags Map<String>
    A mapping of tags assigned to the Shared Image.

    getSharedImageVersion Result

    The following output properties are available:

    ExcludeFromLatest bool
    Is this Image Version excluded from the latest filter?
    GalleryName string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageName string
    Location string
    The supported Azure location where the Shared Image Gallery exists.
    ManagedImageId string
    The ID of the Managed Image which was the source of this Shared Image Version.
    Name string
    The Azure Region in which this Image Version exists.
    OsDiskImageSizeGb int
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    OsDiskSnapshotId string
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    ResourceGroupName string
    TargetRegions List<GetSharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    SortVersionsBySemver bool
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Shared Image.
    ExcludeFromLatest bool
    Is this Image Version excluded from the latest filter?
    GalleryName string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageName string
    Location string
    The supported Azure location where the Shared Image Gallery exists.
    ManagedImageId string
    The ID of the Managed Image which was the source of this Shared Image Version.
    Name string
    The Azure Region in which this Image Version exists.
    OsDiskImageSizeGb int
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    OsDiskSnapshotId string
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    ResourceGroupName string
    TargetRegions []GetSharedImageVersionTargetRegion
    One or more target_region blocks as documented below.
    SortVersionsBySemver bool
    Tags map[string]string
    A mapping of tags assigned to the Shared Image.
    excludeFromLatest Boolean
    Is this Image Version excluded from the latest filter?
    galleryName String
    id String
    The provider-assigned unique ID for this managed resource.
    imageName String
    location String
    The supported Azure location where the Shared Image Gallery exists.
    managedImageId String
    The ID of the Managed Image which was the source of this Shared Image Version.
    name String
    The Azure Region in which this Image Version exists.
    osDiskImageSizeGb Integer
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    osDiskSnapshotId String
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    resourceGroupName String
    targetRegions List<GetSharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    sortVersionsBySemver Boolean
    tags Map<String,String>
    A mapping of tags assigned to the Shared Image.
    excludeFromLatest boolean
    Is this Image Version excluded from the latest filter?
    galleryName string
    id string
    The provider-assigned unique ID for this managed resource.
    imageName string
    location string
    The supported Azure location where the Shared Image Gallery exists.
    managedImageId string
    The ID of the Managed Image which was the source of this Shared Image Version.
    name string
    The Azure Region in which this Image Version exists.
    osDiskImageSizeGb number
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    osDiskSnapshotId string
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    resourceGroupName string
    targetRegions GetSharedImageVersionTargetRegion[]
    One or more target_region blocks as documented below.
    sortVersionsBySemver boolean
    tags {[key: string]: string}
    A mapping of tags assigned to the Shared Image.
    exclude_from_latest bool
    Is this Image Version excluded from the latest filter?
    gallery_name str
    id str
    The provider-assigned unique ID for this managed resource.
    image_name str
    location str
    The supported Azure location where the Shared Image Gallery exists.
    managed_image_id str
    The ID of the Managed Image which was the source of this Shared Image Version.
    name str
    The Azure Region in which this Image Version exists.
    os_disk_image_size_gb int
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    os_disk_snapshot_id str
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    resource_group_name str
    target_regions Sequence[GetSharedImageVersionTargetRegion]
    One or more target_region blocks as documented below.
    sort_versions_by_semver bool
    tags Mapping[str, str]
    A mapping of tags assigned to the Shared Image.
    excludeFromLatest Boolean
    Is this Image Version excluded from the latest filter?
    galleryName String
    id String
    The provider-assigned unique ID for this managed resource.
    imageName String
    location String
    The supported Azure location where the Shared Image Gallery exists.
    managedImageId String
    The ID of the Managed Image which was the source of this Shared Image Version.
    name String
    The Azure Region in which this Image Version exists.
    osDiskImageSizeGb Number
    The size of the OS disk snapshot (in Gigabytes) which was the source of this Shared Image Version.
    osDiskSnapshotId String
    The ID of the OS disk snapshot which was the source of this Shared Image Version.
    resourceGroupName String
    targetRegions List<Property Map>
    One or more target_region blocks as documented below.
    sortVersionsBySemver Boolean
    tags Map<String>
    A mapping of tags assigned to the Shared Image.

    Supporting Types

    GetSharedImageVersionTargetRegion

    Name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    RegionalReplicaCount int
    The number of replicas of the Image Version to be created per region.
    StorageAccountType string
    The storage account type for the image version.
    Name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    RegionalReplicaCount int
    The number of replicas of the Image Version to be created per region.
    StorageAccountType string
    The storage account type for the image version.
    name String

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    regionalReplicaCount Integer
    The number of replicas of the Image Version to be created per region.
    storageAccountType String
    The storage account type for the image version.
    name string

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    regionalReplicaCount number
    The number of replicas of the Image Version to be created per region.
    storageAccountType string
    The storage account type for the image version.
    name str

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    regional_replica_count int
    The number of replicas of the Image Version to be created per region.
    storage_account_type str
    The storage account type for the image version.
    name String

    The name of the Image Version.

    Note: You may specify latest to obtain the latest version or recent to obtain the most recently updated version.

    Note: In 3.0, latest may return an image version with exclude_from_latest set to true. Starting from 4.0 onwards latest will not return image versions with exlude_from_latest set to true.

    regionalReplicaCount Number
    The number of replicas of the Image Version to be created per region.
    storageAccountType String
    The storage account type for the image version.

    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.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi