SharedImageVersion

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

Create a SharedImageVersion Resource

new SharedImageVersion(name: string, args: SharedImageVersionArgs, opts?: CustomResourceOptions);

def SharedImageVersion(resource_name, opts=None, exclude_from_latest=None, gallery_name=None, image_name=None, location=None, managed_image_id=None, name=None, resource_group_name=None, tags=None, target_regions=None, __props__=None);

func NewSharedImageVersion(ctx *Context, name string, args SharedImageVersionArgs, opts ...ResourceOption) (*SharedImageVersion, error)

public SharedImageVersion(string name, SharedImageVersionArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

SharedImageVersion Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
ManagedImageId string: The ID of the Managed Image which should be used for this Shared Image Version. 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<SharedImageVersionTargetRegionArgs>: One or more target_region blocks as documented below.
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.
Name string: The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
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.
ManagedImageId string: The ID of the Managed Image which should be used for this Shared Image Version. 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.
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.
Name string: The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
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.
managedImageId string: The ID of the Managed Image which should be used for this Shared Image Version. 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.
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.
name string: The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
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.
managed_image_id str: The ID of the Managed Image which should be used for this Shared Image Version. 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 List[SharedImageVersionTargetRegion]: One or more target_region blocks as documented below.
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.
name str: The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
tags Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, exclude_from_latest=None, gallery_name=None, image_name=None, location=None, managed_image_id=None, name=None, resource_group_name=None, tags=None, target_regions=None, __props__=None);

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)

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.

The following state arguments are supported:

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 which should be used for this Shared Image Version. Changing this forces a new resource to be created.
Name string: The version number for this Image Version, such as 1.0.0. 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.
Tags Dictionary<string, string>: A collection of tags which should be applied to this resource.
TargetRegions List<SharedImageVersionTargetRegionArgs>: One or more target_region blocks as documented below.

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 which should be used for this Shared Image Version. Changing this forces a new resource to be created.
Name string: The version number for this Image Version, such as 1.0.0. 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.
Tags map[string]string: A collection of tags which should be applied to this resource.
TargetRegions []SharedImageVersionTargetRegion: One or more target_region blocks as documented below.

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 which should be used for this Shared Image Version. Changing this forces a new resource to be created.
name string: The version number for this Image Version, such as 1.0.0. 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.
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.

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 which should be used for this Shared Image Version. Changing this forces a new resource to be created.
name str: The version number for this Image Version, such as 1.0.0. 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.
tags Dict[str, str]: A collection of tags which should be applied to this resource.
target_regions List[SharedImageVersionTargetRegion]: One or more target_region blocks as documented below.

Supporting Types

SharedImageVersionTargetRegion

See the input and output API doc for this type.

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.
StorageAccountType string: The storage account type for the image version. Possible values are Standard_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.
StorageAccountType string: The storage account type for the image version. Possible values are Standard_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.
storageAccountType string: The storage account type for the image version. Possible values are Standard_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.
regionalReplicaCount float: The number of replicas of the Image Version to be created per region.
storage_account_type str: The storage account type for the image version. Possible values are Standard_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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud