Set-AzureVMImageOSDiskConfig
Sets the operating system disk properties on a virtual machine image.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
UpdateAzureVMImageParamSet (Default)
Set-AzureVMImageOSDiskConfig
[-DiskConfig] <VirtualMachineImageDiskConfigSet>
[[-HostCaching] <String>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
AddAzureVMImageParamSet
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.
Examples
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.
Parameters
-DiskConfig
Specifies the disk configuration object that encapsulates the operating system disk and Data Disk objects.
Parameter properties
| Type: | VirtualMachineImageDiskConfigSet |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-HostCaching
Specifies the host cache attribute for the operating system disk.
Valid values are:
--ReadOnly --ReadWrite
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Parameter properties
| Type: | ActionPreference |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | infa |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InformationVariable
Specifies an information variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | iv |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MediaLink
Specifies the URI of the location where the new virtual hard drive is created when the new data disk is added.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AddAzureVMImageParamSet
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-OS
Specifies the operating system of the disk configuration.
Valid values are:
- Windows
- Linux
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AddAzureVMImageParamSet
| Position: | 4 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-OSState
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AddAzureVMImageParamSet
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.