none
Set-AzureVMImageDataDiskConfig help information may have an error/typo

    Question

  • The help information for Set-AzureVMImageDataDiskConfig shows:

    help Set-AzureVMImageDataDiskConfig -full
    
    NAME
        Set-AzureVMImageDataDiskConfig
        
    SYNOPSIS
        Allows you to update the Data Disk properties on the VM Image
        
    SYNTAX
        Set-AzureVMImageDataDiskConfig [-DiskConfig] <VirtualMachineImageDiskConfigSet> [-DataDiskName] <string> [-Lun] <int> [-HostCaching] <string> [<CommonParameters>]
        
    PARAMETERS
        -DiskConfig <VirtualMachineImageDiskConfigSet>
            The disk config object that encapsulates the OS Disk and Data Disk objects.
            
            Required?                    true
            Position?                    1
            Default value                
            Accept pipeline input?       true (ByValue, ByPropertyName)
            Accept wildcard characters?  false
            
        -DataDiskName <string>
            
            Required?                    true
            Position?                    2
            Default value                
            Accept pipeline input?       true (ByPropertyName)
            Accept wildcard characters?  false
            
        -Lun <int>
            
            Required?                    true
            Position?                    3
            Default value                
            Accept pipeline input?       true (ByPropertyName)
            Accept wildcard characters?  false
            
        -HostCaching <string>
            
            Required?                    true
            Position?                    4
            Default value                
            Accept pipeline input?       true (ByPropertyName)
            Accept wildcard characters?  false
            
        <CommonParameters>
            This cmdlet supports the common parameters: Verbose, Debug,
            ErrorAction, ErrorVariable, WarningAction, WarningVariable,
            OutBuffer, PipelineVariable, and OutVariable. For more information, see 
            about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 
        
    OUTPUTS
        Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet
        
        -------------------------- EXAMPLE 1 --------------------------
        
        C:\PS>$s = New-AzureDiskConfigSet
                  # returns DiskConfigSet object;
        
                  $s = Set-AzureOSDiskConfig -DiskConfig $s -HostCaching ReadWrite
                  # returns DiskConfigSet object;
        
                  $s = Set-AzureDataDiskConfig -DiskConfig $s -Name 'test' -HostCaching 'ReadWrite' -LUN 0
                  # returns DiskConfigSet object
        
                  # Final step - Update the VM Image
                  Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1 -DiskConfigSet $s;
        
                  # OR
        
                  $s | Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1;
        

    The line

    Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1 -DiskConfigSet $s;

    refers to -DiskConfigSet parameter, but the Update-AzureVMImage shows a -DiskConfig parameter instead:

    help Update-AzureVMImage 
    
    NAME
        Update-AzureVMImage
        
    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] <string> [-Label] <string> [[-Eula] <string>] [[-Description] <string>] [[-ImageFamily] <string>] [[-PublishedDate] 
        <System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]>] [[-PrivacyUri] <Uri>] [[-RecommendedVMSize] <string>] 
        [[-DiskConfig] <VirtualMachineImageDiskConfigSet>] [[-Language] <string>] [[-IconUri] <Uri>] [[-SmallIconUri] <Uri>] [[-ShowInGui]] [<CommonParameters>]

    Azure module version 0.8.7.1


    Sam Boutros, Senior Consultant, Software Logic, KOP, PA http://superwidgets.wordpress.com (Please take a moment to Vote as Helpful and/or Mark as Answer, where applicable)

    Sunday, September 07, 2014 1:07 AM

Answers

  • Hi Sam,

    Though the HELP contents of "Set-AzureVMImageDataDiskConfig" syntax refers to -DiskConfigSet parameter in "Update-AzureVMImage" line, while executing the command of "Set-AzureVMImageDataDiskConfig" it will ask for -DiskConfig parameter as provided in the actual "Update-AzureVMImage" syntax.

    Please try to update the properties of Data Disk on VMImage and let know if any issues persists.

    Also, as Will informed earlier, will report this to concern team to update the HELP content with correct parameter name. Thank you.

    Regards,

    Manu Rekhar.


    Wednesday, October 15, 2014 7:08 AM
    Moderator

All replies

  • hi Sam,

    Thanks for your feedback. I have reproduced this issue.

    I will report it.  Thank you again.

    Regards,

    Will


    We are trying to better understand customer views on social support experience, so your participation in this interview project would be greatly appreciated if you have time. Thanks for helping make community forums a great place.
    Click HERE to participate the survey.

    Monday, September 08, 2014 7:21 AM
    Moderator
  • Hi Sam,

    Though the HELP contents of "Set-AzureVMImageDataDiskConfig" syntax refers to -DiskConfigSet parameter in "Update-AzureVMImage" line, while executing the command of "Set-AzureVMImageDataDiskConfig" it will ask for -DiskConfig parameter as provided in the actual "Update-AzureVMImage" syntax.

    Please try to update the properties of Data Disk on VMImage and let know if any issues persists.

    Also, as Will informed earlier, will report this to concern team to update the HELP content with correct parameter name. Thank you.

    Regards,

    Manu Rekhar.


    Wednesday, October 15, 2014 7:08 AM
    Moderator