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 an operating system image to the image repository.
Syntax
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>]
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 Add-AzureVMImage cmdlet adds an 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.
Parameters
-Description<String>
Specifies the description of the operating system image.
Aliases |
none |
Required? |
false |
Position? |
6 |
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? |
5 |
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 images.
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>
Specifies the URI that points to a document that contains the privacy policy related to the operating system image.
Aliases |
none |
Required? |
false |
Position? |
9 |
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? |
8 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RecommendedVMSize<String>
Specifies the size of the virtual machine. For size information, see Virtual Machine and Cloud Service Sizes for Azure
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.
Examples
Example 1
This example adds an operating system image to the repository.
C:\PS>Add-AzureVMImage -ImageName imageName -MediaLocation https://yourstorageaccount.blob.core.azure.com/container/sampleImage.vhd -Label imageLabel