Snapshot interface

パッケージ:

@azure/arm-compute

スナップショット リソース。

Extends

TrackedResource

プロパティ

completionPercent	CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。
copyCompletionError	CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。
creationData	ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。
dataAccessAuthMode	ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。
diskAccessId	ディスクでプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。
diskSizeBytes	ディスクのサイズ (バイト単位)。 このフィールドは読み取り専用です。
diskSizeGB	creationData.createOption が空の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズのみを増やすことができます。
diskState	スナップショットの状態。
encryption	Encryption プロパティを使用すると、保存データをカスタマー マネージド キーまたはプラットフォーム マネージド キーで暗号化できます。
encryptionSettingsCollection	使用される暗号化設定コレクションは Azure Disk Encryption で、ディスクまたはスナップショットごとに複数の暗号化設定を含めることができます。
extendedLocation	スナップショットが作成される拡張された場所。 拡張された場所は変更できません。
hyperVGeneration	仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。
incremental	スナップショットが増分であるかどうか。 同じディスク上の増分スナップショットは、完全なスナップショットよりも少ない領域を占有し、差分できます。
incrementalSnapshotFamilyId	ディスクの増分スナップショットは、増分スナップショット ファミリ ID を共有します。Get Page Range Diff API は、同じファミリ ID を持つ増分スナップショットでのみ呼び出すことができます。
managedBy	Unused. 常に 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	リソースの完全修飾リソース 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

プロパティ値

CopyCompletionError

creationData

ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。

creationData?: CreationData

プロパティ値

CreationData

dataAccessAuthMode

ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。

dataAccessAuthMode?: string

プロパティ値

string

diskAccessId

ディスクでプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。

diskAccessId?: string

プロパティ値

string

diskSizeBytes

ディスクのサイズ (バイト単位)。 このフィールドは読み取り専用です。

diskSizeBytes?: number

プロパティ値

number

diskSizeGB

creationData.createOption が空の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズのみを増やすことができます。

diskSizeGB?: number

プロパティ値

number

diskState

スナップショットの状態。

diskState?: string

プロパティ値

string

encryption

Encryption プロパティを使用すると、保存データをカスタマー マネージド キーまたはプラットフォーム マネージド キーで暗号化できます。

encryption?: Encryption

プロパティ値

Encryption

encryptionSettingsCollection

使用される暗号化設定コレクションは Azure Disk Encryption で、ディスクまたはスナップショットごとに複数の暗号化設定を含めることができます。

encryptionSettingsCollection?: EncryptionSettingsCollection

プロパティ値

EncryptionSettingsCollection

extendedLocation

スナップショットが作成される拡張された場所。 拡張された場所は変更できません。

extendedLocation?: ExtendedLocation

プロパティ値

ExtendedLocation

hyperVGeneration

仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。

hyperVGeneration?: string

プロパティ値

string

incremental

スナップショットが増分であるかどうか。 同じディスク上の増分スナップショットは、完全なスナップショットよりも少ない領域を占有し、差分できます。

incremental?: boolean

プロパティ値

boolean

incrementalSnapshotFamilyId

ディスクの増分スナップショットは、増分スナップショット ファミリ ID を共有します。Get Page Range Diff API は、同じファミリ ID を持つ増分スナップショットでのみ呼び出すことができます。

incrementalSnapshotFamilyId?: string

プロパティ値

string

managedBy

Unused. 常に Null。

managedBy?: string

プロパティ値

string

networkAccessPolicy

ネットワーク経由でディスクにアクセスするためのポリシー。

networkAccessPolicy?: string

プロパティ値

string

osType

オペレーティング システムの種類。

osType?: OperatingSystemTypes

プロパティ値

OperatingSystemTypes

provisioningState

ディスク のプロビジョニング状態。

provisioningState?: string

プロパティ値

string

publicNetworkAccess

ディスク上のエクスポートを制御するためのポリシー。

publicNetworkAccess?: string

プロパティ値

string

purchasePlan

スナップショットのソース ディスクが最初に作成されたイメージの購入プラン情報。

purchasePlan?: DiskPurchasePlan

プロパティ値

DiskPurchasePlan

securityProfile

リソースのセキュリティ関連情報を格納します。

securityProfile?: DiskSecurityProfile

プロパティ値

DiskSecurityProfile

sku

スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます

sku?: SnapshotSku

プロパティ値

SnapshotSku

snapshotAccessState

スナップショットのアクセス可用性を決定するスナップショットの状態。

snapshotAccessState?: string

プロパティ値

string

supportedCapabilities

スナップショットのソース ディスクが最初に作成されたイメージでサポートされている機能の一覧。

supportedCapabilities?: SupportedCapabilities

プロパティ値

SupportedCapabilities

supportsHibernation

スナップショット上の OS が休止状態をサポートしているかどうかを示します。

supportsHibernation?: boolean

プロパティ値

boolean

timeCreated

スナップショットが作成された時刻。

timeCreated?: Date

プロパティ値

Date

uniqueId

リソースを識別する一意の Guid。

uniqueId?: 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 Resource Manager メタデータ。

systemData?: 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から継承された