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

Snapshot interface

包:

@azure/arm-compute

快照资源。

扩展

Resource

属性

completionPercent	通过 CopyStart 操作创建资源时后台副本的完成百分比。
copyCompletionError	指示通过 CopyStart 操作创建的资源的后台副本失败时的错误详细信息。
creationData	磁盘源信息。 创建磁盘后，无法更改创建数据信息。
dataAccessAuthMode	导出或上传到磁盘或快照时的其他身份验证要求。
diskAccessId	用于在磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。
diskSizeBytes	磁盘的大小（以字节为单位）。 该字段是只读字段。 注意：此属性不会序列化。 它只能由服务器填充。
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，它指示要创建的磁盘的大小。 如果此字段可用于使用其他选项进行更新或创建，则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。
diskState	快照的状态。 注意：此属性不会序列化。 它只能由服务器填充。
encryption	加密属性可用于使用客户管理的密钥或平台管理的密钥加密静态数据。
encryptionSettingsCollection	使用的加密设置集合是 Azure 磁盘加密，可以包含每个磁盘或快照的多个加密设置。
extendedLocation	将在其中创建快照的扩展位置。 无法更改扩展位置。
hyperVGeneration	虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。
incremental	快照是否为增量快照。 同一磁盘上的增量快照比完整快照占用的空间少，可以进行差异。
incrementalSnapshotFamilyId	磁盘的增量快照共享增量快照系列 ID。只能在具有相同系列 ID 的增量快照上调用获取页面范围差异 API。注意：此属性不会序列化。 它只能由服务器填充。
managedBy	未使用。 始终为 Null。 注意：此属性不会序列化。 它只能由服务器填充。
networkAccessPolicy	用于通过网络访问磁盘的策略。
osType	操作系统类型。
provisioningState	磁盘预配状态。 注意：此属性不会序列化。 它只能由服务器填充。
publicNetworkAccess	用于控制磁盘上的导出的策略。
purchasePlan	最初从中创建快照源磁盘的映像的购买计划信息。
securityProfile	包含资源的安全相关信息。
sku	快照 SKU 名称。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 这是增量快照的可选参数，默认行为是 SKU 将设置为与上一个快照相同的 SKU
supportedCapabilities	最初从中创建快照中的源磁盘的映像支持的功能列表。
supportsHibernation	指示快照上的 OS 支持休眠。
timeCreated	创建快照的时间。 注意：此属性不会序列化。 它只能由服务器填充。
uniqueId	标识资源的唯一 Guid。 注意：此属性不会序列化。 它只能由服务器填充。

继承属性

id	资源 ID 注意：此属性不会序列化。 它只能由服务器填充。
location	资源位置
name	资源名称 注意：不会序列化此属性。 它只能由服务器填充。
tags	资源标记
type	资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

completionPercent

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

completionPercent?: number

属性值

number

copyCompletionError

指示通过 CopyStart 操作创建的资源的后台副本失败时的错误详细信息。

copyCompletionError?: CopyCompletionError

属性值

CopyCompletionError

creationData

磁盘源信息。 创建磁盘后，无法更改创建数据信息。

creationData?: CreationData

属性值

CreationData

dataAccessAuthMode

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

dataAccessAuthMode?: string

属性值

string

diskAccessId

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

diskAccessId?: string

属性值

string

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

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

hyperVGeneration?: string

属性值

string

incremental

快照是否为增量快照。 同一磁盘上的增量快照比完整快照占用的空间少，可以进行差异。

incremental?: boolean

属性值

boolean

incrementalSnapshotFamilyId

磁盘的增量快照共享增量快照系列 ID。只能在具有相同系列 ID 的增量快照上调用获取页面范围差异 API。注意：此属性不会序列化。 它只能由服务器填充。

incrementalSnapshotFamilyId?: string

属性值

string

managedBy

未使用。 始终为 Null。 注意：此属性不会序列化。 它只能由服务器填充。

managedBy?: string

属性值

string

networkAccessPolicy

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

networkAccessPolicy?: string

属性值

string

osType

操作系统类型。

osType?: OperatingSystemTypes

属性值

OperatingSystemTypes

provisioningState

磁盘预配状态。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

publicNetworkAccess

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

publicNetworkAccess?: string

属性值

string

purchasePlan

最初从中创建快照源磁盘的映像的购买计划信息。

purchasePlan?: PurchasePlanAutoGenerated

属性值

PurchasePlanAutoGenerated

securityProfile

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

securityProfile?: DiskSecurityProfile

属性值

DiskSecurityProfile

sku

快照 SKU 名称。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 这是增量快照的可选参数，默认行为是 SKU 将设置为与上一个快照相同的 SKU

sku?: SnapshotSku

属性值

SnapshotSku

supportedCapabilities

最初从中创建快照中的源磁盘的映像支持的功能列表。

supportedCapabilities?: SupportedCapabilities

属性值

SupportedCapabilities

supportsHibernation

指示快照上的 OS 支持休眠。

supportsHibernation?: boolean

属性值

boolean

timeCreated

创建快照的时间。 注意：此属性不会序列化。 它只能由服务器填充。

timeCreated?: Date

属性值

Date

uniqueId

标识资源的唯一 Guid。 注意：此属性不会序列化。 它只能由服务器填充。

uniqueId?: string

属性值

string

继承属性详细信息

id

资源 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