Update-AzureRmGalleryImageDefinition

Module:

AzureRM.Compute

Update a gallery image definition.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Update-AzureRmGalleryImageDefinition
      [-ResourceGroupName] <String>
      [-GalleryName] <String>
      [-Name] <String>
      [-AsJob]
      [-Description <String>]
      [-Eula <String>]
      [-PrivacyStatementUri <String>]
      [-ReleaseNoteUri <String>]
      [-EndOfLifeDate <DateTime>]
      [-Tag <Hashtable>]
      [-MinimumVCPU <Int32>]
      [-MaximumVCPU <Int32>]
      [-MinimumMemory <Int32>]
      [-MaximumMemory <Int32>]
      [-DisallowedDiskType <String[]>]
      [-PurchasePlanName <String>]
      [-PurchasePlanPublisher <String>]
      [-PurchasePlanProduct <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureRmGalleryImageDefinition
      [-ResourceId] <String>
      [-AsJob]
      [-Description <String>]
      [-Eula <String>]
      [-PrivacyStatementUri <String>]
      [-ReleaseNoteUri <String>]
      [-EndOfLifeDate <DateTime>]
      [-Tag <Hashtable>]
      [-MinimumVCPU <Int32>]
      [-MaximumVCPU <Int32>]
      [-MinimumMemory <Int32>]
      [-MaximumMemory <Int32>]
      [-DisallowedDiskType <String[]>]
      [-PurchasePlanName <String>]
      [-PurchasePlanPublisher <String>]
      [-PurchasePlanProduct <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureRmGalleryImageDefinition
      [-InputObject] <PSGalleryImage>
      [-AsJob]
      [-Description <String>]
      [-Eula <String>]
      [-PrivacyStatementUri <String>]
      [-ReleaseNoteUri <String>]
      [-EndOfLifeDate <DateTime>]
      [-Tag <Hashtable>]
      [-MinimumVCPU <Int32>]
      [-MaximumVCPU <Int32>]
      [-MinimumMemory <Int32>]
      [-MaximumMemory <Int32>]
      [-DisallowedDiskType <String[]>]
      [-PurchasePlanName <String>]
      [-PurchasePlanPublisher <String>]
      [-PurchasePlanProduct <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a gallery image definition.

Examples

Example 1

PS C:\> Update-AzureRmGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Description $description -Eula $eula -PrivacyStatementUri $privacyStatementUri -ReleaseNoteUri $releaseNoteUri -DisallowedDiskType $disallowedDiskTypes -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU -PurchasePlanName $purchasePlanName -PurchasePlanProduct $purchasePlanProduct -PurchasePlanPublisher $purchasePlanPublisher

Update a gallery image definition.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

The description of the gallery image Definition resource.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DisallowedDiskType

The disallowed disk types.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-EndOfLifeDate

The end of life date of the gallery Image Definition

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Eula

The Eula agreement for the gallery Image Definition.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GalleryName

The name of the gallery.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

The PS Gallery Image Definition Object.

Type:	PSGalleryImage
Aliases:	GalleryImageDefinition
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MaximumMemory

The maximum of the recommended memory

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MaximumVCPU

The maximum of the recommended CPU core

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MinimumMemory

The minimum of the recommended memory

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MinimumVCPU

The minimum of the recommended CPU core

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the gallery image definition.

Type:	String
Aliases:	GalleryImageDefinitionName
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PrivacyStatementUri

The privacy statement uri.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PurchasePlanName

The ID for the purchase plan.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PurchasePlanProduct

The product ID for the purchase plan.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PurchasePlanPublisher

The publisher ID for the purchase plan.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ReleaseNoteUri

The release note uri.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

The resource ID for the image definition

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Resource tags

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSGalleryImage

DateTime

Hashtable

Int32

String[]

Outputs

PSGalleryImage