Add-AzureVMImage

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Add-AzureVMImage

Adds a new operating system image to the image repository.

Parameter Set: Default
Add-AzureVMImage [-ImageName] <String> [-MediaLocation] <String> [-OS] <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 Add-AzureVMImage cmdlet adds a new operating system image to the image repository. The image should be a generalized operating system image, using either Sysprep for Windows or, for Linux, using the appropriate tool for the distribution.

-Description<String>

Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Eula<String>

Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ImageFamily<String>

Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ImageName<String>

Specifies the name of the image being added to the image repository.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Label<String>

Specifies a label to give the image.

Aliases

none

Required?

false

Position?

4

Default Value

Image name

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MediaLocation<String>

Specifies the location of the physical blob page where the image resides. This is a link to a blob page in the current subscription’s storage.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OS<String>

Specifies the operating system version of the image.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PrivacyUri<Uri>

Aliases

none

Required?

false

Position?

9

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PublishedDate<DateTime>

Aliases

none

Required?

false

Position?

8

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?

10

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 new operating system image.

Example 1

This example adds a new operating system image in the repository

C:\PS>Add-AzureVMImage -ImageName imageName -MediaLocation https://yourstorageaccount.blob.core.azure.com/container/sampleImage.vhd -Label imageLabel

Get-AzureVMImage

Remove-AzureVMImage

Update-AzureVMImage

Manage Images and Disks Using Windows Azure Cmdlets