VirtualMachineScaleSetOSDisk interface

Describes a virtual machine scale set operating system disk.

Properties

caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

createOption

Specifies how the virtual machines in the scale set should be created.

The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

diffDiskSettings

Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.

diskSizeGB

Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

image

Specifies information about the unmanaged user image to base the scale set on.

managedDisk

The managed disk parameters.

name

The disk name.

osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

Windows

Linux. Possible values include: 'Windows', 'Linux'

vhdContainers

Specifies the container urls that are used to store operating system disks for the scale set.

writeAcceleratorEnabled

Specifies whether writeAccelerator should be enabled or disabled on the disk.

Property Details

caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

caching?: string

Property Value

string

createOption

Specifies how the virtual machines in the scale set should be created.

The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

createOption: string

Property Value

string

diffDiskSettings

Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.

diffDiskSettings?: DiffDiskSettings

Property Value

diskSizeGB

Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

diskSizeGB?: number

Property Value

number

image

Specifies information about the unmanaged user image to base the scale set on.

image?: VirtualHardDisk

Property Value

managedDisk

The managed disk parameters.

managedDisk?: VirtualMachineScaleSetManagedDiskParameters

Property Value

name

The disk name.

name?: string

Property Value

string

osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

Windows

Linux. Possible values include: 'Windows', 'Linux'

osType?: string

Property Value

string

vhdContainers

Specifies the container urls that are used to store operating system disks for the scale set.

vhdContainers?: string[]

Property Value

string[]

writeAcceleratorEnabled

Specifies whether writeAccelerator should be enabled or disabled on the disk.

writeAcceleratorEnabled?: boolean

Property Value

boolean