Disk interface

套件:

@azure/arm-compute

磁碟資源。

Extends

Resource

屬性

burstingEnabled	設定為 true，以啟用超出磁碟布建效能目標的高載。 預設會停用高載。 不適用於 Ultra 磁碟。
burstingEnabledTime	上次在磁碟上啟用高載的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
completionPercent	透過 CopyStart 作業建立資源時，背景複製完成的百分比。
creationData	磁碟來源資訊。 建立磁碟之後，無法變更 CreationData 資訊。
dataAccessAuthMode	匯出或上傳至磁碟或快照集時的其他驗證需求。
diskAccessId	DiskAccess 資源的 ARM 識別碼，用於在磁碟上使用私人端點。
diskIopsReadOnly	所有裝載共用磁碟作為 ReadOnly 的 VM 所允許的 IOPS 總數。 一個作業可以在 4k 到 256k 個字節之間傳輸。
diskIopsReadWrite	此磁碟允許的 IOPS 數目;只能針對 UltraSSD 磁碟設定。 一個作業可以在 4k 到 256k 個字節之間傳輸。
diskMBpsReadOnly	所有裝載共用磁碟作為 ReadOnly 的 VM 所允許的總輸送量 （MBps）。 MBps 表示每秒數百萬個字節 - MB 會使用 ISO 表示法，其乘冪為 10。
diskMBpsReadWrite	此磁碟允許的頻寬;只能針對 UltraSSD 磁碟設定。 MBps 表示每秒數百萬個字節 - MB 會使用 ISO 表示法，其乘冪為 10。
diskSizeBytes	以位元組為單位的磁碟大小。 此欄位是唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
diskSizeGB	如果 creationData.createOption 為 Empty，則此欄位為必要字段，並指出要建立的磁碟大小。 如果此欄位存在以其他選項進行更新或建立，表示重設大小。 只有在磁碟未連結至執行中的 VM 時，才允許重設大小，而且只能增加磁碟的大小。
diskState	磁碟的狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
encryption	加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。
encryptionSettingsCollection	用於 Azure 磁碟加密的加密設定集合，可以包含每個磁碟或快照集的多個加密設定。
extendedLocation	將建立磁碟的擴充位置。 無法變更擴充位置。
hyperVGeneration	虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。
lastOwnershipUpdateTime	上次變更磁碟擁有權狀態的 UTC 時間，也就是上次連結或中斷連結磁碟的時間，或是解除分配或啟動磁碟的 VM 的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
managedBy	包含已連結磁碟之 VM 識別碼的相對 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。
managedByExtended	包含已連結磁碟之 VM 識別碼的相對 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/。 不適用於 Ultra 磁碟。
timeCreated	建立磁碟的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。
uniqueId	識別資源的唯一 Guid。 注意：這個屬性不會串行化。 它只能由伺服器填入。
zones	磁碟的邏輯區域清單。

繼承的屬性

id	資源標識碼注意：此屬性不會串行化。 它只能由伺服器填入。
location	資源位置
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
tags	資源標籤
type	資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

burstingEnabled

設定為 true，以啟用超出磁碟布建效能目標的高載。 預設會停用高載。 不適用於 Ultra 磁碟。

burstingEnabled?: boolean

屬性值

boolean

burstingEnabledTime

上次在磁碟上啟用高載的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

burstingEnabledTime?: Date

屬性值

Date

completionPercent

透過 CopyStart 作業建立資源時，背景複製完成的百分比。

completionPercent?: number

屬性值

number

creationData

磁碟來源資訊。 建立磁碟之後，無法變更 CreationData 資訊。

creationData?: CreationData

屬性值

CreationData

dataAccessAuthMode

匯出或上傳至磁碟或快照集時的其他驗證需求。

dataAccessAuthMode?: string

屬性值

string

diskAccessId

DiskAccess 資源的 ARM 識別碼，用於在磁碟上使用私人端點。

diskAccessId?: string

屬性值

string

diskIopsReadOnly

