Microsoft.Compute スナップショット 2024-03-02
Bicep リソース定義
スナップショット リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Compute/snapshots リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/snapshots@2024-03-02' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
extendedLocation: {
name: 'string'
type: 'EdgeZone'
}
properties: {
completionPercent: int
copyCompletionError: {
errorCode: 'CopySourceNotFound'
errorMessage: 'string'
}
creationData: {
createOption: 'string'
elasticSanResourceId: 'string'
galleryImageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
logicalSectorSize: int
performancePlus: bool
provisionedBandwidthCopySpeed: 'string'
securityDataUri: 'string'
sourceResourceId: 'string'
sourceUri: 'string'
storageAccountId: 'string'
uploadSizeBytes: int
}
dataAccessAuthMode: 'string'
diskAccessId: 'string'
diskSizeGB: int
encryption: {
diskEncryptionSetId: 'string'
type: 'string'
}
encryptionSettingsCollection: {
enabled: bool
encryptionSettings: [
{
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
]
encryptionSettingsVersion: 'string'
}
hyperVGeneration: 'string'
incremental: bool
networkAccessPolicy: 'string'
osType: 'string'
publicNetworkAccess: 'string'
purchasePlan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
}
securityProfile: {
secureVMDiskEncryptionSetId: 'string'
securityType: 'string'
}
supportedCapabilities: {
acceleratedNetwork: bool
architecture: 'string'
diskControllerTypes: 'string'
}
supportsHibernation: bool
}
}
プロパティ値
スナップショット
名前 | 形容 | 価値 |
---|---|---|
名前 | リソース名 | string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字、アンダースコア、ピリオド、ハイフン。 英数字から始めます。 末尾は英数字またはアンダースコアです。 |
場所 | リソースの場所 | string (必須) |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
extendedLocation | スナップショットが作成される拡張された場所。 拡張された場所は変更できません。 | ExtendedLocation の |
プロパティ | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
名前 | 形容 | 価値 |
---|---|---|
名前 | 拡張された場所の名前。 | 糸 |
種類 | 拡張された場所の型。 | 'EdgeZone' |
SnapshotProperties
名前 | 形容 | 価値 |
---|---|---|
completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | int |
copyCompletionError | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
creationData | ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。 | CreationData (必須) |
dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | 'AzureActiveDirectory' 'None' |
diskAccessId | ディスクでプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | 糸 |
diskSizeGB | creationData.createOption が空の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズのみを増やすことができます。 | int |
暗号化 | Encryption プロパティを使用すると、保存データをカスタマー マネージド キーまたはプラットフォーム マネージド キーで暗号化できます。 | 暗号化 |
encryptionSettingsCollection | 使用される暗号化設定コレクションは Azure Disk Encryption で、ディスクまたはスナップショットごとに複数の暗号化設定を含めることができます。 | EncryptionSettingsCollection |
hyperVGeneration | 仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。 | 'V1' 'V2' |
インクリメンタル | スナップショットが増分であるかどうか。 同じディスク上の増分スナップショットは、完全なスナップショットよりも少ない領域を占有し、差分できます。 | bool |
networkAccessPolicy | ネットワーク経由でディスクにアクセスするためのポリシー。 | 'AllowAll' 'AllowPrivate' 'DenyAll' |
osType | オペレーティング システムの種類。 | 'Linux' 'Windows' |
publicNetworkAccess | ディスク上のエクスポートを制御するためのポリシー。 | 'Disabled' 'Enabled' |
purchasePlan | スナップショットのソース ディスクが最初に作成されたイメージの購入プラン情報。 | PurchasePlan |
securityProfile | リソースのセキュリティ関連情報を格納します。 | DiskSecurityProfile の |
supportedCapabilities | スナップショットのソース ディスクが最初に作成されたイメージでサポートされている機能の一覧。 | SupportedCapabilities |
supportsHibernation | スナップショット上の OS が休止状態をサポートしているかどうかを示します。 | bool |
CopyCompletionError
名前 | 形容 | 価値 |
---|---|---|
errorCode | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合にエラー コードを示します。 | 'CopySourceNotFound' (必須) |
errorMessage | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合のエラー メッセージを示します。 | string (必須) |
CreationData
名前 | 形容 | 価値 |
---|---|---|
createOption | これにより、ディスクの作成に使用できるソースが列挙されます。 | 'Attach' 'Copy' 'CopyFromSanSnapshot' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必須) |
elasticSanResourceId | createOption が CopyFromSanSnapshot の場合は必須。 これは、ソースエラスティック SAN ボリューム スナップショットの ARM ID です。 | 糸 |
galleryImageReference | ギャラリー イメージから作成する場合に必要です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャラリー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 ad 4096 です。 4096 が既定値です。 | int |
performancePlus | このフラグを true に設定すると、デプロイされたディスクのパフォーマンス ターゲットが向上します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後は無効にできません。 | bool |
provisionedBandwidthCopySpeed | このフィールドがスナップショットに設定され、createOption が CopyStart の場合、スナップショットはより迅速にコピーされます。 | 'Enhanced' 'None' |
securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | 糸 |
sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | 糸 |
sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | 糸 |
storageAccountId | createOption が Import の場合は必須。 ディスクとしてインポートする BLOB を含むストレージ アカウントの Azure Resource Manager 識別子。 | 糸 |
uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) と35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | int |
ImageDiskReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | コミュニティの Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
身分証明書 | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
lun | ディスクがイメージのデータ ディスクから作成された場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | int |
sharedGalleryImageId | 直接共有 Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
暗号化
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | 糸 |
種類 | ディスクのデータを暗号化するために使用されるキーの種類。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
名前 | 形容 | 価値 |
---|---|---|
有効 | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | 糸 |
EncryptionSettingsElement
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionKey | ディスク暗号化キーの Key Vault シークレット URL とコンテナー ID | KeyVaultAndSecretReference |
keyEncryptionKey | キー暗号化キーの Key Vault キー URL とコンテナー ID。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップを解除するために使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
名前 | 形容 | 価値 |
---|---|---|
secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
SourceVault
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | リソース ID | 糸 |
KeyVaultAndKeyReference
名前 | 形容 | 価値 |
---|---|---|
keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
PurchasePlan
名前 | 形容 | 価値 |
---|---|---|
名前 | プラン ID。 | string (必須) |
積 | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
promotionCode | オファープロモーションコード。 | 糸 |
発行者 | 発行元 ID。 | string (必須) |
DiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
secureVMDiskEncryptionSetId | 機密 VM に関連付けられているディスク暗号化セットの ResourceId は、カスタマー マネージド キーで暗号化されています | 糸 |
securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_NonPersistedTPM' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
SupportedCapabilities
名前 | 形容 | 価値 |
---|---|---|
acceleratedNetwork | TRUE の 場合は、OS ディスクの作成元のイメージが高速ネットワークをサポートしています。 | bool |
建築 | OS ディスクでサポートされている CPU アーキテクチャ。 | 'Arm64' 'x64' |
diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定する場合は、SCSI、SCSI、NVME、NVME、SCSI を使用できます。 | 糸 |
SnapshotSku
名前 | 形容 | 価値 |
---|---|---|
名前 | SKU 名。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
ARM テンプレート リソース定義
スナップショット リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Compute/snapshots リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2024-03-02",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"properties": {
"completionPercent": "int",
"copyCompletionError": {
"errorCode": "CopySourceNotFound",
"errorMessage": "string"
},
"creationData": {
"createOption": "string",
"elasticSanResourceId": "string",
"galleryImageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"logicalSectorSize": "int",
"performancePlus": "bool",
"provisionedBandwidthCopySpeed": "string",
"securityDataUri": "string",
"sourceResourceId": "string",
"sourceUri": "string",
"storageAccountId": "string",
"uploadSizeBytes": "int"
},
"dataAccessAuthMode": "string",
"diskAccessId": "string",
"diskSizeGB": "int",
"encryption": {
"diskEncryptionSetId": "string",
"type": "string"
},
"encryptionSettingsCollection": {
"enabled": "bool",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
}
],
"encryptionSettingsVersion": "string"
},
"hyperVGeneration": "string",
"incremental": "bool",
"networkAccessPolicy": "string",
"osType": "string",
"publicNetworkAccess": "string",
"purchasePlan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string"
},
"securityProfile": {
"secureVMDiskEncryptionSetId": "string",
"securityType": "string"
},
"supportedCapabilities": {
"acceleratedNetwork": "bool",
"architecture": "string",
"diskControllerTypes": "string"
},
"supportsHibernation": "bool"
}
}
プロパティ値
スナップショット
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | 'Microsoft.Compute/snapshots' |
apiVersion | リソース API のバージョン | '2024-03-02' |
名前 | リソース名 | string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字、アンダースコア、ピリオド、ハイフン。 英数字から始めます。 末尾は英数字またはアンダースコアです。 |
場所 | リソースの場所 | string (必須) |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
extendedLocation | スナップショットが作成される拡張された場所。 拡張された場所は変更できません。 | ExtendedLocation の |
プロパティ | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
名前 | 形容 | 価値 |
---|---|---|
名前 | 拡張された場所の名前。 | 糸 |
種類 | 拡張された場所の型。 | 'EdgeZone' |
SnapshotProperties
名前 | 形容 | 価値 |
---|---|---|
completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | int |
copyCompletionError | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
creationData | ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。 | CreationData (必須) |
dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | 'AzureActiveDirectory' 'None' |
diskAccessId | ディスクでプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | 糸 |
diskSizeGB | creationData.createOption が空の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズのみを増やすことができます。 | int |
暗号化 | Encryption プロパティを使用すると、保存データをカスタマー マネージド キーまたはプラットフォーム マネージド キーで暗号化できます。 | 暗号化 |
encryptionSettingsCollection | 使用される暗号化設定コレクションは Azure Disk Encryption で、ディスクまたはスナップショットごとに複数の暗号化設定を含めることができます。 | EncryptionSettingsCollection |
hyperVGeneration | 仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。 | 'V1' 'V2' |
インクリメンタル | スナップショットが増分であるかどうか。 同じディスク上の増分スナップショットは、完全なスナップショットよりも少ない領域を占有し、差分できます。 | bool |
networkAccessPolicy | ネットワーク経由でディスクにアクセスするためのポリシー。 | 'AllowAll' 'AllowPrivate' 'DenyAll' |
osType | オペレーティング システムの種類。 | 'Linux' 'Windows' |
publicNetworkAccess | ディスク上のエクスポートを制御するためのポリシー。 | 'Disabled' 'Enabled' |
purchasePlan | スナップショットのソース ディスクが最初に作成されたイメージの購入プラン情報。 | PurchasePlan |
securityProfile | リソースのセキュリティ関連情報を格納します。 | DiskSecurityProfile の |
supportedCapabilities | スナップショットのソース ディスクが最初に作成されたイメージでサポートされている機能の一覧。 | SupportedCapabilities |
supportsHibernation | スナップショット上の OS が休止状態をサポートしているかどうかを示します。 | bool |
CopyCompletionError
名前 | 形容 | 価値 |
---|---|---|
errorCode | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合にエラー コードを示します。 | 'CopySourceNotFound' (必須) |
errorMessage | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合のエラー メッセージを示します。 | string (必須) |
CreationData
名前 | 形容 | 価値 |
---|---|---|
createOption | これにより、ディスクの作成に使用できるソースが列挙されます。 | 'Attach' 'Copy' 'CopyFromSanSnapshot' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必須) |
elasticSanResourceId | createOption が CopyFromSanSnapshot の場合は必須。 これは、ソースエラスティック SAN ボリューム スナップショットの ARM ID です。 | 糸 |
galleryImageReference | ギャラリー イメージから作成する場合に必要です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャラリー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 ad 4096 です。 4096 が既定値です。 | int |
performancePlus | このフラグを true に設定すると、デプロイされたディスクのパフォーマンス ターゲットが向上します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後は無効にできません。 | bool |
provisionedBandwidthCopySpeed | このフィールドがスナップショットに設定され、createOption が CopyStart の場合、スナップショットはより迅速にコピーされます。 | 'Enhanced' 'None' |
securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | 糸 |
sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | 糸 |
sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | 糸 |
storageAccountId | createOption が Import の場合は必須。 ディスクとしてインポートする BLOB を含むストレージ アカウントの Azure Resource Manager 識別子。 | 糸 |
uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) と35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | int |
ImageDiskReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | コミュニティの Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
身分証明書 | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
lun | ディスクがイメージのデータ ディスクから作成された場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | int |
sharedGalleryImageId | 直接共有 Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
暗号化
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | 糸 |
種類 | ディスクのデータを暗号化するために使用されるキーの種類。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
名前 | 形容 | 価値 |
---|---|---|
有効 | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | 糸 |
EncryptionSettingsElement
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionKey | ディスク暗号化キーの Key Vault シークレット URL とコンテナー ID | KeyVaultAndSecretReference |
keyEncryptionKey | キー暗号化キーの Key Vault キー URL とコンテナー ID。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップを解除するために使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
名前 | 形容 | 価値 |
---|---|---|
secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
SourceVault
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | リソース ID | 糸 |
KeyVaultAndKeyReference
名前 | 形容 | 価値 |
---|---|---|
keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
PurchasePlan
名前 | 形容 | 価値 |
---|---|---|
名前 | プラン ID。 | string (必須) |
積 | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
promotionCode | オファープロモーションコード。 | 糸 |
発行者 | 発行元 ID。 | string (必須) |
DiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
secureVMDiskEncryptionSetId | 機密 VM に関連付けられているディスク暗号化セットの ResourceId は、カスタマー マネージド キーで暗号化されています | 糸 |
securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_NonPersistedTPM' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
SupportedCapabilities
名前 | 形容 | 価値 |
---|---|---|
acceleratedNetwork | TRUE の 場合は、OS ディスクの作成元のイメージが高速ネットワークをサポートしています。 | bool |
建築 | OS ディスクでサポートされている CPU アーキテクチャ。 | 'Arm64' 'x64' |
diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定する場合は、SCSI、SCSI、NVME、NVME、SCSI を使用できます。 | 糸 |
SnapshotSku
名前 | 形容 | 価値 |
---|---|---|
名前 | SKU 名。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
Terraform (AzAPI プロバイダー) リソース定義
スナップショット リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Compute/snapshots リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2024-03-02"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
completionPercent = int
copyCompletionError = {
errorCode = "CopySourceNotFound"
errorMessage = "string"
}
creationData = {
createOption = "string"
elasticSanResourceId = "string"
galleryImageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
imageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
logicalSectorSize = int
performancePlus = bool
provisionedBandwidthCopySpeed = "string"
securityDataUri = "string"
sourceResourceId = "string"
sourceUri = "string"
storageAccountId = "string"
uploadSizeBytes = int
}
dataAccessAuthMode = "string"
diskAccessId = "string"
diskSizeGB = int
encryption = {
diskEncryptionSetId = "string"
type = "string"
}
encryptionSettingsCollection = {
enabled = bool
encryptionSettings = [
{
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
]
encryptionSettingsVersion = "string"
}
hyperVGeneration = "string"
incremental = bool
networkAccessPolicy = "string"
osType = "string"
publicNetworkAccess = "string"
purchasePlan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
}
securityProfile = {
secureVMDiskEncryptionSetId = "string"
securityType = "string"
}
supportedCapabilities = {
acceleratedNetwork = bool
architecture = "string"
diskControllerTypes = "string"
}
supportsHibernation = bool
}
sku = {
name = "string"
}
extendedLocation = {
name = "string"
type = "EdgeZone"
}
})
}
プロパティ値
スナップショット
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | "Microsoft.Compute/snapshots@2024-03-02" |
名前 | リソース名 | string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字、アンダースコア、ピリオド、ハイフン。 英数字から始めます。 末尾は英数字またはアンダースコアです。 |
場所 | リソースの場所 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
extendedLocation | スナップショットが作成される拡張された場所。 拡張された場所は変更できません。 | ExtendedLocation の |
プロパティ | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
名前 | 形容 | 価値 |
---|---|---|
名前 | 拡張された場所の名前。 | 糸 |
種類 | 拡張された場所の型。 | "EdgeZone" |
SnapshotProperties
名前 | 形容 | 価値 |
---|---|---|
completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | int |
copyCompletionError | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
creationData | ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。 | CreationData (必須) |
dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | "AzureActiveDirectory" "なし" |
diskAccessId | ディスクでプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | 糸 |
diskSizeGB | creationData.createOption が空の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズのみを増やすことができます。 | int |
暗号化 | Encryption プロパティを使用すると、保存データをカスタマー マネージド キーまたはプラットフォーム マネージド キーで暗号化できます。 | 暗号化 |
encryptionSettingsCollection | 使用される暗号化設定コレクションは Azure Disk Encryption で、ディスクまたはスナップショットごとに複数の暗号化設定を含めることができます。 | EncryptionSettingsCollection |
hyperVGeneration | 仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。 | "V1" "V2" |
インクリメンタル | スナップショットが増分であるかどうか。 同じディスク上の増分スナップショットは、完全なスナップショットよりも少ない領域を占有し、差分できます。 | bool |
networkAccessPolicy | ネットワーク経由でディスクにアクセスするためのポリシー。 | "AllowAll" "AllowPrivate" "DenyAll" |
osType | オペレーティング システムの種類。 | "Linux" "Windows" |
publicNetworkAccess | ディスク上のエクスポートを制御するためのポリシー。 | "無効" "有効" |
purchasePlan | スナップショットのソース ディスクが最初に作成されたイメージの購入プラン情報。 | PurchasePlan |
securityProfile | リソースのセキュリティ関連情報を格納します。 | DiskSecurityProfile の |
supportedCapabilities | スナップショットのソース ディスクが最初に作成されたイメージでサポートされている機能の一覧。 | SupportedCapabilities |
supportsHibernation | スナップショット上の OS が休止状態をサポートしているかどうかを示します。 | bool |
CopyCompletionError
名前 | 形容 | 価値 |
---|---|---|
errorCode | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合にエラー コードを示します。 | "CopySourceNotFound" (必須) |
errorMessage | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合のエラー メッセージを示します。 | string (必須) |
CreationData
名前 | 形容 | 価値 |
---|---|---|
createOption | これにより、ディスクの作成に使用できるソースが列挙されます。 | "Attach" "コピー" "CopyFromSanSnapshot" "CopyStart" "空" "FromImage" "インポート" "ImportSecure" "復元" "アップロード" "UploadPreparedSecure" (必須) |
elasticSanResourceId | createOption が CopyFromSanSnapshot の場合は必須。 これは、ソースエラスティック SAN ボリューム スナップショットの ARM ID です。 | 糸 |
galleryImageReference | ギャラリー イメージから作成する場合に必要です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャラリー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 ad 4096 です。 4096 が既定値です。 | int |
performancePlus | このフラグを true に設定すると、デプロイされたディスクのパフォーマンス ターゲットが向上します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後は無効にできません。 | bool |
provisionedBandwidthCopySpeed | このフィールドがスナップショットに設定され、createOption が CopyStart の場合、スナップショットはより迅速にコピーされます。 | "Enhanced" "なし" |
securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | 糸 |
sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | 糸 |
sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | 糸 |
storageAccountId | createOption が Import の場合は必須。 ディスクとしてインポートする BLOB を含むストレージ アカウントの Azure Resource Manager 識別子。 | 糸 |
uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) と35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | int |
ImageDiskReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | コミュニティの Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
身分証明書 | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
lun | ディスクがイメージのデータ ディスクから作成された場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | int |
sharedGalleryImageId | 直接共有 Azure コンピューティング ギャラリー イメージ参照を含む相対 URI。 | 糸 |
暗号化
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | 糸 |
種類 | ディスクのデータを暗号化するために使用されるキーの種類。 | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
名前 | 形容 | 価値 |
---|---|---|
有効 | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | 糸 |
EncryptionSettingsElement
名前 | 形容 | 価値 |
---|---|---|
diskEncryptionKey | ディスク暗号化キーの Key Vault シークレット URL とコンテナー ID | KeyVaultAndSecretReference |
keyEncryptionKey | キー暗号化キーの Key Vault キー URL とコンテナー ID。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップを解除するために使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
名前 | 形容 | 価値 |
---|---|---|
secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
SourceVault
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | リソース ID | 糸 |
KeyVaultAndKeyReference
名前 | 形容 | 価値 |
---|---|---|
keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault の |
PurchasePlan
名前 | 形容 | 価値 |
---|---|---|
名前 | プラン ID。 | string (必須) |
積 | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
promotionCode | オファープロモーションコード。 | 糸 |
発行者 | 発行元 ID。 | string (必須) |
DiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
secureVMDiskEncryptionSetId | 機密 VM に関連付けられているディスク暗号化セットの ResourceId は、カスタマー マネージド キーで暗号化されています | 糸 |
securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_NonPersistedTPM" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
名前 | 形容 | 価値 |
---|---|---|
acceleratedNetwork | TRUE の 場合は、OS ディスクの作成元のイメージが高速ネットワークをサポートしています。 | bool |
建築 | OS ディスクでサポートされている CPU アーキテクチャ。 | "Arm64" "x64" |
diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定する場合は、SCSI、SCSI、NVME、NVME、SCSI を使用できます。 | 糸 |
SnapshotSku
名前 | 形容 | 価値 |
---|---|---|
名前 | SKU 名。 | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |