你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DataDisk interface

包:

@azure/arm-compute

描述数据磁盘。

属性

caching	指定缓存要求。 可能的值为： None、ReadOnly、ReadWrite。 默认行为为： 对于标准存储，无。高级存储的 ReadOnly。
createOption	指定应如何创建虚拟机磁盘。 可能的值是 Attach： 使用专用磁盘创建虚拟机时使用此值。 FromImage： 使用映像创建虚拟机数据磁盘时，将使用此值。 如果使用平台映像，还应使用上述 imageReference 元素。 如果使用市场映像，还应使用前面所述的计划元素。 空： 创建空数据磁盘时使用此值。 复制：此值用于从快照或其他磁盘创建数据磁盘。 恢复： 此值用于从磁盘还原点创建数据磁盘。
deleteOption	指定在删除 VM 时是应删除还是应分离数据磁盘。 可能的值为： Delete。 如果使用此值，则会在删除 VM 时删除数据磁盘。 分离。 如果使用此值，则会在删除 VM 后保留数据磁盘。 默认值设置为 Detach。
detachOption	指定分离磁盘时要使用的分离行为，或者已在从虚拟机分离过程中的分离行为。 支持的值： ForceDetach。 detachOption： ForceDetach 仅适用于托管数据磁盘。 如果由于虚拟机的意外故障而未完成对数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段，强行从 VM 分离磁盘。 使用此分离行为时，可能尚未刷新所有写入。 此功能仍处于预览 模式，VirtualMachineScaleSet 不支持此功能。 强制分离数据磁盘，请将 toBeDetached 更新为“true”，同时设置 detachOption：“ForceDetach”。
diskIopsReadWrite	指定UltraSSD_LRS StorageAccountType 时托管磁盘的 Read-Write IOPS。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。 注意：此属性不会序列化。 它只能由服务器填充。
diskMBpsReadWrite	指定UltraSSD_LRS StorageAccountType 时托管磁盘的带宽（以 MB/秒为单位）。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。 注意：此属性不会序列化。 它只能由服务器填充。
diskSizeGB	指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。
image	源用户映像虚拟硬盘。 在附加到虚拟机之前，将复制虚拟硬盘。 如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
lun	指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。
managedDisk	托管磁盘参数。
name	磁盘名称。
sourceResource	源资源标识符。 它可以是快照，也可以是创建磁盘的磁盘还原点。
toBeDetached	指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离
vhd	虚拟硬盘。
writeAcceleratorEnabled	指定是否应在磁盘上启用或禁用 writeAccelerator。

属性详细信息

caching

指定缓存要求。 可能的值为： None、ReadOnly、ReadWrite。 默认行为为： 对于标准存储，无。高级存储的 ReadOnly。

caching?: CachingTypes

属性值

CachingTypes

createOption

指定应如何创建虚拟机磁盘。 可能的值是 Attach： 使用专用磁盘创建虚拟机时使用此值。 FromImage： 使用映像创建虚拟机数据磁盘时，将使用此值。 如果使用平台映像，还应使用上述 imageReference 元素。 如果使用市场映像，还应使用前面所述的计划元素。 空： 创建空数据磁盘时使用此值。 复制：此值用于从快照或其他磁盘创建数据磁盘。 恢复： 此值用于从磁盘还原点创建数据磁盘。

createOption: string

属性值

string

deleteOption

指定在删除 VM 时是应删除还是应分离数据磁盘。 可能的值为： Delete。 如果使用此值，则会在删除 VM 时删除数据磁盘。 分离。 如果使用此值，则会在删除 VM 后保留数据磁盘。 默认值设置为 Detach。

deleteOption?: string

属性值

string

detachOption

指定分离磁盘时要使用的分离行为，或者已在从虚拟机分离过程中的分离行为。 支持的值： ForceDetach。 detachOption： ForceDetach 仅适用于托管数据磁盘。 如果由于虚拟机的意外故障而未完成对数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段，强行从 VM 分离磁盘。 使用此分离行为时，可能尚未刷新所有写入。 此功能仍处于预览 模式，VirtualMachineScaleSet 不支持此功能。 强制分离数据磁盘，请将 toBeDetached 更新为“true”，同时设置 detachOption：“ForceDetach”。

detachOption?: string

属性值

string

diskIopsReadWrite

指定UltraSSD_LRS StorageAccountType 时托管磁盘的 Read-Write IOPS。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。 注意：此属性不会序列化。 它只能由服务器填充。

diskIopsReadWrite?: number

属性值

number

diskMBpsReadWrite

指定UltraSSD_LRS StorageAccountType 时托管磁盘的带宽（以 MB/秒为单位）。 仅针对 VirtualMachine ScaleSet VM 磁盘返回。 只能通过对 VirtualMachine 规模集的更新进行更新。 注意：此属性不会序列化。 它只能由服务器填充。

diskMBpsReadWrite?: number

属性值

number

diskSizeGB

指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘大小。 属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。

diskSizeGB?: number

属性值

number

image

源用户映像虚拟硬盘。 在附加到虚拟机之前，将复制虚拟硬盘。 如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。

image?: VirtualHardDisk

属性值

VirtualHardDisk

lun

指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。

lun: number

属性值

number

managedDisk

托管磁盘参数。

managedDisk?: ManagedDiskParameters

属性值

ManagedDiskParameters

name

磁盘名称。

name?: string

属性值

string

sourceResource

源资源标识符。 它可以是快照，也可以是创建磁盘的磁盘还原点。

sourceResource?: ApiEntityReference

属性值

ApiEntityReference

toBeDetached

指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离

toBeDetached?: boolean

属性值

boolean

vhd

虚拟硬盘。

vhd?: VirtualHardDisk

属性值

VirtualHardDisk

writeAcceleratorEnabled

指定是否应在磁盘上启用或禁用 writeAccelerator。

writeAcceleratorEnabled?: boolean

属性值

boolean