GetSharedImage

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/v3/go/azure/compute"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

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")

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",
}, { async: true }));

Using GetSharedImage

function getSharedImage(args: GetSharedImageArgs, opts?: InvokeOptions): Promise<GetSharedImageResult>

function  get_shared_image(gallery_name=None, name=None, resource_group_name=None, opts=None)

func LookupSharedImage(ctx *Context, args *LookupSharedImageArgs, opts ...InvokeOption) (*LookupSharedImageResult, error)

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

public static class GetSharedImage {
    public static Task<GetSharedImageResult> InvokeAsync(GetSharedImageArgs args, InvokeOptions? opts = null)
}

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.

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.

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
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
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
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 List[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
tags Dict[str, str]: A mapping of tags assigned to the Shared Image.

Supporting Types

GetSharedImageIdentifier

See the output API doc for this type.

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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetSharedImage

Example Usage

Using GetSharedImage

GetSharedImage Result

Supporting Types

GetSharedImageIdentifier

Package Details

On This Page