所有裝載共用磁碟作為 ReadOnly 的 VM 所允許的 IOPS 總數。 一個作業可以在 4k 到 256k 個字節之間傳輸。

diskIopsReadOnly?: number

屬性值

number

diskIopsReadWrite

此磁碟允許的 IOPS 數目;只能針對 UltraSSD 磁碟設定。 一個作業可以在 4k 到 256k 個字節之間傳輸。

diskIopsReadWrite?: number

屬性值

number

diskMBpsReadOnly

所有裝載共用磁碟作為 ReadOnly 的 VM 所允許的總輸送量 （MBps）。 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

屬性值

Encryption

encryptionSettingsCollection

用於 Azure 磁碟加密的加密設定集合，可以包含每個磁碟或快照集的多個加密設定。

encryptionSettingsCollection?: EncryptionSettingsCollection

屬性值

EncryptionSettingsCollection

extendedLocation

將建立磁碟的擴充位置。 無法變更擴充位置。

extendedLocation?: ExtendedLocation

屬性值

ExtendedLocation

hyperVGeneration

虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。

hyperVGeneration?: string

屬性值

string

lastOwnershipUpdateTime

上次變更磁碟擁有權狀態的 UTC 時間，也就是上次連結或中斷連結磁碟的時間，或是解除分配或啟動磁碟的 VM 的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

lastOwnershipUpdateTime?: Date

屬性值

Date

managedBy

包含已連結磁碟之 VM 識別碼的相對 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。

managedBy?: string

屬性值

string

managedByExtended

包含已連結磁碟之 VM 識別碼的相對 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

屬性值

OperatingSystemTypes

propertyUpdatesInProgress

正在擱置更新之磁碟的屬性。 注意：這個屬性不會串行化。 它只能由伺服器填入。

propertyUpdatesInProgress?: PropertyUpdatesInProgress

屬性值

PropertyUpdatesInProgress

provisioningState

磁碟布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

publicNetworkAccess

控制磁碟上導出的原則。

publicNetworkAccess?: string

屬性值

string

purchasePlan

建立OS磁碟的來源映像購買方案資訊。 例如 - {name： 2019-Datacenter， publisher： MicrosoftWindowsServer， product： WindowsServer}

purchasePlan?: DiskPurchasePlan

屬性值

DiskPurchasePlan

securityProfile

包含資源的安全性相關信息。

securityProfile?: DiskSecurityProfile

屬性值

DiskSecurityProfile

shareInfo

已連結磁碟之所有 VM 清單的詳細數據。 maxShares 應該設定為大於一個的值，讓磁碟能夠將它們連結至多個 VM。 注意：這個屬性不會串行化。 它只能由伺服器填入。

shareInfo?: ShareInfoElement[]

屬性值

ShareInfoElement[]

sku

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

sku?: DiskSku

屬性值

DiskSku

supportedCapabilities

建立OS磁碟的映像支援功能清單。

supportedCapabilities?: SupportedCapabilities

屬性值

SupportedCapabilities

supportsHibernation

表示磁碟上的OS支援休眠。

supportsHibernation?: boolean

屬性值

boolean

tier

磁碟的效能層級（例如 P4、S10）如下所述：https://azure.microsoft.com/en-us/pricing/details/managed-disks/。 不適用於 Ultra 磁碟。

tier?: string

屬性值

string

timeCreated

建立磁碟的時間。 注意：這個屬性不會串行化。 它只能由伺服器填入。

timeCreated?: Date

屬性值

Date

uniqueId

識別資源的唯一 Guid。 注意：這個屬性不會串行化。 它只能由伺服器填入。

uniqueId?: string

屬性值

string

zones

磁碟的邏輯區域清單。

zones?: string[]

屬性值

string[]

繼承的屬性詳細資料

id

資源標識碼注意：此屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自Resource.id

location

資源位置

location: string

屬性值

string

繼承自Resource.location

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自Resource.name

tags

資源標籤

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自Resource.tags

type

資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自Resource.type