Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. GalleryImage
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.compute.GalleryImage

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Specifies information about the gallery image definition that you want to create or update.

    Uses Azure REST API version 2024-03-03. In version 2.x of the Azure Native provider, it used API version 2022-03-03.

    Other available API versions: 2022-03-03, 2022-08-03, 2023-07-03. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var galleryImage = new AzureNative.Compute.GalleryImage("galleryImage", new()
    {
        GalleryImageName = "myGalleryImageName",
        GalleryName = "myGalleryName",
        HyperVGeneration = AzureNative.Compute.HyperVGeneration.V1,
        Identifier = new AzureNative.Compute.Inputs.GalleryImageIdentifierArgs
        {
            Offer = "myOfferName",
            Publisher = "myPublisherName",
            Sku = "mySkuName",
        },
        Location = "West US",
        OsState = AzureNative.Compute.OperatingSystemStateTypes.Generalized,
        OsType = AzureNative.Compute.OperatingSystemTypes.Windows,
        ResourceGroupName = "myResourceGroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewGalleryImage(ctx, "galleryImage", &compute.GalleryImageArgs{
			GalleryImageName: pulumi.String("myGalleryImageName"),
			GalleryName:      pulumi.String("myGalleryName"),
			HyperVGeneration: pulumi.String(compute.HyperVGenerationV1),
			Identifier: &compute.GalleryImageIdentifierArgs{
				Offer:     pulumi.String("myOfferName"),
				Publisher: pulumi.String("myPublisherName"),
				Sku:       pulumi.String("mySkuName"),
			},
			Location:          pulumi.String("West US"),
			OsState:           compute.OperatingSystemStateTypesGeneralized,
			OsType:            compute.OperatingSystemTypesWindows,
			ResourceGroupName: pulumi.String("myResourceGroup"),
		})
		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.azurenative.compute.GalleryImage;
