Microsoft.計算快照集 2022-03-02
Bicep 資源定義
快照集資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/snapshots 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Compute/snapshots@2022-03-02' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
completionPercent: int
copyCompletionError: {
errorCode: 'string'
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
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'
}
supportsHibernation: bool
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
CopyCompletionError
名字 | 描述 | 價值 |
---|---|---|
errorCode | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤碼。 | 'CopySourceNotFound' (必要) |
errorMessage | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤訊息。 | 字串 (必要) |
CreationData
名字 | 描述 | 價值 |
---|---|---|
createOption | 這會列舉磁碟建立的可能來源。 | 'Attach' 'Copy' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必要) |
galleryImageReference | 如果從資源庫映射建立,則為必要專案。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 將是用來建立磁碟之共用 galley 映射版本的 ARM 標識符。 | ImageDiskReference |
imageReference | PIR 或使用者映像的磁碟來源資訊。 | ImageDiskReference |
logicalSectorSize | Ultra 磁碟的邏輯扇區大小,以位元組為單位。 支援的值為 512 ad 4096。 4096 是預設值。 | int |
securityDataUri | 如果 createOption 是 ImportSecure,這是要匯入至 VM 客體狀態之 Blob 的 URI。 | 字串 |
sourceResourceId | 如果 createOption 是 Copy,這是來源快照集或磁碟的 ARM 識別碼。 | 字串 |
sourceUri | 如果 createOption 為 Import,這是要匯入受控磁碟之 Blob 的 URI。 | 字串 |
storageAccountId | 如果 createOption 為 Import,則為必要專案。 記憶體帳戶的 Azure Resource Manager 識別符,其中包含要匯入為磁碟的 Blob。 | 字串 |
uploadSizeBytes | 如果 createOption 是 Upload,這是上傳的內容大小,包括 VHD 頁尾。 此值應介於 20972032 (VHD 頁尾為 20 MiB + 512 位元元組)和 35183298347520 個字節之間(VHD 頁尾為 32 TiB + 512 位元組)。 | int |
DiskSecurityProfile
名字 | 描述 | 價值 |
---|---|---|
secureVMDiskEncryptionSetId | 與以客戶管理金鑰加密的機密 VM 支援的磁碟相關聯的磁碟加密集 ResourceId | 字串 |
securityType | 指定 VM 的 SecurityType。 僅適用於OS磁碟。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
加密
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionSetId | 要用於啟用待用加密的磁碟加密集 ResourceId。 | 字串 |
類型 | 用來加密磁碟數據的金鑰類型。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
名字 | 描述 | 價值 |
---|---|---|
啟用 | 將此旗標設定為 true,並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。 將此旗標設定為 false,並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。 如果 Request 物件中的 EncryptionSettings 為 Null,則現有的設定會保持不變。 | 布林 (必要) |
encryptionSettings | 加密設定的集合,每個磁碟區各一個。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | 描述磁碟所使用的加密類型。 設定此欄位之後,即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。 | 字串 |
EncryptionSettingsElement
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionKey | 磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼 | KeyVaultAndSecretReference |
keyEncryptionKey | 金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的,而且提供時用來解除包裝磁碟加密密鑰。 | KeyVaultAndKeyReference |
ExtendedLocation
名字 | 描述 | 價值 |
---|---|---|
名字 | 擴充位置的名稱。 | 字串 |
類型 | 擴充位置的類型。 | 'EdgeZone' |
ImageDiskReference
名字 | 描述 | 價值 |
---|---|---|
communityGalleryImageId | 包含社群 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
id | 包含平臺映像存放庫、使用者映像或 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
倫 | 如果磁碟是從映射的數據磁碟建立的,這是一個索引,指出映射中要使用的數據磁碟。 針對OS磁碟,此欄位為 null。 | int |
sharedGalleryImageId | 包含直接共用 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
KeyVaultAndKeyReference
名字 | 描述 | 價值 |
---|---|---|
keyUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
KeyVaultAndSecretReference
名字 | 描述 | 價值 |
---|---|---|
secretUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
Microsoft.Compute/snapshots
名字 | 描述 | 價值 |
---|---|---|
extendedLocation | 將建立快照集的擴充位置。 無法變更擴充位置。 | ExtendedLocation |
位置 | 資源位置 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | 快照集資源屬性。 | SnapshotProperties |
sku | 快照集 SKU 名稱。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 這是增量快照集的選擇性參數,默認行為是SKU將設定為與上一個快照集相同的SKU | SnapshotSku |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
PurchasePlan
名字 | 描述 | 價值 |
---|---|---|
名字 | 方案標識碼。 | 字串 (必要) |
產品 | 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 | 字串 (必要) |
promotionCode | 供應項目促銷碼。 | 字串 |
發行人 | 發行者標識碼。 | 字串 (必要) |
ResourceTags
名字 | 描述 | 價值 |
---|
SnapshotProperties
名字 | 描述 | 價值 |
---|---|---|
completionPercent | 透過 CopyStart 作業建立資源時,背景複製完成的百分比。 | int |
copyCompletionError | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤詳細數據。 | CopyCompletionError |
creationData | 磁碟來源資訊。 建立磁碟之後,無法變更 CreationData 資訊。 | CreationData (必要) |
dataAccessAuthMode | 匯出或上傳至磁碟或快照集時的其他驗證需求。 | 'AzureActiveDirectory' 'None' |
diskAccessId | DiskAccess 資源的 ARM 識別碼,用於在磁碟上使用私人端點。 | 字串 |
diskSizeGB | 如果 creationData.createOption 為 Empty,則此欄位為必要字段,並指出要建立的磁碟大小。 如果此欄位存在以其他選項進行更新或建立,表示重設大小。 只有在磁碟未連結至執行中的 VM 時,才允許重設大小,而且只能增加磁碟的大小。 | int |
加密 | 加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。 | 加密 |
encryptionSettingsCollection | 加密設定集合是 Azure 磁碟加密,可以包含每個磁碟或快照集的多個加密設定。 | EncryptionSettingsCollection |
hyperVGeneration | 虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。 | 'V1' 'V2' |
增量 | 快照集是否為累加式。 相同磁碟上的累加快照集佔用的空間小於完整快照集,而且可能會有差異。 | bool |
networkAccessPolicy | 透過網路存取磁碟的原則。 | 'AllowAll' 'AllowPrivate' 'DenyAll' |
osType | 操作系統類型。 | 'Linux' 'Windows' |
publicNetworkAccess | 控制磁碟上導出的原則。 | 'Disabled' 'Enabled' |
purchasePlan | 最初建立快照集來源磁碟之映像的購買方案資訊。 | PurchasePlan |
securityProfile | 包含資源的安全性相關信息。 | DiskSecurityProfile |
supportedCapabilities | 原始建立快照集來源磁碟的映像支援功能清單。 | SupportedCapabilities |
supportsHibernation | 指出快照集上的OS支援休眠。 | bool |
SnapshotSku
名字 | 描述 | 價值 |
---|---|---|
名字 | SKU 名稱。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
名字 | 描述 | 價值 |
---|---|---|
id | 資源標識碼 | 字串 |
SupportedCapabilities
名字 | 描述 | 價值 |
---|---|---|
acceleratedNetwork | 如果建立OS磁碟的映像支援加速網路,則為True。 | bool |
建築 | OS 磁碟支援的CPU架構。 | 'Arm64' 'x64' |
ARM 樣本資源定義
快照集資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/snapshots 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2022-03-02",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"completionPercent": "int",
"copyCompletionError": {
"errorCode": "string",
"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",
"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"
},
"supportsHibernation": "bool"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
CopyCompletionError
名字 | 描述 | 價值 |
---|---|---|
errorCode | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤碼。 | 'CopySourceNotFound' (必要) |
errorMessage | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤訊息。 | 字串 (必要) |
CreationData
名字 | 描述 | 價值 |
---|---|---|
createOption | 這會列舉磁碟建立的可能來源。 | 'Attach' 'Copy' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必要) |
galleryImageReference | 如果從資源庫映射建立,則為必要專案。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 將是用來建立磁碟之共用 galley 映射版本的 ARM 標識符。 | ImageDiskReference |
imageReference | PIR 或使用者映像的磁碟來源資訊。 | ImageDiskReference |
logicalSectorSize | Ultra 磁碟的邏輯扇區大小,以位元組為單位。 支援的值為 512 ad 4096。 4096 是預設值。 | int |
securityDataUri | 如果 createOption 是 ImportSecure,這是要匯入至 VM 客體狀態之 Blob 的 URI。 | 字串 |
sourceResourceId | 如果 createOption 是 Copy,這是來源快照集或磁碟的 ARM 識別碼。 | 字串 |
sourceUri | 如果 createOption 為 Import,這是要匯入受控磁碟之 Blob 的 URI。 | 字串 |
storageAccountId | 如果 createOption 為 Import,則為必要專案。 記憶體帳戶的 Azure Resource Manager 識別符,其中包含要匯入為磁碟的 Blob。 | 字串 |
uploadSizeBytes | 如果 createOption 是 Upload,這是上傳的內容大小,包括 VHD 頁尾。 此值應介於 20972032 (VHD 頁尾為 20 MiB + 512 位元元組)和 35183298347520 個字節之間(VHD 頁尾為 32 TiB + 512 位元組)。 | int |
DiskSecurityProfile
名字 | 描述 | 價值 |
---|---|---|
secureVMDiskEncryptionSetId | 與以客戶管理金鑰加密的機密 VM 支援的磁碟相關聯的磁碟加密集 ResourceId | 字串 |
securityType | 指定 VM 的 SecurityType。 僅適用於OS磁碟。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
加密
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionSetId | 要用於啟用待用加密的磁碟加密集 ResourceId。 | 字串 |
類型 | 用來加密磁碟數據的金鑰類型。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
名字 | 描述 | 價值 |
---|---|---|
啟用 | 將此旗標設定為 true,並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。 將此旗標設定為 false,並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。 如果 Request 物件中的 EncryptionSettings 為 Null,則現有的設定會保持不變。 | 布林 (必要) |
encryptionSettings | 加密設定的集合,每個磁碟區各一個。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | 描述磁碟所使用的加密類型。 設定此欄位之後,即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。 | 字串 |
EncryptionSettingsElement
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionKey | 磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼 | KeyVaultAndSecretReference |
keyEncryptionKey | 金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的,而且提供時用來解除包裝磁碟加密密鑰。 | KeyVaultAndKeyReference |
ExtendedLocation
名字 | 描述 | 價值 |
---|---|---|
名字 | 擴充位置的名稱。 | 字串 |
類型 | 擴充位置的類型。 | 'EdgeZone' |
ImageDiskReference
名字 | 描述 | 價值 |
---|---|---|
communityGalleryImageId | 包含社群 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
id | 包含平臺映像存放庫、使用者映像或 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
倫 | 如果磁碟是從映射的數據磁碟建立的,這是一個索引,指出映射中要使用的數據磁碟。 針對OS磁碟,此欄位為 null。 | int |
sharedGalleryImageId | 包含直接共用 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
KeyVaultAndKeyReference
名字 | 描述 | 價值 |
---|---|---|
keyUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
KeyVaultAndSecretReference
名字 | 描述 | 價值 |
---|---|---|
secretUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
Microsoft.Compute/snapshots
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2022-03-02' |
extendedLocation | 將建立快照集的擴充位置。 無法變更擴充位置。 | ExtendedLocation |
位置 | 資源位置 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | 快照集資源屬性。 | SnapshotProperties |
sku | 快照集 SKU 名稱。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 這是增量快照集的選擇性參數,默認行為是SKU將設定為與上一個快照集相同的SKU | SnapshotSku |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 | 資源類型 | 'Microsoft.Compute/snapshots' |
PurchasePlan
名字 | 描述 | 價值 |
---|---|---|
名字 | 方案標識碼。 | 字串 (必要) |
產品 | 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 | 字串 (必要) |
promotionCode | 供應項目促銷碼。 | 字串 |
發行人 | 發行者標識碼。 | 字串 (必要) |
ResourceTags
名字 | 描述 | 價值 |
---|
SnapshotProperties
名字 | 描述 | 價值 |
---|---|---|
completionPercent | 透過 CopyStart 作業建立資源時,背景複製完成的百分比。 | int |
copyCompletionError | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤詳細數據。 | CopyCompletionError |
creationData | 磁碟來源資訊。 建立磁碟之後,無法變更 CreationData 資訊。 | CreationData (必要) |
dataAccessAuthMode | 匯出或上傳至磁碟或快照集時的其他驗證需求。 | 'AzureActiveDirectory' 'None' |
diskAccessId | DiskAccess 資源的 ARM 識別碼,用於在磁碟上使用私人端點。 | 字串 |
diskSizeGB | 如果 creationData.createOption 為 Empty,則此欄位為必要字段,並指出要建立的磁碟大小。 如果此欄位存在以其他選項進行更新或建立,表示重設大小。 只有在磁碟未連結至執行中的 VM 時,才允許重設大小,而且只能增加磁碟的大小。 | int |
加密 | 加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。 | 加密 |
encryptionSettingsCollection | 加密設定集合是 Azure 磁碟加密,可以包含每個磁碟或快照集的多個加密設定。 | EncryptionSettingsCollection |
hyperVGeneration | 虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。 | 'V1' 'V2' |
增量 | 快照集是否為累加式。 相同磁碟上的累加快照集佔用的空間小於完整快照集,而且可能會有差異。 | bool |
networkAccessPolicy | 透過網路存取磁碟的原則。 | 'AllowAll' 'AllowPrivate' 'DenyAll' |
osType | 操作系統類型。 | 'Linux' 'Windows' |
publicNetworkAccess | 控制磁碟上導出的原則。 | 'Disabled' 'Enabled' |
purchasePlan | 最初建立快照集來源磁碟之映像的購買方案資訊。 | PurchasePlan |
securityProfile | 包含資源的安全性相關信息。 | DiskSecurityProfile |
supportedCapabilities | 原始建立快照集來源磁碟的映像支援功能清單。 | SupportedCapabilities |
supportsHibernation | 指出快照集上的OS支援休眠。 | bool |
SnapshotSku
名字 | 描述 | 價值 |
---|---|---|
名字 | SKU 名稱。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
名字 | 描述 | 價值 |
---|---|---|
id | 資源標識碼 | 字串 |
SupportedCapabilities
名字 | 描述 | 價值 |
---|---|---|
acceleratedNetwork | 如果建立OS磁碟的映像支援加速網路,則為True。 | bool |
建築 | OS 磁碟支援的CPU架構。 | 'Arm64' 'x64' |
Terraform (AzAPI 提供者) 資源定義
快照集資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/snapshots 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2022-03-02"
name = "string"
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
extendedLocation = {
name = "string"
type = "string"
}
properties = {
completionPercent = int
copyCompletionError = {
errorCode = "string"
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
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"
}
supportsHibernation = bool
}
})
}
屬性值
CopyCompletionError
名字 | 描述 | 價值 |
---|---|---|
errorCode | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤碼。 | 'CopySourceNotFound' (必要) |
errorMessage | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤訊息。 | 字串 (必要) |
CreationData
名字 | 描述 | 價值 |
---|---|---|
createOption | 這會列舉磁碟建立的可能來源。 | 'Attach' 'Copy' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (必要) |
galleryImageReference | 如果從資源庫映射建立,則為必要專案。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 將是用來建立磁碟之共用 galley 映射版本的 ARM 標識符。 | ImageDiskReference |
imageReference | PIR 或使用者映像的磁碟來源資訊。 | ImageDiskReference |
logicalSectorSize | Ultra 磁碟的邏輯扇區大小,以位元組為單位。 支援的值為 512 ad 4096。 4096 是預設值。 | int |
securityDataUri | 如果 createOption 是 ImportSecure,這是要匯入至 VM 客體狀態之 Blob 的 URI。 | 字串 |
sourceResourceId | 如果 createOption 是 Copy,這是來源快照集或磁碟的 ARM 識別碼。 | 字串 |
sourceUri | 如果 createOption 為 Import,這是要匯入受控磁碟之 Blob 的 URI。 | 字串 |
storageAccountId | 如果 createOption 為 Import,則為必要專案。 記憶體帳戶的 Azure Resource Manager 識別符,其中包含要匯入為磁碟的 Blob。 | 字串 |
uploadSizeBytes | 如果 createOption 是 Upload,這是上傳的內容大小,包括 VHD 頁尾。 此值應介於 20972032 (VHD 頁尾為 20 MiB + 512 位元元組)和 35183298347520 個字節之間(VHD 頁尾為 32 TiB + 512 位元組)。 | int |
DiskSecurityProfile
名字 | 描述 | 價值 |
---|---|---|
secureVMDiskEncryptionSetId | 與以客戶管理金鑰加密的機密 VM 支援的磁碟相關聯的磁碟加密集 ResourceId | 字串 |
securityType | 指定 VM 的 SecurityType。 僅適用於OS磁碟。 | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
加密
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionSetId | 要用於啟用待用加密的磁碟加密集 ResourceId。 | 字串 |
類型 | 用來加密磁碟數據的金鑰類型。 | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
名字 | 描述 | 價值 |
---|---|---|
啟用 | 將此旗標設定為 true,並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。 將此旗標設定為 false,並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。 如果 Request 物件中的 EncryptionSettings 為 Null,則現有的設定會保持不變。 | 布林 (必要) |
encryptionSettings | 加密設定的集合,每個磁碟區各一個。 | EncryptionSettingsElement[] |
encryptionSettingsVersion | 描述磁碟所使用的加密類型。 設定此欄位之後,即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。 | 字串 |
EncryptionSettingsElement
名字 | 描述 | 價值 |
---|---|---|
diskEncryptionKey | 磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼 | KeyVaultAndSecretReference |
keyEncryptionKey | 金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的,而且提供時用來解除包裝磁碟加密密鑰。 | KeyVaultAndKeyReference |
ExtendedLocation
名字 | 描述 | 價值 |
---|---|---|
名字 | 擴充位置的名稱。 | 字串 |
類型 | 擴充位置的類型。 | 'EdgeZone' |
ImageDiskReference
名字 | 描述 | 價值 |
---|---|---|
communityGalleryImageId | 包含社群 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
id | 包含平臺映像存放庫、使用者映像或 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
倫 | 如果磁碟是從映射的數據磁碟建立的,這是一個索引,指出映射中要使用的數據磁碟。 針對OS磁碟,此欄位為 null。 | int |
sharedGalleryImageId | 包含直接共用 Azure 計算資源庫映像參考的相對 URI。 | 字串 |
KeyVaultAndKeyReference
名字 | 描述 | 價值 |
---|---|---|
keyUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
KeyVaultAndSecretReference
名字 | 描述 | 價值 |
---|---|---|
secretUrl | 指向 KeyVault 中金鑰或秘密的 URL | 字串 (必要) |
sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼 | SourceVault (必要) |
Microsoft.Compute/snapshots
名字 | 描述 | 價值 |
---|---|---|
extendedLocation | 將建立快照集的擴充位置。 無法變更擴充位置。 | ExtendedLocation |
位置 | 資源位置 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | 快照集資源屬性。 | SnapshotProperties |
sku | 快照集 SKU 名稱。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 這是增量快照集的選擇性參數,默認行為是SKU將設定為與上一個快照集相同的SKU | SnapshotSku |
標籤 | 資源標籤 | 標記名稱和值的字典。 |
類型 | 資源類型 | “Microsoft.Compute/snapshots@2022-03-02” |
PurchasePlan
名字 | 描述 | 價值 |
---|---|---|
名字 | 方案標識碼。 | 字串 (必要) |
產品 | 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 | 字串 (必要) |
promotionCode | 供應項目促銷碼。 | 字串 |
發行人 | 發行者標識碼。 | 字串 (必要) |
ResourceTags
名字 | 描述 | 價值 |
---|
SnapshotProperties
名字 | 描述 | 價值 |
---|---|---|
completionPercent | 透過 CopyStart 作業建立資源時,背景複製完成的百分比。 | int |
copyCompletionError | 如果透過 CopyStart 作業建立之資源的背景複本失敗,則指出錯誤詳細數據。 | CopyCompletionError |
creationData | 磁碟來源資訊。 建立磁碟之後,無法變更 CreationData 資訊。 | CreationData (必要) |
dataAccessAuthMode | 匯出或上傳至磁碟或快照集時的其他驗證需求。 | 'AzureActiveDirectory' 'None' |
diskAccessId | DiskAccess 資源的 ARM 識別碼,用於在磁碟上使用私人端點。 | 字串 |
diskSizeGB | 如果 creationData.createOption 為 Empty,則此欄位為必要字段,並指出要建立的磁碟大小。 如果此欄位存在以其他選項進行更新或建立,表示重設大小。 只有在磁碟未連結至執行中的 VM 時,才允許重設大小,而且只能增加磁碟的大小。 | int |
加密 | 加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。 | 加密 |
encryptionSettingsCollection | 加密設定集合是 Azure 磁碟加密,可以包含每個磁碟或快照集的多個加密設定。 | EncryptionSettingsCollection |
hyperVGeneration | 虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。 | 'V1' 'V2' |
增量 | 快照集是否為累加式。 相同磁碟上的累加快照集佔用的空間小於完整快照集,而且可能會有差異。 | bool |
networkAccessPolicy | 透過網路存取磁碟的原則。 | 'AllowAll' 'AllowPrivate' 'DenyAll' |
osType | 操作系統類型。 | 'Linux' 'Windows' |
publicNetworkAccess | 控制磁碟上導出的原則。 | 'Disabled' 'Enabled' |
purchasePlan | 最初建立快照集來源磁碟之映像的購買方案資訊。 | PurchasePlan |
securityProfile | 包含資源的安全性相關信息。 | DiskSecurityProfile |
supportedCapabilities | 原始建立快照集來源磁碟的映像支援功能清單。 | SupportedCapabilities |
supportsHibernation | 指出快照集上的OS支援休眠。 | bool |
SnapshotSku
名字 | 描述 | 價值 |
---|---|---|
名字 | SKU 名稱。 | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
名字 | 描述 | 價值 |
---|---|---|
id | 資源標識碼 | 字串 |
SupportedCapabilities
名字 | 描述 | 價值 |
---|---|---|
acceleratedNetwork | 如果建立OS磁碟的映像支援加速網路,則為True。 | bool |
建築 | OS 磁碟支援的CPU架構。 | 'Arm64' 'x64' |