Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Update-AzureVMImage

Update-AzureVMImage

microsoft.windowsazure.commands.servicemanagement.dll

Synopsis

The Update-AzureVMImage cmdlet updates the properties on an OS or VM image in the image repository. It returns an image object with information about the updated image.

Syntax

Update-AzureVMImage [-ImageName] [-Label] [-Eula] [-Description] [-ImageFamily] [-PublishedDate] [-PrivacyUri] [-RecommendedVMSize] [-DiskConfig] [-Language] [-IconUri] [-SmallIconUri] [-DontShowInGui] [<CommonParameters>]

Detailed Description

Parameters

-ImageName <String>

Name of the image to update in the image repository.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Label <String>

The new label of the image.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Eula <String>

Specifies the End User License Aggreement, recommended value is a URL.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies the description of the OS image.

Aliases

None

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 OS or VM images.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PublishedDate <Nullable`1[DateTime]>

Aliases

None

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 OS or VM image.

Aliases

None

Required?

false

Position

6

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-RecommendedVMSize <String>

Specifies the size to use for the virtual machine that is created from the OS or VM image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".

Aliases

None

Required?

false

Position

7

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-DiskConfig <VirtualMachineImageDiskConfigSet>

This is the OS Disk and the Data Disk configuration for the VM Image created using the New-AzureVMImageDiskConfigSet, Set-AzureVMImageOSDiskConfig and Set-AzureVMImageDataDiskConfig cmdlets.

Aliases

None

Required?

false

Position

8

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Language <String>

Language for the OS in the VM or OS Image

Aliases

None

Required?

false

Position

9

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-IconUri <Uri>

Uri to an icon for the OS or VM Image

Aliases

None

Required?

false

Position

10

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-SmallIconUri <Uri>

Uri to a small icon for the OS or VM Image

Aliases

None

Required?

false

Position

11

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-DontShowInGui <SwitchParameter>

Aliases

None

Required?

false

Position

12

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ShowInGui <switchparameter>

Not Specified

Aliases

None

Required?

false

Position

14

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

OSImageContext

Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

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

-------------------------- EXAMPLE 2 --------------------------

Description

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

Unknown