import com.pulumi.azurenative.compute.GalleryImageArgs;
import com.pulumi.azurenative.compute.inputs.GalleryImageIdentifierArgs;
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) {
        var galleryImage = new GalleryImage("galleryImage", GalleryImageArgs.builder()
            .galleryImageName("myGalleryImageName")
            .galleryName("myGalleryName")
            .hyperVGeneration("V1")
            .identifier(GalleryImageIdentifierArgs.builder()
                .offer("myOfferName")
                .publisher("myPublisherName")
                .sku("mySkuName")
                .build())
            .location("West US")
            .osState("Generalized")
            .osType("Windows")
            .resourceGroupName("myResourceGroup")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const galleryImage = new azure_native.compute.GalleryImage("galleryImage", {
    galleryImageName: "myGalleryImageName",
    galleryName: "myGalleryName",
    hyperVGeneration: azure_native.compute.HyperVGeneration.V1,
    identifier: {
        offer: "myOfferName",
        publisher: "myPublisherName",
        sku: "mySkuName",
    },
    location: "West US",
    osState: azure_native.compute.OperatingSystemStateTypes.Generalized,
    osType: azure_native.compute.OperatingSystemTypes.Windows,
    resourceGroupName: "myResourceGroup",
});

    import pulumi
import pulumi_azure_native as azure_native

gallery_image = azure_native.compute.GalleryImage("galleryImage",
    gallery_image_name="myGalleryImageName",
    gallery_name="myGalleryName",
    hyper_v_generation=azure_native.compute.HyperVGeneration.V1,
    identifier={
        "offer": "myOfferName",
        "publisher": "myPublisherName",
        "sku": "mySkuName",
    },
    location="West US",
    os_state=azure_native.compute.OperatingSystemStateTypes.GENERALIZED,
    os_type=azure_native.compute.OperatingSystemTypes.WINDOWS,
    resource_group_name="myResourceGroup")

    resources:
  galleryImage:
    type: azure-native:compute:GalleryImage
    properties:
      galleryImageName: myGalleryImageName
      galleryName: myGalleryName
      hyperVGeneration: V1
      identifier:
        offer: myOfferName
        publisher: myPublisherName
        sku: mySkuName
      location: West US
      osState: Generalized
      osType: Windows
      resourceGroupName: myResourceGroup

    Create GalleryImage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GalleryImage(name: string, args: GalleryImageArgs, opts?: CustomResourceOptions);
    @overload
def GalleryImage(resource_name: str,
                 args: GalleryImageArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def GalleryImage(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 gallery_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 os_type: Optional[OperatingSystemTypes] = None,
                 os_state: Optional[OperatingSystemStateTypes] = None,
                 identifier: Optional[GalleryImageIdentifierArgs] = None,
                 eula: Optional[str] = None,
                 disallowed: Optional[DisallowedArgs] = None,
                 gallery_image_name: Optional[str] = None,
                 allow_update_image: Optional[bool] = None,
                 hyper_v_generation: Optional[Union[str, HyperVGeneration]] = None,
                 end_of_life_date: Optional[str] = None,
                 location: Optional[str] = None,
                 features: Optional[Sequence[GalleryImageFeatureArgs]] = None,
                 description: Optional[str] = None,
                 privacy_statement_uri: Optional[str] = None,
                 purchase_plan: Optional[ImagePurchasePlanArgs] = None,
                 recommended: Optional[RecommendedMachineConfigurationArgs] = None,
                 release_note_uri: Optional[str] = None,
                 architecture: Optional[Union[str, Architecture]] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewGalleryImage(ctx *Context, name string, args GalleryImageArgs, opts ...ResourceOption) (*GalleryImage, error)
    public GalleryImage(string name, GalleryImageArgs args, CustomResourceOptions? opts = null)
    public GalleryImage(String name, GalleryImageArgs args)
public GalleryImage(String name, GalleryImageArgs args, CustomResourceOptions options)

    type: azure-native:compute:GalleryImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GalleryImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GalleryImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GalleryImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GalleryImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GalleryImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeGalleryImageResource = new AzureNative.Compute.GalleryImage("azure-nativeGalleryImageResource", new()
{
    GalleryName = "string",
    ResourceGroupName = "string",
    OsType = AzureNative.Compute.OperatingSystemTypes.Windows,
    OsState = AzureNative.Compute.OperatingSystemStateTypes.Generalized,
    Identifier = new AzureNative.Compute.Inputs.GalleryImageIdentifierArgs
    {
        Offer = "string",
        Publisher = "string",
        Sku = "string",
    },
    Eula = "string",
    Disallowed = new AzureNative.Compute.Inputs.DisallowedArgs
    {
        DiskTypes = new[]
        {
            "string",
        },
    },
    GalleryImageName = "string",
    AllowUpdateImage = false,
    HyperVGeneration = "string",
    EndOfLifeDate = "string",
    Location = "string",
    Features = new[]
    {
        new AzureNative.Compute.Inputs.GalleryImageFeatureArgs
        {
            Name = "string",
            StartsAtVersion = "string",
            Value = "string",
        },
    },
    Description = "string",
    PrivacyStatementUri = "string",
    PurchasePlan = new AzureNative.Compute.Inputs.ImagePurchasePlanArgs
    {
        Name = "string",
        Product = "string",
        Publisher = "string",
    },
    Recommended = new AzureNative.Compute.Inputs.RecommendedMachineConfigurationArgs
    {
        Memory = new AzureNative.Compute.Inputs.ResourceRangeArgs
        {
            Max = 0,
            Min = 0,
        },
        VCPUs = new AzureNative.Compute.Inputs.ResourceRangeArgs
        {
            Max = 0,
            Min = 0,
        },
    },
    ReleaseNoteUri = "string",
    Architecture = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := compute.NewGalleryImage(ctx, "azure-nativeGalleryImageResource", &compute.GalleryImageArgs{
	GalleryName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	OsType:            compute.OperatingSystemTypesWindows,
	OsState:           compute.OperatingSystemStateTypesGeneralized,
	Identifier: &compute.GalleryImageIdentifierArgs{
		Offer:     pulumi.String("string"),
		Publisher: pulumi.String("string"),
		Sku:       pulumi.String("string"),
	},
	Eula: pulumi.String("string"),
	Disallowed: &compute.DisallowedArgs{
		DiskTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	GalleryImageName: pulumi.String("string"),
	AllowUpdateImage: pulumi.Bool(false),
	HyperVGeneration: pulumi.String("string"),
	EndOfLifeDate:    pulumi.String("string"),
	Location:         pulumi.String("string"),
	Features: compute.GalleryImageFeatureArray{
		&compute.GalleryImageFeatureArgs{
			Name:            pulumi.String("string"),
			StartsAtVersion: pulumi.String("string"),
			Value:           pulumi.String("string"),
		},
	},
	Description:         pulumi.String("string"),
	PrivacyStatementUri: pulumi.String("string"),
	PurchasePlan: &compute.ImagePurchasePlanArgs{
		Name:      pulumi.String("string"),
		Product:   pulumi.String("string"),
		Publisher: pulumi.String("string"),
	},
	Recommended: &compute.RecommendedMachineConfigurationArgs{
		Memory: &compute.ResourceRangeArgs{
			Max: pulumi.Int(0),
			Min: pulumi.Int(0),
		},
		VCPUs: &compute.ResourceRangeArgs{
			Max: pulumi.Int(0),
			Min: pulumi.Int(0),
		},
	},
	ReleaseNoteUri: pulumi.String("string"),
	Architecture:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azure_nativeGalleryImageResource = new com.pulumi.azurenative.compute.GalleryImage("azure-nativeGalleryImageResource", com.pulumi.azurenative.compute.GalleryImageArgs.builder()
    .galleryName("string")
    .resourceGroupName("string")
    .osType("Windows")
    .osState("Generalized")
    .identifier(GalleryImageIdentifierArgs.builder()
        .offer("string")
        .publisher("string")
        .sku("string")
        .build())
    .eula("string")
    .disallowed(DisallowedArgs.builder()
        .diskTypes("string")
        .build())
    .galleryImageName("string")
    .allowUpdateImage(false)
    .hyperVGeneration("string")
    .endOfLifeDate("string")
    .location("string")
    .features(GalleryImageFeatureArgs.builder()
        .name("string")
        .startsAtVersion("string")
        .value("string")
        .build())
    .description("string")
    .privacyStatementUri("string")
    .purchasePlan(ImagePurchasePlanArgs.builder()
        .name("string")
        .product("string")
        .publisher("string")
        .build())
    .recommended(RecommendedMachineConfigurationArgs.builder()
        .memory(ResourceRangeArgs.builder()
            .max(0)
            .min(0)
            .build())
        .vCPUs(ResourceRangeArgs.builder()
            .max(0)
            .min(0)
            .build())
        .build())
    .releaseNoteUri("string")
    .architecture("string")
    .tags(Map.of("string", "string"))
    .build());

    azure_native_gallery_image_resource = azure_native.compute.GalleryImage("azure-nativeGalleryImageResource",
    gallery_name="string",
    resource_group_name="string",
    os_type=azure_native.compute.OperatingSystemTypes.WINDOWS,
    os_state=azure_native.compute.OperatingSystemStateTypes.GENERALIZED,
    identifier={
        "offer": "string",
        "publisher": "string",
        "sku": "string",
    },
    eula="string",
    disallowed={
        "disk_types": ["string"],
    },
    gallery_image_name="string",
    allow_update_image=False,
    hyper_v_generation="string",
    end_of_life_date="string",
    location="string",
    features=[{
        "name": "string",
        "starts_at_version": "string",
        "value": "string",
    }],
    description="string",
    privacy_statement_uri="string",
    purchase_plan={
        "name": "string",
        "product": "string",
        "publisher": "string",
    },
    recommended={
        "memory": {
            "max": 0,
            "min": 0,
        },
        "v_cpus": {
            "max": 0,
            "min": 0,
        },
    },
    release_note_uri="string",
    architecture="string",
    tags={
        "string": "string",
    })

    const azure_nativeGalleryImageResource = new azure_native.compute.GalleryImage("azure-nativeGalleryImageResource", {
    galleryName: "string",
    resourceGroupName: "string",
    osType: azure_native.compute.OperatingSystemTypes.Windows,
    osState: azure_native.compute.OperatingSystemStateTypes.Generalized,
    identifier: {
        offer: "string",
        publisher: "string",
        sku: "string",
    },
    eula: "string",
    disallowed: {
        diskTypes: ["string"],
    },
    galleryImageName: "string",
    allowUpdateImage: false,
    hyperVGeneration: "string",
    endOfLifeDate: "string",
    location: "string",
    features: [{
        name: "string",
        startsAtVersion: "string",
        value: "string",
    }],
    description: "string",
    privacyStatementUri: "string",
    purchasePlan: {
        name: "string",
        product: "string",
        publisher: "string",
    },
    recommended: {
        memory: {
            max: 0,
            min: 0,
        },
        vCPUs: {
            max: 0,
            min: 0,
        },
    },
    releaseNoteUri: "string",
    architecture: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:compute:GalleryImage
properties:
    allowUpdateImage: false
    architecture: string
    description: string
    disallowed:
        diskTypes:
            - string
    endOfLifeDate: string
    eula: string
    features:
        - name: string
          startsAtVersion: string
          value: string
    galleryImageName: string
    galleryName: string
    hyperVGeneration: string
    identifier:
        offer: string
        publisher: string
        sku: string
    location: string
    osState: Generalized
    osType: Windows
    privacyStatementUri: string
    purchasePlan:
        name: string
        product: string
        publisher: string
    recommended:
        memory:
            max: 0
            min: 0
        vCPUs:
            max: 0
            min: 0
    releaseNoteUri: string
    resourceGroupName: string
    tags:
        string: string

    GalleryImage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GalleryImage resource accepts the following input properties:

    GalleryName string
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    Identifier Pulumi.AzureNative.Compute.Inputs.GalleryImageIdentifier
    This is the gallery image definition identifier.
    OsState Pulumi.AzureNative.Compute.OperatingSystemStateTypes
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    OsType Pulumi.AzureNative.Compute.OperatingSystemTypes
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    ResourceGroupName string
    The name of the resource group.
    AllowUpdateImage bool
    Optional. Must be set to true if the gallery image features are being updated.
    Architecture string | Pulumi.AzureNative.Compute.Architecture
    The architecture of the image. Applicable to OS disks only.
    Description string
    The description of this gallery image definition resource. This property is updatable.
    Disallowed Pulumi.AzureNative.Compute.Inputs.Disallowed
    Describes the disallowed disk types.
    EndOfLifeDate string
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    Eula string
    The Eula agreement for the gallery image definition.
    Features List<Pulumi.AzureNative.Compute.Inputs.GalleryImageFeature>
    A list of gallery image features.
    GalleryImageName string
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    HyperVGeneration string | Pulumi.AzureNative.Compute.HyperVGeneration
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    Location string
    Resource location
    PrivacyStatementUri string
    The privacy statement uri.
    PurchasePlan Pulumi.AzureNative.Compute.Inputs.ImagePurchasePlan
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    Recommended Pulumi.AzureNative.Compute.Inputs.RecommendedMachineConfiguration
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    ReleaseNoteUri string
    The release note uri.
    Tags Dictionary<string, string>
    Resource tags
    GalleryName string
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    Identifier GalleryImageIdentifierArgs
    This is the gallery image definition identifier.
    OsState OperatingSystemStateTypes
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    OsType OperatingSystemTypes
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    ResourceGroupName string
    The name of the resource group.
    AllowUpdateImage bool
    Optional. Must be set to true if the gallery image features are being updated.
    Architecture string | Architecture
    The architecture of the image. Applicable to OS disks only.
    Description string
    The description of this gallery image definition resource. This property is updatable.
    Disallowed DisallowedArgs
    Describes the disallowed disk types.
    EndOfLifeDate string
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    Eula string
    The Eula agreement for the gallery image definition.
    Features []GalleryImageFeatureArgs
    A list of gallery image features.
    GalleryImageName string
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    HyperVGeneration string | HyperVGeneration
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    Location string
    Resource location
    PrivacyStatementUri string
    The privacy statement uri.
    PurchasePlan ImagePurchasePlanArgs
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    Recommended RecommendedMachineConfigurationArgs
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    ReleaseNoteUri string
    The release note uri.
    Tags map[string]string
    Resource tags
    galleryName String
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    identifier GalleryImageIdentifier
    This is the gallery image definition identifier.
    osState OperatingSystemStateTypes
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    osType OperatingSystemTypes
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    resourceGroupName String
    The name of the resource group.
    allowUpdateImage Boolean
    Optional. Must be set to true if the gallery image features are being updated.
    architecture String | Architecture
    The architecture of the image. Applicable to OS disks only.
    description String
    The description of this gallery image definition resource. This property is updatable.
    disallowed Disallowed
    Describes the disallowed disk types.
    endOfLifeDate String
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    eula String
    The Eula agreement for the gallery image definition.
    features List<GalleryImageFeature>
    A list of gallery image features.
    galleryImageName String
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    hyperVGeneration String | HyperVGeneration
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    location String
    Resource location
    privacyStatementUri String
    The privacy statement uri.
    purchasePlan ImagePurchasePlan
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    recommended RecommendedMachineConfiguration
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    releaseNoteUri String
    The release note uri.
    tags Map<String,String>
    Resource tags
    galleryName string
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    identifier GalleryImageIdentifier
    This is the gallery image definition identifier.
    osState OperatingSystemStateTypes
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    osType OperatingSystemTypes
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    resourceGroupName string
    The name of the resource group.
    allowUpdateImage boolean
    Optional. Must be set to true if the gallery image features are being updated.
    architecture string | Architecture
    The architecture of the image. Applicable to OS disks only.
    description string
    The description of this gallery image definition resource. This property is updatable.
    disallowed Disallowed
    Describes the disallowed disk types.
    endOfLifeDate string
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    eula string
    The Eula agreement for the gallery image definition.
    features GalleryImageFeature[]
    A list of gallery image features.
    galleryImageName string
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    hyperVGeneration string | HyperVGeneration
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    location string
    Resource location
    privacyStatementUri string
    The privacy statement uri.
    purchasePlan ImagePurchasePlan
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    recommended RecommendedMachineConfiguration
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    releaseNoteUri string
    The release note uri.
    tags {[key: string]: string}
    Resource tags
    gallery_name str
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    identifier GalleryImageIdentifierArgs
    This is the gallery image definition identifier.
    os_state OperatingSystemStateTypes
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    os_type OperatingSystemTypes
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    resource_group_name str
    The name of the resource group.
    allow_update_image bool
    Optional. Must be set to true if the gallery image features are being updated.
    architecture str | Architecture
    The architecture of the image. Applicable to OS disks only.
    description str
    The description of this gallery image definition resource. This property is updatable.
    disallowed DisallowedArgs
    Describes the disallowed disk types.
    end_of_life_date str
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    eula str
    The Eula agreement for the gallery image definition.
    features Sequence[GalleryImageFeatureArgs]
    A list of gallery image features.
    gallery_image_name str
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    hyper_v_generation str | HyperVGeneration
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    location str
    Resource location
    privacy_statement_uri str
    The privacy statement uri.
    purchase_plan ImagePurchasePlanArgs
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    recommended RecommendedMachineConfigurationArgs
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    release_note_uri str
    The release note uri.
    tags Mapping[str, str]
    Resource tags
    galleryName String
    The name of the Shared Image Gallery in which the Image Definition is to be created.
    identifier Property Map
    This is the gallery image definition identifier.
    osState "Generalized" | "Specialized"
    This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
    osType "Windows" | "Linux"
    This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
    resourceGroupName String
    The name of the resource group.
    allowUpdateImage Boolean
    Optional. Must be set to true if the gallery image features are being updated.
    architecture String | "x64" | "Arm64"
    The architecture of the image. Applicable to OS disks only.
    description String
    The description of this gallery image definition resource. This property is updatable.
    disallowed Property Map
    Describes the disallowed disk types.
    endOfLifeDate String
    The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
    eula String
    The Eula agreement for the gallery image definition.
    features List<Property Map>
    A list of gallery image features.
    galleryImageName String
    The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
    hyperVGeneration String | "V1" | "V2"
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    location String
    Resource location
    privacyStatementUri String
    The privacy statement uri.
    purchasePlan Property Map
    Describes the gallery image definition purchase plan. This is used by marketplace images.
    recommended Property Map
    The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
    releaseNoteUri String
    The release note uri.
    tags Map<String>
    Resource tags

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GalleryImage resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    ProvisioningState string
    The provisioning state, which only appears in the response.
    Type string
    Resource type
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    ProvisioningState string
    The provisioning state, which only appears in the response.
    Type string
    Resource type
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    provisioningState String
    The provisioning state, which only appears in the response.
    type String
    Resource type
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    provisioningState string
    The provisioning state, which only appears in the response.
    type string
    Resource type
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    provisioning_state str
    The provisioning state, which only appears in the response.
    type str
    Resource type
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    provisioningState String
    The provisioning state, which only appears in the response.
    type String
    Resource type

    Supporting Types

    Architecture, ArchitectureArgs

    X64
    x64
    Arm64
    Arm64
    ArchitectureX64
    x64
    ArchitectureArm64
    Arm64
    X64
    x64
    Arm64
    Arm64
    X64
    x64
    Arm64
    Arm64
    X64
    x64
    ARM64
    Arm64
    "x64"
    x64
    "Arm64"
    Arm64

    Disallowed, DisallowedArgs

    DiskTypes List<string>
    A list of disk types.
    DiskTypes []string
    A list of disk types.
    diskTypes List<String>
    A list of disk types.
    diskTypes string[]
    A list of disk types.
    disk_types Sequence[str]
    A list of disk types.
    diskTypes List<String>
    A list of disk types.

    DisallowedResponse, DisallowedResponseArgs

    DiskTypes List<string>
    A list of disk types.
    DiskTypes []string
    A list of disk types.
    diskTypes List<String>
    A list of disk types.
    diskTypes string[]
    A list of disk types.
    disk_types Sequence[str]
    A list of disk types.
    diskTypes List<String>
    A list of disk types.

    GalleryImageFeature, GalleryImageFeatureArgs

    Name string
    The name of the gallery image feature.
    StartsAtVersion string
    The minimum gallery image version which supports this feature.
    Value string
    The value of the gallery image feature.
    Name string
    The name of the gallery image feature.
    StartsAtVersion string
    The minimum gallery image version which supports this feature.
    Value string
    The value of the gallery image feature.
    name String
    The name of the gallery image feature.
    startsAtVersion String
    The minimum gallery image version which supports this feature.
    value String
    The value of the gallery image feature.
    name string
    The name of the gallery image feature.
    startsAtVersion string
    The minimum gallery image version which supports this feature.
    value string
    The value of the gallery image feature.
    name str
    The name of the gallery image feature.
    starts_at_version str
    The minimum gallery image version which supports this feature.
    value str
    The value of the gallery image feature.
    name String
    The name of the gallery image feature.
    startsAtVersion String
    The minimum gallery image version which supports this feature.
    value String
    The value of the gallery image feature.

    GalleryImageFeatureResponse, GalleryImageFeatureResponseArgs

    Name string
    The name of the gallery image feature.
    StartsAtVersion string
    The minimum gallery image version which supports this feature.
    Value string
    The value of the gallery image feature.
    Name string
    The name of the gallery image feature.
    StartsAtVersion string
    The minimum gallery image version which supports this feature.
    Value string
    The value of the gallery image feature.
    name String
    The name of the gallery image feature.
    startsAtVersion String
    The minimum gallery image version which supports this feature.
    value String
    The value of the gallery image feature.
    name string
    The name of the gallery image feature.
    startsAtVersion string
    The minimum gallery image version which supports this feature.
    value string
    The value of the gallery image feature.
    name str
    The name of the gallery image feature.
    starts_at_version str
    The minimum gallery image version which supports this feature.
    value str
    The value of the gallery image feature.
    name String
    The name of the gallery image feature.
    startsAtVersion String
    The minimum gallery image version which supports this feature.
    value String
    The value of the gallery image feature.

    GalleryImageIdentifier, GalleryImageIdentifierArgs

    Offer string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    Offer string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.
    offer string
    The name of the gallery image definition offer.
    publisher string
    The name of the gallery image definition publisher.
    sku string
    The name of the gallery image definition SKU.
    offer str
    The name of the gallery image definition offer.
    publisher str
    The name of the gallery image definition publisher.
    sku str
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.

    GalleryImageIdentifierResponse, GalleryImageIdentifierResponseArgs

    Offer string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    Offer string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.
    offer string
    The name of the gallery image definition offer.
    publisher string
    The name of the gallery image definition publisher.
    sku string
    The name of the gallery image definition SKU.
    offer str
    The name of the gallery image definition offer.
    publisher str
    The name of the gallery image definition publisher.
    sku str
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.

    HyperVGeneration, HyperVGenerationArgs

    V1
    V1
    V2
    V2
    HyperVGenerationV1
    V1
    HyperVGenerationV2
    V2
    V1
    V1
    V2
    V2
    V1
    V1
    V2
    V2
    V1
    V1
    V2
    V2
    "V1"
    V1
    "V2"
    V2

    ImagePurchasePlan, ImagePurchasePlanArgs

    Name string
    The plan ID.
    Product string
    The product ID.
    Publisher string
    The publisher ID.
    Name string
    The plan ID.
    Product string
    The product ID.
    Publisher string
    The publisher ID.
    name String
    The plan ID.
    product String
    The product ID.
    publisher String
    The publisher ID.
    name string
    The plan ID.
    product string
    The product ID.
    publisher string
    The publisher ID.
    name str
    The plan ID.
    product str
    The product ID.
    publisher str
    The publisher ID.
    name String
    The plan ID.
    product String
    The product ID.
    publisher String
    The publisher ID.

    ImagePurchasePlanResponse, ImagePurchasePlanResponseArgs

    Name string
    The plan ID.
    Product string
    The product ID.
    Publisher string
    The publisher ID.
    Name string
    The plan ID.
    Product string
    The product ID.
    Publisher string
    The publisher ID.
    name String
    The plan ID.
    product String
    The product ID.
    publisher String
    The publisher ID.
    name string
    The plan ID.
    product string
    The product ID.
    publisher string
    The publisher ID.
    name str
    The plan ID.
    product str
    The product ID.
    publisher str
    The publisher ID.
    name String
    The plan ID.
    product String
    The product ID.
    publisher String
    The publisher ID.

    OperatingSystemStateTypes, OperatingSystemStateTypesArgs

    Generalized
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    Specialized
    SpecializedSpecialized image. Contains already provisioned OS Disk.
    OperatingSystemStateTypesGeneralized
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    OperatingSystemStateTypesSpecialized
    SpecializedSpecialized image. Contains already provisioned OS Disk.
    Generalized
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    Specialized
    SpecializedSpecialized image. Contains already provisioned OS Disk.
    Generalized
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    Specialized
    SpecializedSpecialized image. Contains already provisioned OS Disk.
    GENERALIZED
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    SPECIALIZED
    SpecializedSpecialized image. Contains already provisioned OS Disk.
    "Generalized"
    GeneralizedGeneralized image. Needs to be provisioned during deployment time.
    "Specialized"
    SpecializedSpecialized image. Contains already provisioned OS Disk.

    OperatingSystemTypes, OperatingSystemTypesArgs

    Windows
    Windows
    Linux
    Linux
    OperatingSystemTypesWindows
    Windows
    OperatingSystemTypesLinux
    Linux
    Windows
    Windows
    Linux
    Linux
    Windows
    Windows
    Linux
    Linux
    WINDOWS
    Windows
    LINUX
    Linux
    "Windows"
    Windows
    "Linux"
    Linux

    RecommendedMachineConfiguration, RecommendedMachineConfigurationArgs

    Memory ResourceRange
    Describes the resource range.
    VCPUs ResourceRange
    Describes the resource range.
    memory ResourceRange
    Describes the resource range.
    vCPUs ResourceRange
    Describes the resource range.
    memory ResourceRange
    Describes the resource range.
    vCPUs ResourceRange
    Describes the resource range.
    memory ResourceRange
    Describes the resource range.
    v_cpus ResourceRange
    Describes the resource range.
    memory Property Map
    Describes the resource range.
    vCPUs Property Map
    Describes the resource range.

    RecommendedMachineConfigurationResponse, RecommendedMachineConfigurationResponseArgs

    Memory ResourceRangeResponse
    Describes the resource range.
    VCPUs ResourceRangeResponse
    Describes the resource range.
    memory ResourceRangeResponse
    Describes the resource range.
    vCPUs ResourceRangeResponse
    Describes the resource range.
    memory ResourceRangeResponse
    Describes the resource range.
    vCPUs ResourceRangeResponse
    Describes the resource range.
    memory ResourceRangeResponse
    Describes the resource range.
    v_cpus ResourceRangeResponse
    Describes the resource range.
    memory Property Map
    Describes the resource range.
    vCPUs Property Map
    Describes the resource range.

    ResourceRange, ResourceRangeArgs

    Max int
    The maximum number of the resource.
    Min int
    The minimum number of the resource.
    Max int
    The maximum number of the resource.
    Min int
    The minimum number of the resource.
    max Integer
    The maximum number of the resource.
    min Integer
    The minimum number of the resource.
    max number
    The maximum number of the resource.
    min number
    The minimum number of the resource.
    max int
    The maximum number of the resource.
    min int
    The minimum number of the resource.
    max Number
    The maximum number of the resource.
    min Number
    The minimum number of the resource.

    ResourceRangeResponse, ResourceRangeResponseArgs

    Max int
    The maximum number of the resource.
    Min int
    The minimum number of the resource.
    Max int
    The maximum number of the resource.
    Min int
    The minimum number of the resource.
    max Integer
    The maximum number of the resource.
    min Integer
    The minimum number of the resource.
    max number
    The maximum number of the resource.
    min number
    The minimum number of the resource.
    max int
    The maximum number of the resource.
    min int
    The minimum number of the resource.
    max Number
    The maximum number of the resource.
    min Number
    The minimum number of the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:compute:GalleryImage myGalleryImageName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native