< Back

Set-AzureVMImageOSDiskConfig

Wed Jan 30, 2019 5:54 pm

NAME Set-AzureVMImageOSDiskConfig



SYNOPSIS

Sets the operating system disk properties on a virtual machine image.





SYNTAX

Set-AzureVMImageOSDiskConfig [-DiskConfig] <VirtualMachineImageDiskConfigSet> [[-HostCaching] <String>] [-MediaLink] <Uri> [-OSState] <String> [-OS]

<String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Set-AzureVMImageOSDiskConfig cmdlet sets the operating system disk properties on a virtual machine image.





PARAMETERS

-DiskConfig <VirtualMachineImageDiskConfigSet>

Specifies the disk configuration object that encapsulates the operating system disk and Data Disk objects.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-HostCaching <String>

Specifies the host cache attribute for the operating system disk.



Valid values are:



--ReadOnly



--ReadWrite



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MediaLink <Uri>

Specifies the URI of the location where the new virtual hard drive is created when the new data disk is added.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OSState <String>

Specifies the operating system state for virtual machine image



Valid values are:



-- Generalized



-- Specialized





The use of this parameter indicates your intent to capture the virtual machine image to Azure.





Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OS <String>

Specifies the operating system of the disk configuration.



Valid values are:



-- Windows



-- Linux



Required? true

Position? 4

Default value None

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet







NOTES









-------------------------- Example 1: Set the operating system disk properties on a virtual machine image --------------------------



PS C:\\>$Disk = New-AzureDiskConfigSet

PS C:\\> $Disk = Set-AzureOSDiskConfig -DiskConfig $Disk -HostCaching ReadWrite

PS C:\\> $Disk = Set-AzureDataDiskConfig -DiskConfig $Disk -Name "Test" -HostCaching "ReadWrite" -LUN 0

PS C:\\> Update-AzureVMImage -ImageName "Image2" -Label "Test1" -Description "Test1" -DiskConfigSet $Disk;



This example sets the operating system disk properties on a virtual machine image.



RELATED LINKS

Remove-AzureVMImageOSDiskConfig