Microsoft.Compute スナップショット 2022-07-02
Bicep リソース定義
スナップショット リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/snapshots リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/snapshots@2022-07-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'
galleryImageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
logicalSectorSize: int
performancePlus: bool
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
}
}
プロパティ値
スナップショット
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字数制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location | リソースの場所 | string (必須) |
| tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
| extendedLocation | スナップショットが作成される拡張場所。 拡張された場所は変更できません。 | ExtendedLocation |
| properties | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
| 名前 | 説明 | 値 |
|---|---|---|
| name | 拡張場所の名前。 | string |
| type | 拡張された場所の型。 | 'EdgeZone' |
SnapshotProperties
| 名前 | 説明 | 値 |
|---|---|---|
| completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | INT |
| copyCompletionError | CopyStart 操作によって作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
| creationData | ディスク ソース情報。 ディスクが作成された後は、CreationData 情報を変更できません。 | CreationData (必須) |
| dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | 'AzureActiveDirectory' 'None' |
| diskAccessId | ディスク上のプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | string |
| diskSizeGB | creationData.createOption が Empty の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されていない場合にのみ許可され、ディスクのサイズを増やすことができるだけです。 | INT |
| 暗号化 (encryption) | 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' 'CopyStart' '空' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必須) |
| galleryImageReference | ギャラリー イメージから作成する場合は必須です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャレー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
| imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
| logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 と 4096 です。 既定値は 4096 です。 | INT |
| performancePlus | デプロイされたディスクのパフォーマンス ターゲットを向上させるには、このフラグを true に設定します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後に無効にすることはできません。 | [bool] |
| securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | string |
| sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | string |
| sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | string |
| storageAccountId | createOption が Import の場合は必須。 Azure Resource Managerディスクとしてインポートする BLOB を含むストレージ アカウントの識別子。 | string |
| uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) から 35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | INT |
ImageDiskReference
| 名前 | 説明 | 値 |
|---|---|---|
| communityGalleryImageId | コミュニティ Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| id | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| lun | ディスクがイメージのデータ ディスクから作成される場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | INT |
| sharedGalleryImageId | 直接共有された Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
暗号化
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | string |
| type | ディスクのデータを暗号化するために使用されるキーの種類。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
| encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
| encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | string |
EncryptionSettingsElement
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionKey | Key Vaultディスク暗号化キーのシークレット URL とコンテナー ID | KeyVaultAndSecretReference |
| keyEncryptionKey | キー暗号化キーのキー URL とコンテナー ID をKey Vaultします。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップ解除に使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| 名前 | 説明 | 値 |
|---|---|---|
| secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
SourceVault
| 名前 | 説明 | 値 |
|---|---|---|
| id | リソース ID | string |
KeyVaultAndKeyReference
| 名前 | 説明 | 値 |
|---|---|---|
| keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
PurchasePlan
| 名前 | 説明 | 値 |
|---|---|---|
| name | プラン ID。 | string (必須) |
| product | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
| promotionCode | オファープロモーションコード。 | string |
| publisher | 発行元 ID。 | string (必須) |
DiskSecurityProfile
| 名前 | 説明 | 値 |
|---|---|---|
| secureVMDiskEncryptionSetId | カスタマー マネージド キーで暗号化された機密 VM でサポートされているディスクに関連付けられているディスク暗号化セットの ResourceId | string |
| securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
SupportedCapabilities
| 名前 | 説明 | 値 |
|---|---|---|
| acceleratedNetwork | OS ディスクの作成元のイメージで高速ネットワークがサポートされている場合は True。 | [bool] |
| アーキテクチャ | OS ディスクでサポートされる CPU アーキテクチャ。 | 'Arm64' 'x64' |
| diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定する場合は、SCSI または SCSI、NVME または NVME、SCSI を使用できます。 | string |
SnapshotSku
| 名前 | 説明 | 値 |
|---|---|---|
| name | SKU 名。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
ARM テンプレート リソース定義
スナップショット リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/snapshots リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2022-07-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",
"galleryImageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"logicalSectorSize": "int",
"performancePlus": "bool",
"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"
}
}
プロパティ値
スナップショット
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Compute/snapshots' |
| apiVersion | リソース API のバージョン | '2022-07-02' |
| name | リソース名 | string (必須) 文字数制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location | リソースの場所 | string (必須) |
| tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
| extendedLocation | スナップショットが作成される拡張場所。 拡張された場所は変更できません。 | ExtendedLocation |
| properties | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
| 名前 | 説明 | 値 |
|---|---|---|
| name | 拡張場所の名前。 | string |
| type | 拡張された場所の型。 | 'EdgeZone' |
SnapshotProperties
| 名前 | 説明 | 値 |
|---|---|---|
| completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | INT |
| copyCompletionError | CopyStart 操作によって作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
| creationData | ディスク ソース情報。 ディスクが作成された後は、CreationData 情報を変更できません。 | CreationData (必須) |
| dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | 'AzureActiveDirectory' 'None' |
| diskAccessId | ディスク上のプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | string |
| diskSizeGB | creationData.createOption が Empty の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されておらず、ディスクのサイズを増やすことができる場合にのみ許可されます。 | INT |
| 暗号化 (encryption) | 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' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必須) |
| galleryImageReference | ギャラリー イメージから作成する場合は必須です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャラリー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
| imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
| logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 と 4096 です。 既定値は 4096 です。 | INT |
| performancePlus | デプロイされたディスクのパフォーマンス ターゲットをブーストするには、このフラグを true に設定します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後に無効にすることはできません。 | [bool] |
| securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | string |
| sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | string |
| sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | string |
| storageAccountId | createOption が Import の場合は必須。 ディスクとしてインポートする BLOB を含むストレージ アカウントの Azure Resource Manager識別子。 | string |
| uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) と35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | INT |
ImageDiskReference
| 名前 | 説明 | 値 |
|---|---|---|
| communityGalleryImageId | コミュニティ Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| id | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| lun | ディスクがイメージのデータ ディスクから作成される場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | INT |
| sharedGalleryImageId | 直接共有された Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
暗号化
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | string |
| type | ディスクのデータを暗号化するために使用されるキーの種類。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
| encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
| encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | string |
EncryptionSettingsElement
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionKey | Key Vaultディスク暗号化キーのシークレット URL とコンテナー ID | KeyVaultAndSecretReference |
| keyEncryptionKey | キー暗号化キーのキー URL とコンテナー ID をKey Vaultします。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップ解除に使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| 名前 | 説明 | 値 |
|---|---|---|
| secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
SourceVault
| 名前 | 説明 | 値 |
|---|---|---|
| id | リソース ID | string |
KeyVaultAndKeyReference
| 名前 | 説明 | 値 |
|---|---|---|
| keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
PurchasePlan
| 名前 | 説明 | 値 |
|---|---|---|
| name | プラン ID。 | string (必須) |
| product | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
| promotionCode | オファープロモーションコード。 | string |
| publisher | 発行元 ID。 | string (必須) |
DiskSecurityProfile
| 名前 | 説明 | 値 |
|---|---|---|
| secureVMDiskEncryptionSetId | Confidential VM に関連付けられているディスク暗号化セットの ResourceId は、カスタマー マネージド キーを使用して暗号化されたディスクをサポートします | string |
| securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
SupportedCapabilities
| 名前 | 説明 | 値 |
|---|---|---|
| acceleratedNetwork | OS ディスクの作成元のイメージで高速ネットワークがサポートされている場合は True。 | [bool] |
| アーキテクチャ | OS ディスクでサポートされる CPU アーキテクチャ。 | 'Arm64' 'x64' |
| diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定する場合は、SCSI または SCSI、NVME または NVME、SCSI を使用できます。 | string |
SnapshotSku
| 名前 | 説明 | 値 |
|---|---|---|
| name | SKU 名。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
Terraform (AzAPI プロバイダー) リソース定義
スナップショット リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/snapshots リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2022-07-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"
galleryImageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
imageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
logicalSectorSize = int
performancePlus = bool
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"
}
})
}
プロパティ値
スナップショット
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Compute/snapshots@2022-07-02" |
| name | リソース名 | string (必須) 文字数制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location | リソースの場所 | string (必須) |
| parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| tags | リソース タグ | タグ名と値のディクショナリ。 |
| sku | スナップショット SKU 名。 Standard_LRS、Premium_LRS、またはStandard_ZRSできます。 これは増分スナップショットの省略可能なパラメーターであり、既定の動作では、SKU は前のスナップショットと同じ SKU に設定されます | SnapshotSku |
| extendedLocation | スナップショットが作成される拡張場所。 拡張された場所は変更できません。 | ExtendedLocation |
| properties | スナップショット リソースのプロパティ。 | SnapshotProperties |
ExtendedLocation
| 名前 | 説明 | 値 |
|---|---|---|
| name | 拡張場所の名前。 | string |
| type | 拡張された場所の型。 | "EdgeZone" |
SnapshotProperties
| 名前 | 説明 | 値 |
|---|---|---|
| completionPercent | CopyStart 操作を使用してリソースが作成されたときのバックグラウンド コピーの完了率。 | INT |
| copyCompletionError | CopyStart 操作を使用して作成されたリソースのバックグラウンド コピーが失敗した場合に、エラーの詳細を示します。 | CopyCompletionError |
| creationData | ディスク ソース情報。 ディスクの作成後に CreationData 情報を変更することはできません。 | CreationData (必須) |
| dataAccessAuthMode | ディスクまたはスナップショットにエクスポートまたはアップロードするときの追加の認証要件。 | "AzureActiveDirectory" "None" |
| diskAccessId | ディスク上のプライベート エンドポイントを使用するための DiskAccess リソースの ARM ID。 | string |
| diskSizeGB | creationData.createOption が Empty の場合、このフィールドは必須であり、作成するディスクのサイズを示します。 このフィールドが他のオプションを使用して更新または作成するために存在する場合は、サイズ変更を示します。 サイズ変更は、ディスクが実行中の VM に接続されておらず、ディスクのサイズを増やすことができる場合にのみ許可されます。 | INT |
| 暗号化 (encryption) | 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 | これにより、ディスクの作成に使用できるソースが列挙されます。 | "アタッチ" "コピー" "CopyStart" "Empty" "FromImage" "インポート" "ImportSecure" "復元" "アップロード" "UploadPreparedSecure" (必須) |
| galleryImageReference | ギャラリー イメージから作成する場合は必須です。 ImageDiskReference の id/sharedGalleryImageId/communityGalleryImageId は、ディスクの作成元となる共有ギャラリー イメージ バージョンの ARM ID になります。 | ImageDiskReference |
| imageReference | PIR またはユーザー イメージのディスク ソース情報。 | ImageDiskReference |
| logicalSectorSize | Ultra ディスクの論理セクター サイズ (バイト単位)。 サポートされている値は 512 と 4096 です。 既定値は 4096 です。 | INT |
| performancePlus | デプロイされたディスクのパフォーマンス ターゲットを向上させるには、このフラグを true に設定します。それぞれのパフォーマンス ターゲットについては、こちらを参照してください。 このフラグは、ディスク作成時にのみ設定でき、有効にした後に無効にすることはできません。 | [bool] |
| securityDataUri | createOption が ImportSecure の場合、これは VM ゲスト状態にインポートされる BLOB の URI です。 | string |
| sourceResourceId | createOption が Copy の場合、これはソース スナップショットまたはディスクの ARM ID です。 | string |
| sourceUri | createOption が Import の場合、これはマネージド ディスクにインポートされる BLOB の URI です。 | string |
| storageAccountId | createOption が Import の場合は必須。 Azure Resource Managerディスクとしてインポートする BLOB を含むストレージ アカウントの識別子。 | string |
| uploadSizeBytes | createOption が Upload の場合、これは VHD フッターを含むアップロードの内容のサイズです。 この値は、20972032 (VHD フッターの場合は 20 MiB + 512 バイト) から 35183298347520 バイト (VHD フッターの場合は 32 TiB + 512 バイト) の間である必要があります。 | INT |
ImageDiskReference
| 名前 | 説明 | 値 |
|---|---|---|
| communityGalleryImageId | コミュニティ Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| id | プラットフォーム イメージ リポジトリ、ユーザー イメージ、または Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
| lun | ディスクがイメージのデータ ディスクから作成される場合、これはイメージ内のどのデータ ディスクを使用するかを示すインデックスです。 OS ディスクの場合、このフィールドは null です。 | INT |
| sharedGalleryImageId | 直接共有 Azure Compute Gallery イメージ参照を含む相対 URI。 | string |
暗号化
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionSetId | 保存時の暗号化を有効にするために使用するディスク暗号化セットの ResourceId。 | string |
| type | ディスクのデータを暗号化するために使用されるキーの種類。 | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | このフラグを true に設定し、DiskEncryptionKey とオプションの KeyEncryptionKey を指定して暗号化を有効にします。 このフラグを false に設定し、DiskEncryptionKey と KeyEncryptionKey を削除して暗号化を無効にします。 要求オブジェクトで EncryptionSettings が null の場合、既存の設定は変更されません。 | bool (必須) |
| encryptionSettings | 暗号化設定のコレクション。ディスク ボリュームごとに 1 つ。 | EncryptionSettingsElement[] |
| encryptionSettingsVersion | ディスクに使用される暗号化の種類について説明します。 このフィールドを設定すると、上書きできません。 '1.0' は、AAD アプリを使用した Azure Disk Encryption に対応しています。'1.1' は Azure Disk Encryption に対応しています。 | string |
EncryptionSettingsElement
| 名前 | 説明 | 値 |
|---|---|---|
| diskEncryptionKey | ディスク暗号化キーのシークレット URL とコンテナー ID をKey Vaultする | KeyVaultAndSecretReference |
| keyEncryptionKey | キー暗号化キーのキー URL とコンテナー ID をKey Vaultします。 KeyEncryptionKey は省略可能であり、指定されている場合はディスク暗号化キーのラップ解除に使用されます。 | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| 名前 | 説明 | 値 |
|---|---|---|
| secretUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
SourceVault
| 名前 | 説明 | 値 |
|---|---|---|
| id | リソース ID | string |
KeyVaultAndKeyReference
| 名前 | 説明 | 値 |
|---|---|---|
| keyUrl | KeyVault のキーまたはシークレットを指す URL | string (必須) |
| sourceVault | キーまたはシークレットを含む KeyVault のリソース ID | SourceVault (必須) |
PurchasePlan
| 名前 | 説明 | 値 |
|---|---|---|
| name | プラン ID。 | string (必須) |
| product | マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 | string (必須) |
| promotionCode | オファープロモーションコード。 | string |
| publisher | 発行元 ID。 | string (必須) |
DiskSecurityProfile
| 名前 | 説明 | 値 |
|---|---|---|
| secureVMDiskEncryptionSetId | カスタマー マネージド キーで暗号化された機密 VM でサポートされているディスクに関連付けられているディスク暗号化セットの ResourceId | string |
| securityType | VM の SecurityType を指定します。 OS ディスクにのみ適用されます。 | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
| 名前 | 説明 | 値 |
|---|---|---|
| acceleratedNetwork | OS ディスクの作成元のイメージで高速ネットワークがサポートされている場合は True です。 | [bool] |
| アーキテクチャ | OS ディスクでサポートされる CPU アーキテクチャ。 | "Arm64" "x64" |
| diskControllerTypes | OS ディスクがサポートするディスク コントローラー。 設定されている場合は、SCSI または SCSI、NVME または NVME、SCSI を使用できます。 | string |
SnapshotSku
| 名前 | 説明 | 値 |
|---|---|---|
| name | SKU 名。 | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示