Update-AzureRmGalleryImageVersion

Update a gallery image version.

Syntax

Update-AzureRmGalleryImageVersion
      [-ResourceGroupName] <String>
      [-GalleryName] <String>
      [-GalleryImageDefinitionName] <String>
      [-Name] <String>
      [-AsJob]
      [-Tag <Hashtable>]
      [-ReplicaCount <Int32>]
      [-PublishingProfileExcludeFromLatest]
      [-PublishingProfileEndOfLifeDate <DateTime>]
      [-TargetRegion <Hashtable[]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmGalleryImageVersion
      [-ResourceId] <String>
      [-AsJob]
      [-Tag <Hashtable>]
      [-ReplicaCount <Int32>]
      [-PublishingProfileExcludeFromLatest]
      [-PublishingProfileEndOfLifeDate <DateTime>]
      [-TargetRegion <Hashtable[]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmGalleryImageVersion
      [-InputObject] <PSGalleryImageVersion>
      [-AsJob]
      [-Tag <Hashtable>]
      [-ReplicaCount <Int32>]
      [-PublishingProfileExcludeFromLatest]
      [-PublishingProfileEndOfLifeDate <DateTime>]
      [-TargetRegion <Hashtable[]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a gallery image version.

Examples

Example 1

PS C:\> $region1 = @{Name='West US';ReplicaCount=1}
PS C:\> $region2 = @{Name='East US';ReplicaCount=2}
PS C:\> $region3 = @{Name='Central US'}
PS C:\> $targetRegions = @($region1,$region2,$region3)
PS C:\> Update-AzureRmGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageName $imageName -Name $versionName -ReplicaCount 2 -PublishingProfileEndOfLifeDate $endOfLifeDate -TargetRegion $targetRegions

Update a gallery image version.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GalleryImageDefinitionName

The name of the gallery image definition.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-GalleryName

The name of the gallery.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

The PS Gallery Image Version Object.

Type:Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion
Aliases:GalleryImageVersion
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

The name of the gallery image version.

Type:String
Aliases:GalleryImageVersionName
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PublishingProfileEndOfLifeDate

The end of life date of the gallery Image Version.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PublishingProfileExcludeFromLatest

If it is set, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ReplicaCount

The number of replicas of the Image Version to be created per region.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceId

The resource ID for the gallery image version.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tag

Resource tags

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TargetRegion

The target regions where the Image Version is going to be replicated to.

Type:System.Collections.Hashtable[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion

Hashtable

Int32

SwitchParameter

DateTime

System.Collections.Hashtable[]

Outputs

Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion