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

Disk interface

磁盘资源。

扩展

属性

availabilityPolicy

确定平台如何处理磁盘故障

burstingEnabled

设置为 true 以启用超出磁盘预配性能目标的突发。 默认情况下禁用突发。 不适用于超级磁盘。

burstingEnabledTime

上次在磁盘上启用突发的时间。

completionPercent

通过 CopyStart作创建资源时后台副本完成的百分比。

creationData

磁盘源信息。 创建磁盘后,无法更改 CreationData 信息。

dataAccessAuthMode

导出或上传到磁盘或快照时的其他身份验证要求。

diskAccessId

磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。

diskIopsReadOnly

将允许在所有 VM 中以 ReadOnly 身份装载共享磁盘的 IOPS 总数。 一个作可以在 4k 到 256k 字节之间传输。

diskIopsReadWrite

此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个作可以在 4k 到 256k 字节之间传输。

diskMBpsReadOnly

所有装载共享磁盘的 VM(MBps)的总吞吐量(MBps)将作为 ReadOnly 装载。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,其幂为 10。

diskMBpsReadWrite

此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,其幂为 10。

diskSizeBytes

磁盘的大小(以字节为单位)。 此字段为只读。

diskSizeGB

如果 creationData.createOption 为 Empty,则此字段是必需的,并指示要创建的磁盘的大小。 如果此字段可用于更新或创建其他选项,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。

diskState

磁盘的状态。

encryption

加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。

encryptionSettingsCollection

用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。

extendedLocation

将创建磁盘的扩展位置。 无法更改扩展位置。

hyperVGeneration

虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。

lastOwnershipUpdateTime

上次更改磁盘所有权状态的 UTC 时间,即上次附加或分离磁盘的时间,或者磁盘附加到的 VM 解除分配或启动的时间。

managedBy

包含附加磁盘的 VM 的 ID 的相对 URI。

managedByExtended

包含附加了磁盘的 VM 的 ID 的相对 URI 列表。 maxShares 应设置为大于一个值,以便磁盘允许将它们附加到多个 VM。

maxShares

可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载到多个 VM 上的磁盘。

networkAccessPolicy

通过网络访问磁盘的策略。

optimizedForFrequentAttach

将此属性设置为 true 可提高数据磁盘的可靠性和性能,这些磁盘通常(每天超过 5 次),方法是从一个虚拟机分离并附加到另一个虚拟机。 不应为未频繁分离和附加的磁盘设置此属性,因为它会导致磁盘与虚拟机的容错域不一致。

osType

作系统类型。

propertyUpdatesInProgress

要为其挂起更新的磁盘的属性。

provisioningState

磁盘预配状态。

publicNetworkAccess

用于控制磁盘上的导出的策略。

purchasePlan

为从中创建 OS 磁盘的映像购买计划信息。 例如 - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

securityProfile

包含资源的安全相关信息。

shareInfo

附加了磁盘的所有 VM 的列表的详细信息。 maxShares 应设置为大于一个值,以便磁盘允许将它们附加到多个 VM。

sku

磁盘 SKU 名称。 可以是Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS、StandardSSD_ZRS或PremiumV2_LRS。

supportedCapabilities

创建 OS 磁盘的映像支持的功能列表。

supportsHibernation

指示磁盘上的 OS 支持休眠。

tier

磁盘的性能层(例如 P4、S10)如下所述:https://azure.microsoft.com/en-us/pricing/details/managed-disks/。 不适用于超级磁盘。

timeCreated

创建磁盘的时间。

uniqueId

标识资源的唯一 Guid。

zones

磁盘的逻辑区域列表。

继承属性

id

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

资源所在的地理位置

name

资源的名称

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

资源标记。

type

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

属性详细信息

availabilityPolicy

确定平台如何处理磁盘故障

availabilityPolicy?: AvailabilityPolicy

属性值

burstingEnabled

设置为 true 以启用超出磁盘预配性能目标的突发。 默认情况下禁用突发。 不适用于超级磁盘。

burstingEnabled?: boolean

属性值

boolean

burstingEnabledTime

上次在磁盘上启用突发的时间。

burstingEnabledTime?: Date

属性值

Date

completionPercent

通过 CopyStart作创建资源时后台副本完成的百分比。

completionPercent?: number

属性值

number

creationData

磁盘源信息。 创建磁盘后,无法更改 CreationData 信息。

creationData?: CreationData

属性值

dataAccessAuthMode

导出或上传到磁盘或快照时的其他身份验证要求。

dataAccessAuthMode?: string

属性值

string

diskAccessId

磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。

diskAccessId?: string

属性值

string

diskIopsReadOnly

将允许在所有 VM 中以 ReadOnly 身份装载共享磁盘的 IOPS 总数。 一个作可以在 4k 到 256k 字节之间传输。

