Update-AzGalleryImageDefinition

Reference

Module:: Az.Compute

Update a gallery image definition.

Syntax

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

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

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

Description

Update a gallery image definition.

Examples

Example 1: Change the recommended configurations for an image definition

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$imageName = "myImage"
$versionName = "1.0.0"
$minVCPU = 1
$maxVCPU = 4
$minMemory = 1
$maxMemory = 8
$description = "My image definition"
$endOfLifeDate = "2024-08-02T00:00:00+00:00"
Update-AzGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Description $description -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU

Update a gallery image definition's recommended configuration settings

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:	AzContext, 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