Share via


ImageOSDiskOutput interface

Describes an Operating System disk.

Extends

Properties

osState

The OS State. For managed images, use Generalized.

osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

Possible values are:

Windows

Linux

Inherited Properties

blobUri

The Virtual Hard Disk.

caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

diskEncryptionSet

Specifies the customer managed disk encryption set resource id for the managed image disk.

diskSizeGB

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

managedDisk

The managedDisk.

snapshot

The snapshot.

storageAccountType

Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

Property Details

osState

The OS State. For managed images, use Generalized.

osState: "Generalized" | "Specialized"

Property Value

"Generalized" | "Specialized"

osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

Possible values are:

Windows

Linux

osType: "Windows" | "Linux"

Property Value

"Windows" | "Linux"

Inherited Property Details

blobUri

The Virtual Hard Disk.

blobUri?: string

Property Value

string

Inherited From ImageDiskOutput.blobUri

caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

caching?: "None" | "ReadOnly" | "ReadWrite"

Property Value

"None" | "ReadOnly" | "ReadWrite"

Inherited From ImageDiskOutput.caching

diskEncryptionSet

Specifies the customer managed disk encryption set resource id for the managed image disk.

diskEncryptionSet?: DiskEncryptionSetParametersOutput

Property Value

Inherited From ImageDiskOutput.diskEncryptionSet

diskSizeGB

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

diskSizeGB?: number

Property Value

number

Inherited From ImageDiskOutput.diskSizeGB

managedDisk

The managedDisk.

managedDisk?: SubResourceOutput

Property Value

Inherited From ImageDiskOutput.managedDisk

snapshot

The snapshot.

snapshot?: SubResourceOutput

Property Value

Inherited From ImageDiskOutput.snapshot

storageAccountType

Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

storageAccountType?: "Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS" | "Premium_ZRS" | "StandardSSD_ZRS" | "PremiumV2_LRS"

Property Value

"Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS" | "Premium_ZRS" | "StandardSSD_ZRS" | "PremiumV2_LRS"

Inherited From ImageDiskOutput.storageAccountType