diskIopsReadOnly?: number

属性值

number

diskIopsReadWrite

此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个作可以在 4k 到 256k 字节之间传输。

diskIopsReadWrite?: number

属性值

number

diskMBpsReadOnly

所有装载共享磁盘的 VM(MBps)的总吞吐量(MBps)将作为 ReadOnly 装载。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,其幂为 10。

diskMBpsReadOnly?: number

属性值

number

diskMBpsReadWrite

此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,其幂为 10。

diskMBpsReadWrite?: number

属性值

number

diskSizeBytes

磁盘的大小(以字节为单位)。 此字段为只读。

diskSizeBytes?: number

属性值

number

diskSizeGB

如果 creationData.createOption 为 Empty,则此字段是必需的,并指示要创建的磁盘的大小。 如果此字段可用于更新或创建其他选项,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。

diskSizeGB?: number

属性值

number

diskState

磁盘的状态。

diskState?: string

属性值

string

encryption

加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。

encryption?: Encryption

属性值

encryptionSettingsCollection

用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。

encryptionSettingsCollection?: EncryptionSettingsCollection

属性值

extendedLocation

将创建磁盘的扩展位置。 无法更改扩展位置。

extendedLocation?: ExtendedLocation

属性值

hyperVGeneration

虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。

hyperVGeneration?: string

属性值

string

lastOwnershipUpdateTime

上次更改磁盘所有权状态的 UTC 时间,即上次附加或分离磁盘的时间,或者磁盘附加到的 VM 解除分配或启动的时间。

lastOwnershipUpdateTime?: Date

属性值

Date

managedBy

包含附加磁盘的 VM 的 ID 的相对 URI。

managedBy?: string

属性值

string

managedByExtended

包含附加了磁盘的 VM 的 ID 的相对 URI 列表。 maxShares 应设置为大于一个值,以便磁盘允许将它们附加到多个 VM。

managedByExtended?: string[]

属性值

string[]

maxShares

可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载到多个 VM 上的磁盘。

maxShares?: number

属性值

number

networkAccessPolicy

通过网络访问磁盘的策略。

networkAccessPolicy?: string

属性值

string

optimizedForFrequentAttach

将此属性设置为 true 可提高数据磁盘的可靠性和性能,这些磁盘通常(每天超过 5 次),方法是从一个虚拟机分离并附加到另一个虚拟机。 不应为未频繁分离和附加的磁盘设置此属性,因为它会导致磁盘与虚拟机的容错域不一致。

optimizedForFrequentAttach?: boolean

属性值

boolean

osType

作系统类型。

osType?: OperatingSystemTypes

属性值

propertyUpdatesInProgress

要为其挂起更新的磁盘的属性。

propertyUpdatesInProgress?: PropertyUpdatesInProgress

属性值

provisioningState

磁盘预配状态。

provisioningState?: string

属性值

string

publicNetworkAccess

用于控制磁盘上的导出的策略。

publicNetworkAccess?: string

属性值

string

purchasePlan

为从中创建 OS 磁盘的映像购买计划信息。 例如 - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

purchasePlan?: DiskPurchasePlan

属性值

securityProfile

包含资源的安全相关信息。

securityProfile?: DiskSecurityProfile

属性值

shareInfo

附加了磁盘的所有 VM 的列表的详细信息。 maxShares 应设置为大于一个值,以便磁盘允许将它们附加到多个 VM。

shareInfo?: ShareInfoElement[]

属性值

sku

磁盘 SKU 名称。 可以是Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS、StandardSSD_ZRS或PremiumV2_LRS。

sku?: DiskSku

属性值

supportedCapabilities

创建 OS 磁盘的映像支持的功能列表。

supportedCapabilities?: SupportedCapabilities

属性值

supportsHibernation

指示磁盘上的 OS 支持休眠。

supportsHibernation?: boolean

属性值

boolean

tier

磁盘的性能层(例如 P4、S10)如下所述:https://azure.microsoft.com/en-us/pricing/details/managed-disks/。 不适用于超级磁盘。

tier?: string

属性值

string

timeCreated

创建磁盘的时间。

timeCreated?: Date

属性值

Date

uniqueId

标识资源的唯一 Guid。

uniqueId?: string

属性值

string

zones

磁盘的逻辑区域列表。

zones?: string[]

属性值

string[]

继承属性详细信息

id

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

属性值

string

继承自 TrackedResource.id

location

资源所在的地理位置

location: string

属性值

string

继承自TrackedResource.location

name

资源的名称

name?: string

属性值

string

继承自 TrackedResource.name

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

systemData?: SystemData

属性值

继承自TrackedResource.systemData

tags

资源标记。

tags?: Record<string, string>

属性值

Record<string, string>

继承自TrackedResource.tags

type

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

type?: string

属性值

string

继承自TrackedResource.type