We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.compute.getSharedImage
Use this data source to access information about an existing 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.getSharedImage({
name: "my-image",
galleryName: "my-image-gallery",
resourceGroupName: "example-resources",
});
import pulumi
import pulumi_azure as azure
example = azure.compute.get_shared_image(name="my-image",
gallery_name="my-image-gallery",
resource_group_name="example-resources")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/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{
Name: "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.GetSharedImage.Invoke(new()
{
Name = "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.GetSharedImageArgs;
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.getSharedImage(GetSharedImageArgs.builder()
.name("my-image")
.galleryName("my-image-gallery")
.resourceGroupName("example-resources")
.build());
}
}
variables:
example:
fn::invoke:
function: azure:compute:getSharedImage
arguments:
name: my-image
galleryName: my-image-gallery
resourceGroupName: example-resources
API Providers
This data source uses the following Azure API Providers:
Microsoft.Compute
- 2022-03-03
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:
- Gallery
Name string - The name of the Shared Image Gallery in which the Shared Image exists.
- Name string
- The name of the Shared Image.
- Resource
Group stringName - The name of the Resource Group in which the Shared Image Gallery exists.
- Gallery
Name string - The name of the Shared Image Gallery in which the Shared Image exists.
- Name string
- The name of the Shared Image.
- Resource
Group stringName - The name of the Resource Group in which the Shared Image Gallery exists.
- gallery
Name String - The name of the Shared Image Gallery in which the Shared Image exists.
- name String
- The name of the Shared Image.
- resource
Group StringName - The name of the Resource Group in which the Shared Image Gallery exists.
- gallery
Name string - The name of the Shared Image Gallery in which the Shared Image exists.
- name string
- The name of the Shared Image.
- resource
Group stringName - 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_ strname - The name of the Resource Group in which the Shared Image Gallery exists.
- gallery
Name String - The name of the Shared Image Gallery in which the Shared Image exists.
- name String
- The name of the Shared Image.
- resource
Group StringName - The name of the Resource Group in which the Shared Image Gallery exists.
getSharedImage Result
The following output properties are available:
- Accelerated
Network boolSupport Enabled - Specifies if the Shared Image supports Accelerated Network.
- Architecture string
- Confidential
Vm boolEnabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- Confidential
Vm boolSupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- Description string
- The description of this Shared Image.
- Eula string
- The End User Licence Agreement for the Shared Image.
- Gallery
Name string - Hibernation
Enabled bool - Specifies if the Shared Image supports hibernation.
- Hyper
VGeneration 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<Get
Shared Image Identifier> - An
identifier
block as defined below. - Location string
- The supported Azure location where the Shared Image Gallery exists.
- Name string
- (Required) The Purchase Plan Name for this Shared Image.
- Os
Type string - The type of Operating System present in this Shared Image.
- Privacy
Statement stringUri - The URI containing the Privacy Statement for this Shared Image.
- Purchase
Plans List<GetShared Image Purchase Plan> - (Optional) A
purchase_plan
block as defined below. - Release
Note stringUri - The URI containing the Release Notes for this Shared Image.
- Resource
Group stringName - Specialized bool
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - Dictionary<string, string>
- A mapping of tags assigned to the Shared Image.
- Trusted
Launch boolEnabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- Trusted
Launch boolSupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
- Accelerated
Network boolSupport Enabled - Specifies if the Shared Image supports Accelerated Network.
- Architecture string
- Confidential
Vm boolEnabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- Confidential
Vm boolSupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- Description string
- The description of this Shared Image.
- Eula string
- The End User Licence Agreement for the Shared Image.
- Gallery
Name string - Hibernation
Enabled bool - Specifies if the Shared Image supports hibernation.
- Hyper
VGeneration 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
[]Get
Shared Image Identifier - An
identifier
block as defined below. - Location string
- The supported Azure location where the Shared Image Gallery exists.
- Name string
- (Required) The Purchase Plan Name for this Shared Image.
- Os
Type string - The type of Operating System present in this Shared Image.
- Privacy
Statement stringUri - The URI containing the Privacy Statement for this Shared Image.
- Purchase
Plans []GetShared Image Purchase Plan - (Optional) A
purchase_plan
block as defined below. - Release
Note stringUri - The URI containing the Release Notes for this Shared Image.
- Resource
Group stringName - Specialized bool
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - map[string]string
- A mapping of tags assigned to the Shared Image.
- Trusted
Launch boolEnabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- Trusted
Launch boolSupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
- accelerated
Network BooleanSupport Enabled - Specifies if the Shared Image supports Accelerated Network.
- architecture String
- confidential
Vm BooleanEnabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- confidential
Vm BooleanSupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- description String
- The description of this Shared Image.
- eula String
- The End User Licence Agreement for the Shared Image.
- gallery
Name String - hibernation
Enabled Boolean - Specifies if the Shared Image supports hibernation.
- hyper
VGeneration 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<Get
Shared Image Identifier> - An
identifier
block as defined below. - location String
- The supported Azure location where the Shared Image Gallery exists.
- name String
- (Required) The Purchase Plan Name for this Shared Image.
- os
Type String - The type of Operating System present in this Shared Image.
- privacy
Statement StringUri - The URI containing the Privacy Statement for this Shared Image.
- purchase
Plans List<GetShared Image Purchase Plan> - (Optional) A
purchase_plan
block as defined below. - release
Note StringUri - The URI containing the Release Notes for this Shared Image.
- resource
Group StringName - specialized Boolean
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - Map<String,String>
- A mapping of tags assigned to the Shared Image.
- trusted
Launch BooleanEnabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- trusted
Launch BooleanSupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
- accelerated
Network booleanSupport Enabled - Specifies if the Shared Image supports Accelerated Network.
- architecture string
- confidential
Vm booleanEnabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- confidential
Vm booleanSupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- description string
- The description of this Shared Image.
- eula string
- The End User Licence Agreement for the Shared Image.
- gallery
Name string - hibernation
Enabled boolean - Specifies if the Shared Image supports hibernation.
- hyper
VGeneration 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
Get
Shared Image Identifier[] - An
identifier
block as defined below. - location string
- The supported Azure location where the Shared Image Gallery exists.
- name string
- (Required) The Purchase Plan Name for this Shared Image.
- os
Type string - The type of Operating System present in this Shared Image.
- privacy
Statement stringUri - The URI containing the Privacy Statement for this Shared Image.
- purchase
Plans GetShared Image Purchase Plan[] - (Optional) A
purchase_plan
block as defined below. - release
Note stringUri - The URI containing the Release Notes for this Shared Image.
- resource
Group stringName - specialized boolean
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - {[key: string]: string}
- A mapping of tags assigned to the Shared Image.
- trusted
Launch booleanEnabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- trusted
Launch booleanSupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
- accelerated_
network_ boolsupport_ enabled - Specifies if the Shared Image supports Accelerated Network.
- architecture str
- confidential_
vm_ boolenabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- confidential_
vm_ boolsupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- description str
- The description of this Shared Image.
- eula str
- The End User Licence Agreement for the Shared Image.
- gallery_
name str - hibernation_
enabled bool - Specifies if the Shared Image supports hibernation.
- hyper_
v_ strgeneration - 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[Get
Shared Image Identifier] - An
identifier
block as defined below. - location str
- The supported Azure location where the Shared Image Gallery exists.
- name str
- (Required) The Purchase Plan Name for this Shared Image.
- os_
type str - The type of Operating System present in this Shared Image.
- privacy_
statement_ struri - The URI containing the Privacy Statement for this Shared Image.
- purchase_
plans Sequence[GetShared Image Purchase Plan] - (Optional) A
purchase_plan
block as defined below. - release_
note_ struri - The URI containing the Release Notes for this Shared Image.
- resource_
group_ strname - specialized bool
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - Mapping[str, str]
- A mapping of tags assigned to the Shared Image.
- trusted_
launch_ boolenabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- trusted_
launch_ boolsupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
- accelerated
Network BooleanSupport Enabled - Specifies if the Shared Image supports Accelerated Network.
- architecture String
- confidential
Vm BooleanEnabled - Specifies if Confidential Virtual Machines enabled. It will enable all the features of trusted, with higher confidentiality features for isolate machines or encrypted data. Available for Gen2 machines.
- confidential
Vm BooleanSupported - Specifies if supports creation of both Confidential virtual machines and Gen2 virtual machines with standard security from a compatible Gen2 OS disk VHD or Gen2 Managed image.
- description String
- The description of this Shared Image.
- eula String
- The End User Licence Agreement for the Shared Image.
- gallery
Name String - hibernation
Enabled Boolean - Specifies if the Shared Image supports hibernation.
- hyper
VGeneration 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
- (Required) The Purchase Plan Name for this Shared Image.
- os
Type String - The type of Operating System present in this Shared Image.
- privacy
Statement StringUri - The URI containing the Privacy Statement for this Shared Image.
- purchase
Plans List<Property Map> - (Optional) A
purchase_plan
block as defined below. - release
Note StringUri - The URI containing the Release Notes for this Shared Image.
- resource
Group StringName - specialized Boolean
- Specifies that the Operating System used inside this Image has not been Generalized (for example,
sysprep
on Windows has not been run). - Map<String>
- A mapping of tags assigned to the Shared Image.
- trusted
Launch BooleanEnabled - Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image.
- trusted
Launch BooleanSupported - Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image.
Supporting Types
GetSharedImageIdentifier
GetSharedImagePurchasePlan
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.