Snapshot interface

快照集資源。

Extends

屬性

completionPercent

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

copyCompletionError

如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤詳細數據。

creationData

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

dataAccessAuthMode

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

diskAccessId

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

diskSizeBytes

以位元組為單位的磁碟大小。 此欄位是唯讀的。

diskSizeGB

如果 creationData.createOption 為 Empty,則此欄位為必要字段,並指出要建立的磁碟大小。 如果此欄位存在以其他選項進行更新或建立,表示重設大小。 只有在磁碟未連結至執行中的 VM 時,才允許重設大小,而且只能增加磁碟的大小。

diskState

快照集的狀態。

encryption

加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。

encryptionSettingsCollection

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

extendedLocation

將建立快照集的擴充位置。 無法變更擴充位置。

hyperVGeneration

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

immutabilityPolicy

目前此快照適用不可變性政策。 僅在設定不可變性政策時才會存在。

incremental

快照集是否為累加式。 相同磁碟上的累加快照集佔用的空間小於完整快照集,而且可能會有差異。

incrementalSnapshotFamilyId

磁碟的增量快照共用增量快照系列識別碼。取得頁面範圍差異 API 只能在具有相同系列識別碼的累加快照集上呼叫。

managedBy

閑置。 一律為 Null。

networkAccessPolicy

透過網路存取磁碟的原則。

osType

操作系統類型。

provisioningState

磁碟布建狀態。

publicNetworkAccess

控制磁碟上導出的原則。

purchasePlan

最初建立快照集來源磁碟之映像的購買方案資訊。

securityProfile

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

sku

快照集 SKU 名稱。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 這是增量快照集的選擇性參數,默認行為是SKU將設定為與上一個快照集相同的SKU

snapshotAccessState

快照的狀態,用於確定快照的訪問可用性。

supportedCapabilities

原始建立快照集來源磁碟的映像支援功能清單。

supportsHibernation

指出快照集上的OS支援休眠。

timeCreated

建立快照集的時間。

uniqueId

識別資源的唯一 Guid。

繼承的屬性

id

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

資源所在的地理位置

name

資源名稱

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

資源標籤。

type

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

屬性詳細資料

completionPercent

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

completionPercent?: number

屬性值

number

copyCompletionError

如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤詳細數據。

copyCompletionError?: CopyCompletionError

屬性值

creationData

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

creationData?: CreationData

屬性值

dataAccessAuthMode

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

dataAccessAuthMode?: string

屬性值

string

diskAccessId

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

diskAccessId?: string

屬性值

string

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

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

hyperVGeneration?: string

屬性值

string

immutabilityPolicy

目前此快照適用不可變性政策。 僅在設定不可變性政策時才會存在。

immutabilityPolicy?: ImmutabilityPolicy

屬性值

incremental

快照集是否為累加式。 相同磁碟上的累加快照集佔用的空間小於完整快照集,而且可能會有差異。

incremental?: boolean

屬性值

boolean

incrementalSnapshotFamilyId

磁碟的增量快照共用增量快照系列識別碼。取得頁面範圍差異 API 只能在具有相同系列識別碼的累加快照集上呼叫。

incrementalSnapshotFamilyId?: string

屬性值

string

managedBy

閑置。 一律為 Null。

managedBy?: string

屬性值

string

networkAccessPolicy

透過網路存取磁碟的原則。

networkAccessPolicy?: string

屬性值

string

osType

操作系統類型。

osType?: OperatingSystemTypes

屬性值

provisioningState

磁碟布建狀態。

provisioningState?: string

屬性值

string

publicNetworkAccess

控制磁碟上導出的原則。

publicNetworkAccess?: string

屬性值

string

purchasePlan

最初建立快照集來源磁碟之映像的購買方案資訊。

purchasePlan?: DiskPurchasePlan

屬性值

securityProfile

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

securityProfile?: DiskSecurityProfile

屬性值

sku

快照集 SKU 名稱。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 這是增量快照集的選擇性參數,默認行為是SKU將設定為與上一個快照集相同的SKU

sku?: SnapshotSku

屬性值

snapshotAccessState

快照的狀態,用於確定快照的訪問可用性。

snapshotAccessState?: string

屬性值

string

supportedCapabilities

原始建立快照集來源磁碟的映像支援功能清單。

supportedCapabilities?: SupportedCapabilities

屬性值

supportsHibernation

指出快照集上的OS支援休眠。

supportsHibernation?: boolean

屬性值

boolean

timeCreated

建立快照集的時間。

timeCreated?: Date

屬性值

Date

uniqueId

識別資源的唯一 Guid。

uniqueId?: string

屬性值

string

繼承的屬性詳細資料

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 Resource Manager 元數據。

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