Update-AzureVMImage

NAME Update-AzureVMImage



SYNOPSIS

Updates the label of an operating system image in the image repository.





SYNTAX

Update-AzureVMImage [-ImageName] <String> [-Label] <String> [[-IconName] <String>] [[-SmallIconName] <String>] [[-DontShowInGui]] [[-Eula] <String>]

[[-Description] <String>] [[-ImageFamily] <String>] [[-PublishedDate] <Nullable`1[DateTime]>] [[-PrivacyUri] <Uri>] [[-RecommendedVMSize] <String>]

[[-DiskConfig] <VirtualMachineImageDiskConfigSet>] [[-Language] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]

[-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Update-AzureVMImage cmdlet updates the label on an operating system image in the image repository. It returns an image object with information about

the updated image.





PARAMETERS

-ImageName <String>

Specifies the name of the image to update in the image repository.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Label <String>

Specifies the new label of the image.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Eula <String>

Specifies the End User License Agreement. We recommend that the value is a URL.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Description <String>

Specifies the description of the operating system image.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ImageFamily <String>

Specifies a value that can be used to group operating system or virtual machine images.



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PublishedDate <Nullable`1[DateTime]>

Specifies the date when the operating system image was added to the image repository.



Required? false

Position? 5

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PrivacyUri <Uri>

Specifies the URI that points to a document that contains the privacy policy related to the operating system image.



Required? false

Position? 6

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RecommendedVMSize <String>

Specifies the size of the virtual machine.



The acceptable values for this parameter are:



-- Medium



-- Large



-- ExtraLarge



-- A5



-- A6



-- A7



Required? false

Position? 7

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DiskConfig <VirtualMachineImageDiskConfigSet>

Specifies the operating system disk and data disk configuration for the virtual machine image created by using the New-AzureVMImageDiskConfigSet,

Set-AzureVMImageOSDiskConfig, and Set-AzureVMImageDataDiskConfig cmdlets.



Required? false

Position? 8

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Language <String>

Specifies the language for the operating system in the virtual machine or operating system image.



Required? false

Position? 9

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IconName <String>

Specifies the standard icon name for the operating system or virtual machine image.



Required? false

Position? 10

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SmallIconName <String>

Specifies the small icon name for the operating system or virtual machine image.



Required? false

Position? 11

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DontShowInGui [<SwitchParameter>]





Required? false

Position? 12

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

OSImageContext







NOTES









-------------------------- Example 1: Update an image by changing the image label --------------------------



PS C:\\>Update-AzureVMImage -ImageName "Windows-Server-2008-SP2" -Label "DoNotUse"



This command updates the image named Windows-Server-2008-SP2 by changing the image label to DoNotUse.

-------------------------- Example 2: Get all operating systems by label and then update the label --------------------------



PS C:\\>Get-AzureVMImage | Where-Object {$_.Label -eq "DoNotUse" } | Update-AzureVMImage -Label "Updated"



This command gets all the operating system images labeled DoNotUse and changes the label to Updated.



RELATED LINKS

Add-AzureVMImage

Get-AzureVMImage

Remove-AzureVMImage

Save-AzureVMImage

New-AzureVMImageDiskConfigSet

Set-AzureVMImageOSDiskConfig

Set-AzureVMImageDataDiskConfig