VirtualMachineScaleSetOSDisk interface

  • Reference
Package:
@azure/arm-compute

Describes a virtual machine scale set operating system disk.

Properties

caching

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
createOption

Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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.
deleteOption

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.
diffDiskSettings

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

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
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.
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. The default values are: None for Standard storage. ReadOnly for Premium storage.

caching?: CachingTypes

Property Value

CachingTypes

createOption

Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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.

createOption: string

Property Value

string

deleteOption

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

deleteOption?: 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

DiffDiskSettings

diskSizeGB

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

diskSizeGB?: number

Property Value

number

image

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

image?: VirtualHardDisk

Property Value

VirtualHardDisk

managedDisk

The managed disk parameters.

managedDisk?: VirtualMachineScaleSetManagedDiskParameters

Property Value

VirtualMachineScaleSetManagedDiskParameters

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.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

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