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

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.compute.SharedImageVersion

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Version of a Shared Image within a Shared Image Gallery.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const existing = azure.compute.getImage({
        name: "search-api",
        resourceGroupName: "packerimages",
    });
    const existingGetSharedImage = azure.compute.getSharedImage({
        name: "existing-image",
        galleryName: "existing_gallery",
        resourceGroupName: "existing-resources",
    });
    const example = new azure.compute.SharedImageVersion("example", {
        name: "0.0.1",
        galleryName: existingGetSharedImage.then(existingGetSharedImage => existingGetSharedImage.galleryName),
        imageName: existingGetSharedImage.then(existingGetSharedImage => existingGetSharedImage.name),
        resourceGroupName: existingGetSharedImage.then(existingGetSharedImage => existingGetSharedImage.resourceGroupName),
        location: existingGetSharedImage.then(existingGetSharedImage => existingGetSharedImage.location),
        managedImageId: existing.then(existing => existing.id),
        targetRegions: [{
            name: existingGetSharedImage.then(existingGetSharedImage => existingGetSharedImage.location),
            regionalReplicaCount: 5,
            storageAccountType: "Standard_LRS",
        }],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    existing = azure.compute.get_image(name="search-api",
        resource_group_name="packerimages")
    existing_get_shared_image = azure.compute.get_shared_image(name="existing-image",
        gallery_name="existing_gallery",
        resource_group_name="existing-resources")
    example = azure.compute.SharedImageVersion("example",
        name="0.0.1",
        gallery_name=existing_get_shared_image.gallery_name,
        image_name=existing_get_shared_image.name,
        resource_group_name=existing_get_shared_image.resource_group_name,
        location=existing_get_shared_image.location,
        managed_image_id=existing.id,
        target_regions=[azure.compute.SharedImageVersionTargetRegionArgs(
            name=existing_get_shared_image.location,
            regional_replica_count=5,
            storage_account_type="Standard_LRS",
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		existing, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
    			Name:              pulumi.StringRef("search-api"),
    			ResourceGroupName: "packerimages",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		existingGetSharedImage, err := compute.LookupSharedImage(ctx, &compute.LookupSharedImageArgs{
    			Name:              "existing-image",
    			GalleryName:       "existing_gallery",
    			ResourceGroupName: "existing-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewSharedImageVersion(ctx, "example", &compute.SharedImageVersionArgs{
    			Name:              pulumi.String("0.0.1"),
    			GalleryName:       pulumi.String(existingGetSharedImage.GalleryName),
    			ImageName:         pulumi.String(existingGetSharedImage.Name),
    			ResourceGroupName: pulumi.String(existingGetSharedImage.ResourceGroupName),
    			Location:          pulumi.String(existingGetSharedImage.Location),
    			ManagedImageId:    pulumi.String(existing.Id),
    			TargetRegions: compute.SharedImageVersionTargetRegionArray{
    				&compute.SharedImageVersionTargetRegionArgs{
    					Name:                 pulumi.String(existingGetSharedImage.Location),
    					RegionalReplicaCount: pulumi.Int(5),
    					StorageAccountType:   pulumi.String("Standard_LRS"),
    				},
    			},
    		})
    		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 existing = Azure.Compute.GetImage.Invoke(new()
        {
            Name = "search-api",
            ResourceGroupName = "packerimages",
        });
    
        var existingGetSharedImage = Azure.Compute.GetSharedImage.Invoke(new()
        {
            Name = "existing-image",
            GalleryName = "existing_gallery",
            ResourceGroupName = "existing-resources",
        });
    
        var example = new Azure.Compute.SharedImageVersion("example", new()
        {
            Name = "0.0.1",
            GalleryName = existingGetSharedImage.Apply(getSharedImageResult => getSharedImageResult.GalleryName),
            ImageName = existingGetSharedImage.Apply(getSharedImageResult => getSharedImageResult.Name),
            ResourceGroupName = existingGetSharedImage.Apply(getSharedImageResult => getSharedImageResult.ResourceGroupName),
            Location = existingGetSharedImage.Apply(getSharedImageResult => getSharedImageResult.Location),
            ManagedImageId = existing.Apply(getImageResult => getImageResult.Id),
            TargetRegions = new[]
            {
                new Azure.Compute.Inputs.SharedImageVersionTargetRegionArgs
                {
                    Name = existingGetSharedImage.Apply(getSharedImageResult => getSharedImageResult.Location),
                    RegionalReplicaCount = 5,
                    StorageAccountType = "Standard_LRS",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.compute.ComputeFunctions;
    import com.pulumi.azure.compute.inputs.GetImageArgs;
    import com.pulumi.azure.compute.inputs.GetSharedImageArgs;
    import com.pulumi.azure.compute.SharedImageVersion;
    import com.pulumi.azure.compute.SharedImageVersionArgs;
    import com.pulumi.azure.compute.inputs.SharedImageVersionTargetRegionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var existing = ComputeFunctions.getImage(GetImageArgs.builder()
                .name("search-api")
                .resourceGroupName("packerimages")
                .build());
    
            final var existingGetSharedImage = ComputeFunctions.getSharedImage(GetSharedImageArgs.builder()
                .name("existing-image")
                .galleryName("existing_gallery")
                .resourceGroupName("existing-resources")
                .build());
    
            var example = new SharedImageVersion("example", SharedImageVersionArgs.builder()        
                .name("0.0.1")
                .galleryName(existingGetSharedImage.applyValue(getSharedImageResult -> getSharedImageResult.galleryName()))
                .imageName(existingGetSharedImage.applyValue(getSharedImageResult -> getSharedImageResult.name()))
                .resourceGroupName(existingGetSharedImage.applyValue(getSharedImageResult -> getSharedImageResult.resourceGroupName()))
                .location(existingGetSharedImage.applyValue(getSharedImageResult -> getSharedImageResult.location()))
                .managedImageId(existing.applyValue(getImageResult -> getImageResult.id()))
                .targetRegions(SharedImageVersionTargetRegionArgs.builder()
                    .name(existingGetSharedImage.applyValue(getSharedImageResult -> getSharedImageResult.location()))
                    .regionalReplicaCount(5)
                    .storageAccountType("Standard_LRS")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:compute:SharedImageVersion
        properties:
          name: 0.0.1
          galleryName: ${existingGetSharedImage.galleryName}
          imageName: ${existingGetSharedImage.name}
          resourceGroupName: ${existingGetSharedImage.resourceGroupName}
          location: ${existingGetSharedImage.location}
          managedImageId: ${existing.id}
          targetRegions:
            - name: ${existingGetSharedImage.location}
              regionalReplicaCount: 5
              storageAccountType: Standard_LRS
    variables:
      existing:
        fn::invoke:
          Function: azure:compute:getImage
          Arguments:
            name: search-api
            resourceGroupName: packerimages
      existingGetSharedImage:
        fn::invoke:
          Function: azure:compute:getSharedImage
          Arguments:
            name: existing-image
            galleryName: existing_gallery
            resourceGroupName: existing-resources
    

    Create SharedImageVersion Resource

    new SharedImageVersion(name: string, args: SharedImageVersionArgs, opts?: CustomResourceOptions);
    @overload
    def SharedImageVersion(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           blob_uri: Optional[str] = None,
                           deletion_of_replicated_locations_enabled: Optional[bool] = None,
                           end_of_life_date: Optional[str] = None,
                           exclude_from_latest: Optional[bool] = None,
                           gallery_name: Optional[str] = None,
                           image_name: Optional[str] = None,
                           location: Optional[str] = None,
                           managed_image_id: Optional[str] = None,
                           name: Optional[str] = None,
                           os_disk_snapshot_id: Optional[str] = None,
                           replication_mode: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           storage_account_id: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           target_regions: Optional[Sequence[SharedImageVersionTargetRegionArgs]] = None)
    @overload
    def SharedImageVersion(resource_name: str,
                           args: SharedImageVersionArgs,
                           opts: Optional[ResourceOptions] = None)
    func NewSharedImageVersion(ctx *Context, name string, args SharedImageVersionArgs, opts ...ResourceOption) (*SharedImageVersion, error)
    public SharedImageVersion(string name, SharedImageVersionArgs args, CustomResourceOptions? opts = null)
    public SharedImageVersion(String name, SharedImageVersionArgs args)
    public SharedImageVersion(String name, SharedImageVersionArgs args, CustomResourceOptions options)
    
    type: azure:compute:SharedImageVersion
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SharedImageVersionArgs
    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 SharedImageVersionArgs
    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 SharedImageVersionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedImageVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedImageVersionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SharedImageVersion 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 SharedImageVersion resource accepts the following input properties:

    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    ImageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    TargetRegions List<SharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    BlobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    DeletionOfReplicatedLocationsEnabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    ExcludeFromLatest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    Location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    ManagedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    Name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    OsDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    ReplicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    StorageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    Tags Dictionary<string, string>
    A collection of tags which should be applied to this resource.
    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    ImageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    TargetRegions []SharedImageVersionTargetRegionArgs
    One or more target_region blocks as documented below.
    BlobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    DeletionOfReplicatedLocationsEnabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    ExcludeFromLatest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    Location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    ManagedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    Name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    OsDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    ReplicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    StorageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    Tags map[string]string
    A collection of tags which should be applied to this resource.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName String
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    targetRegions List<SharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    blobUri String

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled Boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest Boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    location String
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId String

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name String
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId String

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode String
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    storageAccountId String

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Map<String,String>
    A collection of tags which should be applied to this resource.
    galleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    targetRegions SharedImageVersionTargetRegion[]
    One or more target_region blocks as documented below.
    blobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    storageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags {[key: string]: string}
    A collection of tags which should be applied to this resource.
    gallery_name str
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    image_name str
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    target_regions Sequence[SharedImageVersionTargetRegionArgs]
    One or more target_region blocks as documented below.
    blob_uri str

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletion_of_replicated_locations_enabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    end_of_life_date str
    The end of life date in RFC3339 format of the Image Version.
    exclude_from_latest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    location str
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managed_image_id str

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name str
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    os_disk_snapshot_id str

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replication_mode str
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    storage_account_id str

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Mapping[str, str]
    A collection of tags which should be applied to this resource.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName String
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. 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.
    targetRegions List<Property Map>
    One or more target_region blocks as documented below.
    blobUri String

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled Boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest Boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    location String
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId String

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name String
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId String

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode String
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. Changing this forces a new resource to be created.
    storageAccountId String

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Map<String>
    A collection of tags which should be applied to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SharedImageVersion 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 SharedImageVersion Resource

    Get an existing SharedImageVersion 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?: SharedImageVersionState, opts?: CustomResourceOptions): SharedImageVersion
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            blob_uri: Optional[str] = None,
            deletion_of_replicated_locations_enabled: Optional[bool] = None,
            end_of_life_date: Optional[str] = None,
            exclude_from_latest: Optional[bool] = None,
            gallery_name: Optional[str] = None,
            image_name: Optional[str] = None,
            location: Optional[str] = None,
            managed_image_id: Optional[str] = None,
            name: Optional[str] = None,
            os_disk_snapshot_id: Optional[str] = None,
            replication_mode: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            storage_account_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            target_regions: Optional[Sequence[SharedImageVersionTargetRegionArgs]] = None) -> SharedImageVersion
    func GetSharedImageVersion(ctx *Context, name string, id IDInput, state *SharedImageVersionState, opts ...ResourceOption) (*SharedImageVersion, error)
    public static SharedImageVersion Get(string name, Input<string> id, SharedImageVersionState? state, CustomResourceOptions? opts = null)
    public static SharedImageVersion get(String name, Output<String> id, SharedImageVersionState 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:
    BlobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    DeletionOfReplicatedLocationsEnabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    ExcludeFromLatest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    ImageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    Location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    ManagedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    Name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    OsDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    ReplicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    StorageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    Tags Dictionary<string, string>
    A collection of tags which should be applied to this resource.
    TargetRegions List<SharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    BlobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    DeletionOfReplicatedLocationsEnabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    EndOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    ExcludeFromLatest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    GalleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    ImageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    Location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    ManagedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    Name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    OsDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    ReplicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    StorageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    Tags map[string]string
    A collection of tags which should be applied to this resource.
    TargetRegions []SharedImageVersionTargetRegionArgs
    One or more target_region blocks as documented below.
    blobUri String

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled Boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest Boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName String
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    location String
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId String

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name String
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId String

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode String
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    storageAccountId String

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Map<String,String>
    A collection of tags which should be applied to this resource.
    targetRegions List<SharedImageVersionTargetRegion>
    One or more target_region blocks as documented below.
    blobUri string

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate string
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    galleryName string
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName string
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    location string
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId string

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name string
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId string

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode string
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    storageAccountId string

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags {[key: string]: string}
    A collection of tags which should be applied to this resource.
    targetRegions SharedImageVersionTargetRegion[]
    One or more target_region blocks as documented below.
    blob_uri str

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletion_of_replicated_locations_enabled bool
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    end_of_life_date str
    The end of life date in RFC3339 format of the Image Version.
    exclude_from_latest bool
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    gallery_name str
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    image_name str
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    location str
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managed_image_id str

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name str
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    os_disk_snapshot_id str

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replication_mode str
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    storage_account_id str

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Mapping[str, str]
    A collection of tags which should be applied to this resource.
    target_regions Sequence[SharedImageVersionTargetRegionArgs]
    One or more target_region blocks as documented below.
    blobUri String

    URI of the Azure Storage Blob used to create the Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    NOTE: blob_uri and storage_account_id must be specified together

    deletionOfReplicatedLocationsEnabled Boolean
    Specifies whether this Shared Image Version can be deleted from the Azure Regions this is replicated to. Defaults to false. Changing this forces a new resource to be created.
    endOfLifeDate String
    The end of life date in RFC3339 format of the Image Version.
    excludeFromLatest Boolean
    Should this Image Version be excluded from the latest filter? If set to true this Image Version won't be returned for the latest version. Defaults to false.
    galleryName String
    The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
    imageName String
    The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
    location String
    The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
    managedImageId String

    The ID of the Managed Image or Virtual Machine ID which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: The ID can be sourced from the azure.compute.Image data source or resource

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    name String
    The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
    osDiskSnapshotId String

    The ID of the OS disk snapshot which should be used for this Shared Image Version. Changing this forces a new resource to be created.

    NOTE: You must specify exact one of blob_uri, managed_image_id and os_disk_snapshot_id.

    replicationMode String
    Mode to be used for replication. Possible values are Full and Shallow. Defaults to Full. 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.
    storageAccountId String

    The ID of the Storage Account where the Blob exists. Changing this forces a new resource to be created.

    NOTE: blob_uri and storage_account_id must be specified together

    tags Map<String>
    A collection of tags which should be applied to this resource.
    targetRegions List<Property Map>
    One or more target_region blocks as documented below.

    Supporting Types

    SharedImageVersionTargetRegion, SharedImageVersionTargetRegionArgs

    Name string
    The Azure Region in which this Image Version should exist.
    RegionalReplicaCount int
    The number of replicas of the Image Version to be created per region.
    DiskEncryptionSetId string
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    ExcludeFromLatestEnabled bool
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    StorageAccountType string
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.
    Name string
    The Azure Region in which this Image Version should exist.
    RegionalReplicaCount int
    The number of replicas of the Image Version to be created per region.
    DiskEncryptionSetId string
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    ExcludeFromLatestEnabled bool
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    StorageAccountType string
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.
    name String
    The Azure Region in which this Image Version should exist.
    regionalReplicaCount Integer
    The number of replicas of the Image Version to be created per region.
    diskEncryptionSetId String
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    excludeFromLatestEnabled Boolean
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    storageAccountType String
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.
    name string
    The Azure Region in which this Image Version should exist.
    regionalReplicaCount number
    The number of replicas of the Image Version to be created per region.
    diskEncryptionSetId string
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    excludeFromLatestEnabled boolean
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    storageAccountType string
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.
    name str
    The Azure Region in which this Image Version should exist.
    regional_replica_count int
    The number of replicas of the Image Version to be created per region.
    disk_encryption_set_id str
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    exclude_from_latest_enabled bool
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    storage_account_type str
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.
    name String
    The Azure Region in which this Image Version should exist.
    regionalReplicaCount Number
    The number of replicas of the Image Version to be created per region.
    diskEncryptionSetId String
    The ID of the Disk Encryption Set to encrypt the Image Version in the target region. Changing this forces a new resource to be created.
    excludeFromLatestEnabled Boolean
    Specifies whether this Shared Image Version should be excluded when querying for the latest version. Defaults to false.
    storageAccountType String
    The storage account type for the image version. Possible values are Standard_LRS, Premium_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.

    Import

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

    $ pulumi import azure:compute/sharedImageVersion:SharedImageVersion version /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.2.3
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi