Update-AzureVMImage
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Update-AzureVMImage
Updates the label of an operating system image in the image repository.
Syntax
Parameter Set: Default
Update-AzureVMImage [-ImageName] <String> [-Label] <String> [[-Eula] <String> ] [[-Description] <String> ] [[-ImageFamily] <String> ] [[-PublishedDate] <DateTime> ] [[-PrivacyUri] <Uri> ] [[-RecommendedVMSize] <String> ] [[-DiskConfig] <VirtualMachineImageDiskConfigSet> ] [[-Language] <String> ] [[-IconUri] <Uri> ] [[-SmallIconUri] <Uri> ] [[-DontShowInGui]] [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
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
-Description<String>
Specifies the description of the operating system image.
Aliases |
none |
Required? |
false |
Position? |
4 |
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.
Aliases |
none |
Required? |
false |
Position? |
9 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-DontShowInGui
Aliases |
none |
Required? |
false |
Position? |
13 |
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.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IconUri<Uri>
Specifies a URI to an icon for the operating system or virtual machine image.
Aliases |
none |
Required? |
false |
Position? |
11 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ImageFamily<String>
Specifies a value that can group operating system or virtual machine images.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ImageName<String>
Specifies the name of the image to update in the image repository.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Label<String>
Specifies the new label of the image.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Language<String>
Specifies the language for the operating system in the virtual machine or operating system image.
Aliases |
none |
Required? |
false |
Position? |
10 |
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.
Aliases |
none |
Required? |
false |
Position? |
7 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PublishedDate<DateTime>
Specifies the date when the operating system image was added to the image repository.
Aliases |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
8 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SmallIconUri<Uri>
Specifies a URI to a small icon for the operating system or virtual machine image.
Aliases |
none |
Required? |
false |
Position? |
12 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
OSImageContext
Provides the information about the updated image.
Examples
Example 1
This example updates the image named "Windows-Server-2008-SP2" by changing the image label to “DoNotUse”.
C:\PS>Update-AzureVMImage –ImageName "Windows-Server-2008-SP2" -Label "DoNotUse"
Example 2
This example gets all the operating system images labeled “DoNotUse” and changes the label to "Updated".
C:\PS>Get-AzureVMImage | Where-Object {$_.Label –eq "DoNotUse" } | Update-AzureVMImage -Label "Updated"