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.
Parameter Set: Default
Update-AzureVMImage [-ImageName] <String> [-Label] <String> [[-Eula] <String> ] [[-Description] <String> ] [[-ImageFamily] <String> ] [[-PublishedDate] <DateTime> ] [[-PrivacyUri] <Uri> ] [[-RecommendedVMSize] <String> ] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module 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.
-Description<String>
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Eula<String>
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ImageFamily<String>
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 |
-PrivacyUri<Uri>
Aliases |
none |
Required? |
false |
Position? |
7 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PublishedDate<DateTime>
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 |
<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.
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"