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

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

azure.compute.SharedImage

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

    Manages a Shared Image within a Shared Image Gallery.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleSharedImageGallery = new azure.compute.SharedImageGallery("example", {
        name: "example_image_gallery",
        resourceGroupName: example.name,
        location: example.location,
        description: "Shared images and things.",
        tags: {
            Hello: "There",
            World: "Example",
        },
    });
    const exampleSharedImage = new azure.compute.SharedImage("example", {
        name: "my-image",
        galleryName: exampleSharedImageGallery.name,
        resourceGroupName: example.name,
        location: example.location,
        osType: "Linux",
        identifier: {
            publisher: "PublisherName",
            offer: "OfferName",
            sku: "ExampleSku",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_shared_image_gallery = azure.compute.SharedImageGallery("example",
        name="example_image_gallery",
        resource_group_name=example.name,
        location=example.location,
        description="Shared images and things.",
        tags={
            "Hello": "There",
            "World": "Example",
        })
    example_shared_image = azure.compute.SharedImage("example",
        name="my-image",
        gallery_name=example_shared_image_gallery.name,
        resource_group_name=example.name,
        location=example.location,
        os_type="Linux",
        identifier={
            "publisher": "PublisherName",
            "offer": "OfferName",
            "sku": "ExampleSku",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSharedImageGallery, err := compute.NewSharedImageGallery(ctx, "example", &compute.SharedImageGalleryArgs{
    			Name:              pulumi.String("example_image_gallery"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Description:       pulumi.String("Shared images and things."),
    			Tags: pulumi.StringMap{
    				"Hello": pulumi.String("There"),
    				"World": pulumi.String("Example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewSharedImage(ctx, "example", &compute.SharedImageArgs{
    			Name:              pulumi.String("my-image"),
    			GalleryName:       exampleSharedImageGallery.Name,
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			OsType:            pulumi.String("Linux"),
    			Identifier: &compute.SharedImageIdentifierArgs{
    				Publisher: pulumi.String("PublisherName"),
    				Offer:     pulumi.String("OfferName"),
    				Sku:       pulumi.String("ExampleSku"),
    			},
    		})
    		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 = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleSharedImageGallery = new Azure.Compute.SharedImageGallery("example", new()
        {
            Name = "example_image_gallery",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Description = "Shared images and things.",
            Tags = 
            {
                { "Hello", "There" },
                { "World", "Example" },
            },
        });
    
        var exampleSharedImage = new Azure.Compute.SharedImage("example", new()
        {
            Name = "my-image",
            GalleryName = exampleSharedImageGallery.Name,
            ResourceGroupName = example.Name,
            Location = example.Location,
            OsType = "Linux",
            Identifier = new Azure.Compute.Inputs.SharedImageIdentifierArgs
            {
                Publisher = "PublisherName",
                Offer = "OfferName",
                Sku = "ExampleSku",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.compute.SharedImageGallery;
    import com.pulumi.azure.compute.SharedImageGalleryArgs;
    import com.pulumi.azure.compute.SharedImage;
    import com.pulumi.azure.compute.SharedImageArgs;
    import com.pulumi.azure.compute.inputs.SharedImageIdentifierArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleSharedImageGallery = new SharedImageGallery("exampleSharedImageGallery", SharedImageGalleryArgs.builder()
                .name("example_image_gallery")
                .resourceGroupName(example.name())
                .location(example.location())
                .description("Shared images and things.")
                .tags(Map.ofEntries(
                    Map.entry("Hello", "There"),
                    Map.entry("World", "Example")
                ))
                .build());
    
            var exampleSharedImage = new SharedImage("exampleSharedImage", SharedImageArgs.builder()
                .name("my-image")
                .galleryName(exampleSharedImageGallery.name())
                .resourceGroupName(example.name())
                .location(example.location())
                .osType("Linux")
                .identifier(SharedImageIdentifierArgs.builder()
                    .publisher("PublisherName")
                    .offer("OfferName")
                    .sku("ExampleSku")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleSharedImageGallery:
        type: azure:compute:SharedImageGallery
        name: example
        properties:
          name: example_image_gallery
          resourceGroupName: ${example.name}
          location: ${example.location}
          description: Shared images and things.
          tags:
            Hello: There
            World: Example
      exampleSharedImage:
        type: azure:compute:SharedImage
        name: example
        properties:
          name: my-image
          galleryName: ${exampleSharedImageGallery.name}
          resourceGroupName: ${example.name}
          location: ${example.location}
          osType: Linux
          identifier:
            publisher: PublisherName
            offer: OfferName
            sku: ExampleSku
    

    Create SharedImage Resource

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

    Constructor syntax

    new SharedImage(name: string, args: SharedImageArgs, opts?: CustomResourceOptions);
    @overload
    def SharedImage(resource_name: str,
                    args: SharedImageArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SharedImage(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    gallery_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    os_type: Optional[str] = None,
                    identifier: Optional[SharedImageIdentifierArgs] = None,
                    end_of_life_date: Optional[str] = None,
                    min_recommended_memory_in_gb: Optional[int] = None,
                    accelerated_network_support_enabled: Optional[bool] = None,
                    eula: Optional[str] = None,
                    description: Optional[str] = None,
                    hibernation_enabled: Optional[bool] = None,
                    hyper_v_generation: Optional[str] = None,
                    confidential_vm_supported: Optional[bool] = None,
                    location: Optional[str] = None,
                    max_recommended_memory_in_gb: Optional[int] = None,
                    max_recommended_vcpu_count: Optional[int] = None,
                    disk_types_not_alloweds: Optional[Sequence[str]] = None,
                    min_recommended_vcpu_count: Optional[int] = None,
                    name: Optional[str] = None,
                    confidential_vm_enabled: Optional[bool] = None,
                    privacy_statement_uri: Optional[str] = None,
                    purchase_plan: Optional[SharedImagePurchasePlanArgs] = None,
                    release_note_uri: Optional[str] = None,
                    architecture: Optional[str] = None,
                    specialized: Optional[bool] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    trusted_launch_enabled: Optional[bool] = None,
                    trusted_launch_supported: Optional[bool] = None)
    func NewSharedImage(ctx *Context, name string, args SharedImageArgs, opts ...ResourceOption) (*SharedImage, error)
    public SharedImage(string name, SharedImageArgs args, CustomResourceOptions? opts = null)
    public SharedImage(String name, SharedImageArgs args)
    public SharedImage(String name, SharedImageArgs args, CustomResourceOptions options)
    
    type: azure:compute:SharedImage
    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 SharedImageArgs
    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 SharedImageArgs
    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 SharedImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedImageArgs
    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 sharedImageResource = new Azure.Compute.SharedImage("sharedImageResource", new()
    {
        GalleryName = "string",
        ResourceGroupName = "string",
        OsType = "string",
        Identifier = new Azure.Compute.Inputs.SharedImageIdentifierArgs
        {
            Offer = "string",
            Publisher = "string",
            Sku = "string",
        },
        EndOfLifeDate = "string",
        MinRecommendedMemoryInGb = 0,
        AcceleratedNetworkSupportEnabled = false,
        Eula = "string",
        Description = "string",
        HibernationEnabled = false,
        HyperVGeneration = "string",
        ConfidentialVmSupported = false,
        Location = "string",
        MaxRecommendedMemoryInGb = 0,
        MaxRecommendedVcpuCount = 0,
        DiskTypesNotAlloweds = new[]
        {
            "string",
        },
        MinRecommendedVcpuCount = 0,
        Name = "string",
        ConfidentialVmEnabled = false,
        PrivacyStatementUri = "string",
        PurchasePlan = new Azure.Compute.Inputs.SharedImagePurchasePlanArgs
        {
            Name = "string",
            Product = "string",
            Publisher = "string",
        },
        ReleaseNoteUri = "string",
        Architecture = "string",
        Specialized = false,
        Tags = 
        {
            { "string", "string" },
        },
        TrustedLaunchEnabled = false,
        TrustedLaunchSupported = false,
    });
    
    example, err := compute.NewSharedImage(ctx, "sharedImageResource", &compute.SharedImageArgs{
    	GalleryName:       pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	OsType:            pulumi.String("string"),
    	Identifier: &compute.SharedImageIdentifierArgs{
    		Offer:     pulumi.String("string"),
    		Publisher: pulumi.String("string"),
    		Sku:       pulumi.String("string"),
    	},
    	EndOfLifeDate:                    pulumi.String("string"),
    	MinRecommendedMemoryInGb:         pulumi.Int(0),
    	AcceleratedNetworkSupportEnabled: pulumi.Bool(false),
    	Eula:                             pulumi.String("string"),
    	Description:                      pulumi.String("string"),
    	HibernationEnabled:               pulumi.Bool(false),
    	HyperVGeneration:                 pulumi.String("string"),
    	ConfidentialVmSupported:          pulumi.Bool(false),
    	Location:                         pulumi.String("string"),
    	MaxRecommendedMemoryInGb:         pulumi.Int(0),
    	MaxRecommendedVcpuCount:          pulumi.Int(0),
    	DiskTypesNotAlloweds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	MinRecommendedVcpuCount: pulumi.Int(0),
    	Name:                    pulumi.String("string"),
    	ConfidentialVmEnabled:   pulumi.Bool(false),
    	PrivacyStatementUri:     pulumi.String("string"),
    	PurchasePlan: &compute.SharedImagePurchasePlanArgs{
    		Name:      pulumi.String("string"),
    		Product:   pulumi.String("string"),
    		Publisher: pulumi.String("string"),
    	},
    	ReleaseNoteUri: pulumi.String("string"),
    	Architecture:   pulumi.String("string"),
    	Specialized:    pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TrustedLaunchEnabled:   pulumi.Bool(false),
    	TrustedLaunchSupported: pulumi.Bool(false),
    })
    
    var sharedImageResource = new SharedImage("sharedImageResource", SharedImageArgs.builder()
        .galleryName("string")
        .resourceGroupName("string")
        .osType("string")
        .identifier(SharedImageIdentifierArgs.builder()
            .offer("string")
            .publisher("string")
            .sku("string")
            .build())
        .endOfLifeDate("string")
        .minRecommendedMemoryInGb(0)
        .acceleratedNetworkSupportEnabled(false)
        .eula("string")
        .description("string")
        .hibernationEnabled(false)
        .hyperVGeneration("string")
        .confidentialVmSupported(false)
        .location("string")
        .maxRecommendedMemoryInGb(0)
        .maxRecommendedVcpuCount(0)
        .diskTypesNotAlloweds("string")
        .minRecommendedVcpuCount(0)
        .name("string")
        .confidentialVmEnabled(false)
        .privacyStatementUri("string")
        .purchasePlan(SharedImagePurchasePlanArgs.builder()
            .name("string")
            .product("string")
            .publisher("string")
            .build())
        .releaseNoteUri("string")
        .architecture("string")
        .specialized(false)
        .tags(Map.of("string", "string"))
        .trustedLaunchEnabled(false)
        .trustedLaunchSupported(false)
        .build());
    
    shared_image_resource = azure.compute.SharedImage("sharedImageResource",
        gallery_name="string",
        resource_group_name="string",
        os_type="string",
        identifier={
            "offer": "string",
            "publisher": "string",
            "sku": "string",
        },
        end_of_life_date="string",
        min_recommended_memory_in_gb=0,
        accelerated_network_support_enabled=False,
        eula="string",
        description="string",
        hibernation_enabled=False,
        hyper_v_generation="string",
        confidential_vm_supported=False,
        location="string",
        max_recommended_memory_in_gb=0,
        max_recommended_vcpu_count=0,
        disk_types_not_alloweds=["string"],
        min_recommended_vcpu_count=0,
        name="string",
        confidential_vm_enabled=False,
        privacy_statement_uri="string",
        purchase_plan={
            "name": "string",
            "product": "string",
            "publisher": "string",
        },
        release_note_uri="string",
        architecture="string",
        specialized=False,
        tags={
            "string": "string",
        },
        trusted_launch_enabled=False,
        trusted_launch_supported=False)
    
    const sharedImageResource = new azure.compute.SharedImage("sharedImageResource", {
        galleryName: "string",
        resourceGroupName: "string",
        osType: "string",
        identifier: {
            offer: "string",
            publisher: "string",
            sku: "string",
        },
        endOfLifeDate: "string",
        minRecommendedMemoryInGb: 0,
        acceleratedNetworkSupportEnabled: false,
        eula: "string",
        description: "string",
        hibernationEnabled: false,
        hyperVGeneration: "string",
        confidentialVmSupported: false,
        location: "string",
        maxRecommendedMemoryInGb: 0,
        maxRecommendedVcpuCount: 0,
        diskTypesNotAlloweds: ["string"],
        minRecommendedVcpuCount: 0,
        name: "string",
        confidentialVmEnabled: false,
        privacyStatementUri: "string",
        purchasePlan: {
            name: "string",
            product: "string",
            publisher: "string",
        },
        releaseNoteUri: "string",
        architecture: "string",
        specialized: false,
        tags: {
            string: "string",
        },
        trustedLaunchEnabled: false,
        trustedLaunchSupported: false,
    });
    
    type: azure:compute:SharedImage
    properties:
        acceleratedNetworkSupportEnabled: false
        architecture: string
        confidentialVmEnabled: false
        confidentialVmSupported: false
        description: string
        diskTypesNotAlloweds:
            - string
        endOfLifeDate: string
        eula: string
        galleryName: string
        hibernationEnabled: false
        hyperVGeneration: string
        identifier:
            offer: string
            publisher: string
            sku: string
        location: string
        maxRecommendedMemoryInGb: 0
        maxRecommendedVcpuCount: 0
        minRecommendedMemoryInGb: 0
        minRecommendedVcpuCount: 0
        name: string
        osType: string
        privacyStatementUri: string
        purchasePlan:
            name: string
            product: string
            publisher: string
        releaseNoteUri: string
        resourceGroupName: string
        specialized: false
        tags:
            string: string
        trustedLaunchEnabled: false
        trustedLaunchSupported: false
    

    SharedImage Resource Properties

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

    Inputs

    The SharedImage resource accepts the following input properties:

    GalleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    Identifier SharedImageIdentifier
    An identifier block as defined below.
    OsType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    AcceleratedNetworkSupportEnabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    Architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    ConfidentialVmEnabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    ConfidentialVmSupported bool
    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. Changing this forces a new resource to be created.
    Description string
    A description of this Shared Image.
    DiskTypesNotAlloweds List<string>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    Eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    HibernationEnabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    MaxRecommendedMemoryInGb int
    Maximum memory in GB recommended for the Image.
    MaxRecommendedVcpuCount int
    Maximum count of vCPUs recommended for the Image.
    MinRecommendedMemoryInGb int
    Minimum memory in GB recommended for the Image.
    MinRecommendedVcpuCount int
    Minimum count of vCPUs recommended for the Image.
    Name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    PrivacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    PurchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    ReleaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    Specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the Shared Image.
    TrustedLaunchEnabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    TrustedLaunchSupported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    GalleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    Identifier SharedImageIdentifierArgs
    An identifier block as defined below.
    OsType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    AcceleratedNetworkSupportEnabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    Architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    ConfidentialVmEnabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    ConfidentialVmSupported bool
    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. Changing this forces a new resource to be created.
    Description string
    A description of this Shared Image.
    DiskTypesNotAlloweds []string
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    Eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    HibernationEnabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    MaxRecommendedMemoryInGb int
    Maximum memory in GB recommended for the Image.
    MaxRecommendedVcpuCount int
    Maximum count of vCPUs recommended for the Image.
    MinRecommendedMemoryInGb int
    Minimum memory in GB recommended for the Image.
    MinRecommendedVcpuCount int
    Minimum count of vCPUs recommended for the Image.
    Name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    PrivacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    PurchasePlan SharedImagePurchasePlanArgs
    A purchase_plan block as defined below.
    ReleaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    Specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    Tags map[string]string
    A mapping of tags to assign to the Shared Image.
    TrustedLaunchEnabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    TrustedLaunchSupported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    galleryName String
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    identifier SharedImageIdentifier
    An identifier block as defined below.
    osType String
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled Boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture String
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled Boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported Boolean
    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. Changing this forces a new resource to be created.
    description String
    A description of this Shared Image.
    diskTypesNotAlloweds List<String>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image.
    eula String
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    hibernationEnabled Boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb Integer
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount Integer
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb Integer
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount Integer
    Minimum count of vCPUs recommended for the Image.
    name String
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    privacyStatementUri String
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    releaseNoteUri String
    The URI containing the Release Notes associated with this Shared Image.
    specialized Boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Map<String,String>
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled Boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported Boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    galleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    identifier SharedImageIdentifier
    An identifier block as defined below.
    osType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported boolean
    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. Changing this forces a new resource to be created.
    description string
    A description of this Shared Image.
    diskTypesNotAlloweds string[]
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    hibernationEnabled boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb number
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount number
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb number
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount number
    Minimum count of vCPUs recommended for the Image.
    name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    privacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    releaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    specialized boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags {[key: string]: string}
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    gallery_name str
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    identifier SharedImageIdentifierArgs
    An identifier block as defined below.
    os_type str
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    accelerated_network_support_enabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture str
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidential_vm_enabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidential_vm_supported bool
    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. Changing this forces a new resource to be created.
    description str
    A description of this Shared Image.
    disk_types_not_alloweds Sequence[str]
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    end_of_life_date str
    The end of life date in RFC3339 format of the Image.
    eula str
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    hibernation_enabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyper_v_generation str
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    location str
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    max_recommended_memory_in_gb int
    Maximum memory in GB recommended for the Image.
    max_recommended_vcpu_count int
    Maximum count of vCPUs recommended for the Image.
    min_recommended_memory_in_gb int
    Minimum memory in GB recommended for the Image.
    min_recommended_vcpu_count int
    Minimum count of vCPUs recommended for the Image.
    name str
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    privacy_statement_uri str
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchase_plan SharedImagePurchasePlanArgs
    A purchase_plan block as defined below.
    release_note_uri str
    The URI containing the Release Notes associated with this Shared Image.
    specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Mapping[str, str]
    A mapping of tags to assign to the Shared Image.
    trusted_launch_enabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trusted_launch_supported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    galleryName String
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    identifier Property Map
    An identifier block as defined below.
    osType String
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled Boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture String
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled Boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported Boolean
    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. Changing this forces a new resource to be created.
    description String
    A description of this Shared Image.
    diskTypesNotAlloweds List<String>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image.
    eula String
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    hibernationEnabled Boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb Number
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount Number
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb Number
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount Number
    Minimum count of vCPUs recommended for the Image.
    name String
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    privacyStatementUri String
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan Property Map
    A purchase_plan block as defined below.
    releaseNoteUri String
    The URI containing the Release Notes associated with this Shared Image.
    specialized Boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Map<String>
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled Boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported Boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SharedImage Resource

    Get an existing SharedImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SharedImageState, opts?: CustomResourceOptions): SharedImage
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accelerated_network_support_enabled: Optional[bool] = None,
            architecture: Optional[str] = None,
            confidential_vm_enabled: Optional[bool] = None,
            confidential_vm_supported: Optional[bool] = None,
            description: Optional[str] = None,
            disk_types_not_alloweds: Optional[Sequence[str]] = None,
            end_of_life_date: Optional[str] = None,
            eula: Optional[str] = None,
            gallery_name: Optional[str] = None,
            hibernation_enabled: Optional[bool] = None,
            hyper_v_generation: Optional[str] = None,
            identifier: Optional[SharedImageIdentifierArgs] = None,
            location: Optional[str] = None,
            max_recommended_memory_in_gb: Optional[int] = None,
            max_recommended_vcpu_count: Optional[int] = None,
            min_recommended_memory_in_gb: Optional[int] = None,
            min_recommended_vcpu_count: Optional[int] = None,
            name: Optional[str] = None,
            os_type: Optional[str] = None,
            privacy_statement_uri: Optional[str] = None,
            purchase_plan: Optional[SharedImagePurchasePlanArgs] = None,
            release_note_uri: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            specialized: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            trusted_launch_enabled: Optional[bool] = None,
            trusted_launch_supported: Optional[bool] = None) -> SharedImage
    func GetSharedImage(ctx *Context, name string, id IDInput, state *SharedImageState, opts ...ResourceOption) (*SharedImage, error)
    public static SharedImage Get(string name, Input<string> id, SharedImageState? state, CustomResourceOptions? opts = null)
    public static SharedImage get(String name, Output<String> id, SharedImageState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AcceleratedNetworkSupportEnabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    Architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    ConfidentialVmEnabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    ConfidentialVmSupported bool
    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. Changing this forces a new resource to be created.
    Description string
    A description of this Shared Image.
    DiskTypesNotAlloweds List<string>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    Eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    GalleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    HibernationEnabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    Identifier SharedImageIdentifier
    An identifier block as defined below.
    Location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    MaxRecommendedMemoryInGb int
    Maximum memory in GB recommended for the Image.
    MaxRecommendedVcpuCount int
    Maximum count of vCPUs recommended for the Image.
    MinRecommendedMemoryInGb int
    Minimum memory in GB recommended for the Image.
    MinRecommendedVcpuCount int
    Minimum count of vCPUs recommended for the Image.
    Name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    OsType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    PrivacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    PurchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    ReleaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    ResourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    Specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the Shared Image.
    TrustedLaunchEnabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    TrustedLaunchSupported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    AcceleratedNetworkSupportEnabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    Architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    ConfidentialVmEnabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    ConfidentialVmSupported bool
    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. Changing this forces a new resource to be created.
    Description string
    A description of this Shared Image.
    DiskTypesNotAlloweds []string
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    Eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    GalleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    HibernationEnabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    HyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    Identifier SharedImageIdentifierArgs
    An identifier block as defined below.
    Location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    MaxRecommendedMemoryInGb int
    Maximum memory in GB recommended for the Image.
    MaxRecommendedVcpuCount int
    Maximum count of vCPUs recommended for the Image.
    MinRecommendedMemoryInGb int
    Minimum memory in GB recommended for the Image.
    MinRecommendedVcpuCount int
    Minimum count of vCPUs recommended for the Image.
    Name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    OsType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    PrivacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    PurchasePlan SharedImagePurchasePlanArgs
    A purchase_plan block as defined below.
    ReleaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    ResourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    Specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    Tags map[string]string
    A mapping of tags to assign to the Shared Image.
    TrustedLaunchEnabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    TrustedLaunchSupported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled Boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture String
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled Boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported Boolean
    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. Changing this forces a new resource to be created.
    description String
    A description of this Shared Image.
    diskTypesNotAlloweds List<String>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image.
    eula String
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    galleryName String
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    hibernationEnabled Boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    identifier SharedImageIdentifier
    An identifier block as defined below.
    location String
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb Integer
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount Integer
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb Integer
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount Integer
    Minimum count of vCPUs recommended for the Image.
    name String
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    osType String
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    privacyStatementUri String
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    releaseNoteUri String
    The URI containing the Release Notes associated with this Shared Image.
    resourceGroupName String
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    specialized Boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Map<String,String>
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled Boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported Boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture string
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported boolean
    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. Changing this forces a new resource to be created.
    description string
    A description of this Shared Image.
    diskTypesNotAlloweds string[]
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate string
    The end of life date in RFC3339 format of the Image.
    eula string
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    galleryName string
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    hibernationEnabled boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration string
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    identifier SharedImageIdentifier
    An identifier block as defined below.
    location string
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb number
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount number
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb number
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount number
    Minimum count of vCPUs recommended for the Image.
    name string
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    osType string
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    privacyStatementUri string
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan SharedImagePurchasePlan
    A purchase_plan block as defined below.
    releaseNoteUri string
    The URI containing the Release Notes associated with this Shared Image.
    resourceGroupName string
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    specialized boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags {[key: string]: string}
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    accelerated_network_support_enabled bool
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture str
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidential_vm_enabled bool

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidential_vm_supported bool
    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. Changing this forces a new resource to be created.
    description str
    A description of this Shared Image.
    disk_types_not_alloweds Sequence[str]
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    end_of_life_date str
    The end of life date in RFC3339 format of the Image.
    eula str
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    gallery_name str
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    hibernation_enabled bool
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyper_v_generation str
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    identifier SharedImageIdentifierArgs
    An identifier block as defined below.
    location str
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    max_recommended_memory_in_gb int
    Maximum memory in GB recommended for the Image.
    max_recommended_vcpu_count int
    Maximum count of vCPUs recommended for the Image.
    min_recommended_memory_in_gb int
    Minimum memory in GB recommended for the Image.
    min_recommended_vcpu_count int
    Minimum count of vCPUs recommended for the Image.
    name str
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    os_type str
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    privacy_statement_uri str
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchase_plan SharedImagePurchasePlanArgs
    A purchase_plan block as defined below.
    release_note_uri str
    The URI containing the Release Notes associated with this Shared Image.
    resource_group_name str
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    specialized bool

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Mapping[str, str]
    A mapping of tags to assign to the Shared Image.
    trusted_launch_enabled bool
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trusted_launch_supported bool
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.
    acceleratedNetworkSupportEnabled Boolean
    Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created.
    architecture String
    CPU architecture supported by an OS. Possible values are x64 and Arm64. Defaults to x64. Changing this forces a new resource to be created.
    confidentialVmEnabled Boolean

    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. Changing this forces a new resource to be created.

    Note:: Only one of trusted_launch_supported, trusted_launch_enabled, confidential_vm_supported and confidential_vm_enabled can be specified.

    confidentialVmSupported Boolean
    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. Changing this forces a new resource to be created.
    description String
    A description of this Shared Image.
    diskTypesNotAlloweds List<String>
    One or more Disk Types not allowed for the Image. Possible values include Standard_LRS and Premium_LRS.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image.
    eula String
    The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created.
    galleryName String
    Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
    hibernationEnabled Boolean
    Specifies if the Shared Image supports hibernation. Changing this forces a new resource to be created.
    hyperVGeneration String
    The generation of HyperV that the Virtual Machine used to create the Shared Image is based on. Possible values are V1 and V2. Defaults to V1. Changing this forces a new resource to be created.
    identifier Property Map
    An identifier block as defined below.
    location String
    Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
    maxRecommendedMemoryInGb Number
    Maximum memory in GB recommended for the Image.
    maxRecommendedVcpuCount Number
    Maximum count of vCPUs recommended for the Image.
    minRecommendedMemoryInGb Number
    Minimum memory in GB recommended for the Image.
    minRecommendedVcpuCount Number
    Minimum count of vCPUs recommended for the Image.
    name String
    Specifies the name of the Shared Image. Changing this forces a new resource to be created.
    osType String
    The type of Operating System present in this Shared Image. Possible values are Linux and Windows. Changing this forces a new resource to be created.
    privacyStatementUri String
    The URI containing the Privacy Statement associated with this Shared Image. Changing this forces a new resource to be created.
    purchasePlan Property Map
    A purchase_plan block as defined below.
    releaseNoteUri String
    The URI containing the Release Notes associated with this Shared Image.
    resourceGroupName String
    The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    specialized Boolean

    Specifies that the Operating System used inside this Image has not been Generalized (for example, sysprep on Windows has not been run). Changing this forces a new resource to be created.

    !> Note: It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects.

    tags Map<String>
    A mapping of tags to assign to the Shared Image.
    trustedLaunchEnabled Boolean
    Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created.
    trustedLaunchSupported Boolean
    Specifies if supports creation of both Trusted Launch virtual machines and Gen2 virtual machines with standard security created from the Shared Image. Changing this forces a new resource to be created.

    Supporting Types

    SharedImageIdentifier, SharedImageIdentifierArgs

    Offer string
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    Publisher string
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    Sku string
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.
    Offer string
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    Publisher string
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    Sku string
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.
    offer String
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    publisher String
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    sku String
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.
    offer string
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    publisher string
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    sku string
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.
    offer str
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    publisher str
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    sku str
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.
    offer String
    The Offer Name for this Shared Image. Changing this forces a new resource to be created.
    publisher String
    The Publisher Name for this Gallery Image. Changing this forces a new resource to be created.
    sku String
    The Name of the SKU for this Gallery Image. Changing this forces a new resource to be created.

    SharedImagePurchasePlan, SharedImagePurchasePlanArgs

    Name string
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    Product string
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    Publisher string
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.
    Name string
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    Product string
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    Publisher string
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.
    name String
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    product String
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    publisher String
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.
    name string
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    product string
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    publisher string
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.
    name str
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    product str
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    publisher str
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.
    name String
    The Purchase Plan Name for this Shared Image. Changing this forces a new resource to be created.
    product String
    The Purchase Plan Product for this Gallery Image. Changing this forces a new resource to be created.
    publisher String
    The Purchase Plan Publisher for this Gallery Image. Changing this forces a new resource to be created.

    Import

    Shared Images can be imported using the resource id, e.g.

    $ pulumi import azure:compute/sharedImage:SharedImage image1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/galleries/gallery1/images/image1
    

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

    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 v6.2.0 published on Friday, Sep 27, 2024 by Pulumi