Microsoft.Compute-ögonblicksbilder 2023-01-02
Bicep-resursdefinition
Resurstypen ögonblicksbilder kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Compute/snapshots-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.Compute/snapshots@2023-01-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
}
}
Egenskapsvärden
Ögonblicksbilder
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken, understreck, punkter och bindestreck. Börja med alfanumeriskt. Avsluta med alfanumeriskt eller understreck. |
| plats | Resursplats | sträng (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
| Sku | SKU-namnet för ögonblicksbilder. Kan vara Standard_LRS, Premium_LRS eller Standard_ZRS. Det här är en valfri parameter för inkrementell ögonblicksbild och standardbeteendet är att SKU:n ställs in på samma SKU som föregående ögonblicksbild | SnapshotSku |
| extendedLocation | Den utökade platsen där ögonblicksbilden skapas. Det går inte att ändra den utökade platsen. | ExtendedLocation |
| Egenskaper | Egenskaper för ögonblicksbildresurser. | SnapshotProperties |
ExtendedLocation
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på den utökade platsen. | sträng |
| typ | Typ av utökad plats. | "EdgeZone" |
SnapshotProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| completionPercent | Procent färdigt för bakgrundskopian när en resurs skapas via åtgärden CopyStart. | Int |
| copyCompletionError | Anger felinformationen om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | CopyCompletionError |
| creationData | Information om diskkälla. CreationData-information kan inte ändras när disken har skapats. | CreationData (krävs) |
| dataAccessAuthMode | Ytterligare autentiseringskrav vid export eller uppladdning till en disk eller ögonblicksbild. | "AzureActiveDirectory" "Ingen" |
| diskAccessId | ARM-ID för DiskAccess-resursen för användning av privata slutpunkter på diskar. | sträng |
| diskSizeGB | Om creationData.createOption är Tomt är det här fältet obligatoriskt och anger storleken på disken som ska skapas. Om det här fältet finns för uppdateringar eller skapande med andra alternativ, anger det en storleksändring. Storleksändring tillåts endast om disken inte är ansluten till en virtuell dator som körs och bara kan öka diskens storlek. | Int |
| kryptering | Krypteringsegenskapen kan användas för att kryptera vilande data med kundhanterade nycklar eller plattformshanterade nycklar. | Kryptering |
| encryptionSettingsCollection | Krypteringsinställningar samling som används är Azure Disk Encryption, kan innehålla flera krypteringsinställningar per disk eller ögonblicksbild. | EncryptionSettingsCollection |
| hyperVGeneration | Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar. | "V1" "V2" |
| Inkrementell | Om en ögonblicksbild är inkrementell. Inkrementella ögonblicksbilder på samma disk upptar mindre utrymme än fullständiga ögonblicksbilder och kan avgränsas. | Bool |
| networkAccessPolicy | Princip för åtkomst till disken via nätverk. | "AllowAll" "AllowPrivate" "DenyAll" |
| osType | Typ av operativsystem. | "Linux" "Windows" |
| publicNetworkAccess | Princip för att kontrollera exporten på disken. | "Inaktiverad" "Aktiverad" |
| purchasePlan | Inköpsplansinformation för avbildningen från vilken källdisken för ögonblicksbilden ursprungligen skapades. | PurchasePlan |
| securityProfile | Innehåller säkerhetsrelaterad information för resursen. | DiskSecurityProfile |
| supportedCapabilities | Lista över funktioner som stöds för avbildningen från vilken källdisken från ögonblicksbilden ursprungligen skapades. | SupportedCapabilities |
| supportsHibernation | Anger att operativsystemet på en ögonblicksbild stöder viloläge. | Bool |
CopyCompletionError
| Namn | Beskrivning | Värde |
|---|---|---|
| errorCode | Anger felkoden om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | "CopySourceNotFound" (krävs) |
| errorMessage | Anger felmeddelandet om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | sträng (krävs) |
CreationData
| Namn | Beskrivning | Värde |
|---|---|---|
| createOption | Detta räknar upp möjliga källor för att skapa en disk. | "Bifoga" "Kopiera" "CopyStart" "Tom" "FromImage" "Import" "ImportSecure" "Återställ" "Ladda upp" "UploadPreparedSecure" (krävs) |
| galleryImageReference | Krävs om du skapar från en galleribild. Id/sharedGalleryImageId/communityGalleryImageId för ImageDiskReference är ARM-ID:t för den delade galäravbildningsversionen som du vill skapa en disk från. | ImageDiskReference |
| imageReference | Information om diskkälla för PIR- eller användarbilder. | ImageDiskReference |
| logicalSectorSize | Logisk sektorstorlek i byte för Ultra-diskar. Värden som stöds är 512 ad 4096. 4096 är standardvärdet. | Int |
| performancePlus | Ange den här flaggan till true för att få en ökning av prestandamålet för den distribuerade disken, se här på respektive prestandamål. Den här flaggan kan bara anges när disken skapas och kan inte inaktiveras när den har aktiverats. | Bool |
| securityDataUri | Om createOption är ImportSecure är detta URI för en blob som ska importeras till vm-gästtillstånd. | sträng |
| sourceResourceId | Om createOption är Copy är detta ARM-ID för källögonblicksbilden eller disken. | sträng |
| sourceUri | Om createOption är Import är detta URI för en blob som ska importeras till en hanterad disk. | sträng |
| storageAccountId | Krävs om createOption är Import. Azure Resource Manager-identifieraren för lagringskontot som innehåller bloben som ska importeras som en disk. | sträng |
| uploadSizeBytes | Om createOption är Upload är det här storleken på innehållet i uppladdningen, inklusive VHD-sidfoten. Det här värdet ska vara mellan 20972032 (20 MiB + 512 byte för VHD-sidfoten) och 35183298347520 byte (32 TiB + 512 byte för VHD-sidfoten). | Int |
ImageDiskReference
| Namn | Beskrivning | Värde |
|---|---|---|
| communityGalleryImageId | En relativ URI som innehåller en azure compute gallery-avbildningsreferens för communityn. | sträng |
| Id | En relativ URI som innehåller antingen en plattformsbildlagringsplats, användarbild eller en bildreferens för Azure Compute Gallery. | sträng |
| Lun | Om disken skapas från en avbildnings datadisk är detta ett index som anger vilken av datadiskarna i avbildningen som ska användas. För OS-diskar är det här fältet null. | Int |
| sharedGalleryImageId | En relativ URI som innehåller en direkt delad Bildreferens för Azure Compute Gallery. | sträng |
Kryptering
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som ska användas för att aktivera kryptering i vila. | sträng |
| typ | Den typ av nyckel som används för att kryptera diskens data. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
| Namn | Beskrivning | Värde |
|---|---|---|
| Aktiverat | Ange den här flaggan till true och ange DiskEncryptionKey och valfri KeyEncryptionKey för att aktivera kryptering. Ange den här flaggan till false och ta bort DiskEncryptionKey och KeyEncryptionKey för att inaktivera kryptering. Om EncryptionSettings är null i begärandeobjektet förblir de befintliga inställningarna oförändrade. | bool (krävs) |
| encryptionSettings | En samling krypteringsinställningar, en för varje diskvolym. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beskriver vilken typ av kryptering som används för diskarna. När det här fältet har angetts kan det inte skrivas över. "1.0" motsvarar Azure Disk Encryption med AAD-appen.'1.1' motsvarar Azure Disk Encryption. | sträng |
EncryptionSettingsElement
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionKey | Nyckelvalvshemlighets-URL och valv-ID för diskkrypteringsnyckeln | KeyVaultAndSecretReference |
| keyEncryptionKey | Key Vault-nyckel-URL och valv-ID för nyckelkrypteringsnyckeln. KeyEncryptionKey är valfritt och när det tillhandahålls används för att packa upp diskkrypteringsnyckeln. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| Namn | Beskrivning | Värde |
|---|---|---|
| secretUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
SourceVault
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Resurs-ID | sträng |
KeyVaultAndKeyReference
| Namn | Beskrivning | Värde |
|---|---|---|
| keyUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
PurchasePlan
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Plan-ID:t. | sträng (krävs) |
| produkt | Anger produkten av avbildningen från marketplace. Det här är samma värde som Erbjudandet under elementet imageReference. | sträng (krävs) |
| promotionCode | Erbjudandehöjningskoden. | sträng |
| förläggare | Utgivarens ID. | sträng (krävs) |
DiskSecurityProfile
| Namn | Beskrivning | Värde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som är associerad med konfidentiell virtuell dator som stöds disk krypterad med kundhanterad nyckel | sträng |
| securityType | Anger SecurityType för den virtuella datorn. Gäller endast för OS-diskar. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
| Namn | Beskrivning | Värde |
|---|---|---|
| acceleratedNetwork | Sant om avbildningen som OS-disken skapas från har stöd för accelererat nätverk. | Bool |
| arkitektur | CPU-arkitektur som stöds av en OS-disk. | "Arm64" "x64" |
| diskControllerTypes | De diskkontrollanter som en OS-disk stöder. Om den ställs in kan den vara SCSI eller SCSI, NVME eller NVME, SCSI. | sträng |
SnapshotSku
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | SKU-namnet. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Resursdefinition för ARM-mall
Resurstypen ögonblicksbilder kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Compute/snapshots-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2023-01-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"
}
}
Egenskapsvärden
Ögonblicksbilder
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Compute/snapshots" |
| apiVersion | Resurs-API-versionen | '2023-01-02' |
| Namn | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken, understreck, punkter och bindestreck. Börja med alfanumeriskt. Avsluta med alfanumeriskt eller understreck. |
| plats | Resursplats | sträng (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
| Sku | SKU-namnet för ögonblicksbilder. Kan vara Standard_LRS, Premium_LRS eller Standard_ZRS. Det här är en valfri parameter för inkrementell ögonblicksbild och standardbeteendet är att SKU:n ställs in på samma SKU som föregående ögonblicksbild | SnapshotSku |
| extendedLocation | Den utökade platsen där ögonblicksbilden skapas. Det går inte att ändra den utökade platsen. | ExtendedLocation |
| Egenskaper | Egenskaper för ögonblicksbildresurser. | SnapshotProperties |
ExtendedLocation
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på den utökade platsen. | sträng |
| typ | Typ av utökad plats. | "EdgeZone" |
SnapshotProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| completionPercent | Procent färdigt för bakgrundskopian när en resurs skapas via åtgärden CopyStart. | Int |
| copyCompletionError | Anger felinformationen om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | CopyCompletionError |
| creationData | Information om diskkälla. CreationData-information kan inte ändras när disken har skapats. | CreationData (krävs) |
| dataAccessAuthMode | Ytterligare autentiseringskrav vid export eller uppladdning till en disk eller ögonblicksbild. | "AzureActiveDirectory" "Ingen" |
| diskAccessId | ARM-ID för DiskAccess-resursen för användning av privata slutpunkter på diskar. | sträng |
| diskSizeGB | Om creationData.createOption är Tomt är det här fältet obligatoriskt och anger storleken på disken som ska skapas. Om det här fältet finns för uppdateringar eller skapande med andra alternativ, anger det en storleksändring. Storleksändring tillåts endast om disken inte är ansluten till en virtuell dator som körs och bara kan öka diskens storlek. | Int |
| kryptering | Krypteringsegenskapen kan användas för att kryptera vilande data med kundhanterade nycklar eller plattformshanterade nycklar. | Kryptering |
| encryptionSettingsCollection | Krypteringsinställningar samling som används är Azure Disk Encryption, kan innehålla flera krypteringsinställningar per disk eller ögonblicksbild. | EncryptionSettingsCollection |
| hyperVGeneration | Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar. | "V1" "V2" |
| Inkrementell | Om en ögonblicksbild är inkrementell. Inkrementella ögonblicksbilder på samma disk upptar mindre utrymme än fullständiga ögonblicksbilder och kan avgränsas. | Bool |
| networkAccessPolicy | Princip för åtkomst till disken via nätverk. | "AllowAll" "AllowPrivate" "DenyAll" |
| osType | Typ av operativsystem. | "Linux" "Windows" |
| publicNetworkAccess | Princip för att kontrollera exporten på disken. | "Inaktiverad" "Aktiverad" |
| purchasePlan | Inköpsplansinformation för avbildningen från vilken källdisken för ögonblicksbilden ursprungligen skapades. | PurchasePlan |
| securityProfile | Innehåller säkerhetsrelaterad information för resursen. | DiskSecurityProfile |
| supportedCapabilities | Lista över funktioner som stöds för avbildningen från vilken källdisken från ögonblicksbilden ursprungligen skapades. | SupportedCapabilities |
| supportsHibernation | Anger att operativsystemet på en ögonblicksbild stöder viloläge. | Bool |
CopyCompletionError
| Namn | Beskrivning | Värde |
|---|---|---|
| errorCode | Anger felkoden om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | "CopySourceNotFound" (krävs) |
| errorMessage | Anger felmeddelandet om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | sträng (krävs) |
CreationData
| Namn | Beskrivning | Värde |
|---|---|---|
| createOption | Detta räknar upp möjliga källor för att skapa en disk. | "Bifoga" "Kopiera" "CopyStart" "Tom" "FromImage" "Import" "ImportSecure" "Återställ" "Ladda upp" "UploadPreparedSecure" (krävs) |
| galleryImageReference | Krävs om du skapar från en galleribild. Id/sharedGalleryImageId/communityGalleryImageId för ImageDiskReference är ARM-ID:t för den delade galäravbildningsversionen som du vill skapa en disk från. | ImageDiskReference |
| imageReference | Information om diskkälla för PIR- eller användarbilder. | ImageDiskReference |
| logicalSectorSize | Logisk sektorstorlek i byte för Ultra-diskar. Värden som stöds är 512 ad 4096. 4096 är standardvärdet. | Int |
| performancePlus | Ange den här flaggan till true för att få en ökning av prestandamålet för den distribuerade disken, se här på respektive prestandamål. Den här flaggan kan bara anges när disken skapas och kan inte inaktiveras när den har aktiverats. | Bool |
| securityDataUri | Om createOption är ImportSecure är detta URI för en blob som ska importeras till vm-gästtillstånd. | sträng |
| sourceResourceId | Om createOption är Copy är detta ARM-ID för källögonblicksbilden eller disken. | sträng |
| sourceUri | Om createOption är Import är detta URI för en blob som ska importeras till en hanterad disk. | sträng |
| storageAccountId | Krävs om createOption är Import. Azure Resource Manager-identifieraren för lagringskontot som innehåller bloben som ska importeras som en disk. | sträng |
| uploadSizeBytes | Om createOption är Upload är det här storleken på innehållet i uppladdningen, inklusive VHD-sidfoten. Det här värdet ska vara mellan 20972032 (20 MiB + 512 byte för VHD-sidfoten) och 35183298347520 byte (32 TiB + 512 byte för VHD-sidfoten). | Int |
ImageDiskReference
| Namn | Beskrivning | Värde |
|---|---|---|
| communityGalleryImageId | En relativ URI som innehåller en azure compute gallery-avbildningsreferens för communityn. | sträng |
| Id | En relativ URI som innehåller antingen en plattformsbildlagringsplats, användarbild eller en bildreferens för Azure Compute Gallery. | sträng |
| Lun | Om disken skapas från en avbildnings datadisk är detta ett index som anger vilken av datadiskarna i avbildningen som ska användas. För OS-diskar är det här fältet null. | Int |
| sharedGalleryImageId | En relativ URI som innehåller en direkt delad Bildreferens för Azure Compute Gallery. | sträng |
Kryptering
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som ska användas för att aktivera kryptering i vila. | sträng |
| typ | Den typ av nyckel som används för att kryptera diskens data. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
| Namn | Beskrivning | Värde |
|---|---|---|
| Aktiverat | Ange den här flaggan till true och ange DiskEncryptionKey och valfri KeyEncryptionKey för att aktivera kryptering. Ange den här flaggan till false och ta bort DiskEncryptionKey och KeyEncryptionKey för att inaktivera kryptering. Om EncryptionSettings är null i begärandeobjektet förblir de befintliga inställningarna oförändrade. | bool (krävs) |
| encryptionSettings | En samling krypteringsinställningar, en för varje diskvolym. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beskriver vilken typ av kryptering som används för diskarna. När det här fältet har angetts kan det inte skrivas över. "1.0" motsvarar Azure Disk Encryption med AAD-appen.'1.1' motsvarar Azure Disk Encryption. | sträng |
EncryptionSettingsElement
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionKey | Nyckelvalvshemlighets-URL och valv-ID för diskkrypteringsnyckeln | KeyVaultAndSecretReference |
| keyEncryptionKey | Key Vault-nyckel-URL och valv-ID för nyckelkrypteringsnyckeln. KeyEncryptionKey är valfritt och när det tillhandahålls används för att packa upp diskkrypteringsnyckeln. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| Namn | Beskrivning | Värde |
|---|---|---|
| secretUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
SourceVault
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Resurs-ID | sträng |
KeyVaultAndKeyReference
| Namn | Beskrivning | Värde |
|---|---|---|
| keyUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
PurchasePlan
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Plan-ID:t. | sträng (krävs) |
| produkt | Anger produkten av avbildningen från marketplace. Det här är samma värde som Erbjudandet under elementet imageReference. | sträng (krävs) |
| promotionCode | Erbjudandehöjningskoden. | sträng |
| förläggare | Utgivarens ID. | sträng (krävs) |
DiskSecurityProfile
| Namn | Beskrivning | Värde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som är associerad med konfidentiell virtuell dator som stöds disk krypterad med kundhanterad nyckel | sträng |
| securityType | Anger SecurityType för den virtuella datorn. Gäller endast för OS-diskar. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
| Namn | Beskrivning | Värde |
|---|---|---|
| acceleratedNetwork | Sant om avbildningen som OS-disken skapas från har stöd för accelererat nätverk. | Bool |
| arkitektur | CPU-arkitektur som stöds av en OS-disk. | "Arm64" "x64" |
| diskControllerTypes | De diskkontrollanter som en OS-disk stöder. Om den ställs in kan den vara SCSI eller SCSI, NVME eller NVME, SCSI. | sträng |
SnapshotSku
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | SKU-namnet. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen ögonblicksbilder kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Compute/snapshots-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2023-01-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"
}
})
}
Egenskapsvärden
Ögonblicksbilder
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Compute/snapshots@2023-01-02" |
| Namn | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken, understreck, punkter och bindestreck. Börja med alfanumeriskt. Avsluta med alfanumeriskt eller understreck. |
| plats | Resursplats | sträng (krävs) |
| parent_id | Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. | sträng (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
| Sku | SKU-namnet för ögonblicksbilder. Kan vara Standard_LRS, Premium_LRS eller Standard_ZRS. Det här är en valfri parameter för inkrementell ögonblicksbild och standardbeteendet är att SKU:n ställs in på samma SKU som föregående ögonblicksbild | SnapshotSku |
| extendedLocation | Den utökade platsen där ögonblicksbilden skapas. Det går inte att ändra den utökade platsen. | ExtendedLocation |
| Egenskaper | Egenskaper för ögonblicksbildresurser. | SnapshotProperties |
ExtendedLocation
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på den utökade platsen. | sträng |
| typ | Typ av utökad plats. | "EdgeZone" |
SnapshotProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| completionPercent | Procent färdigt för bakgrundskopian när en resurs skapas via åtgärden CopyStart. | Int |
| copyCompletionError | Anger felinformationen om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | CopyCompletionError |
| creationData | Information om diskkälla. CreationData-information kan inte ändras när disken har skapats. | CreationData (krävs) |
| dataAccessAuthMode | Ytterligare autentiseringskrav vid export eller uppladdning till en disk eller ögonblicksbild. | "AzureActiveDirectory" "Ingen" |
| diskAccessId | ARM-ID för DiskAccess-resursen för användning av privata slutpunkter på diskar. | sträng |
| diskSizeGB | Om creationData.createOption är Tomt är det här fältet obligatoriskt och anger storleken på disken som ska skapas. Om det här fältet finns för uppdateringar eller skapande med andra alternativ, anger det en storleksändring. Storleksändring tillåts endast om disken inte är ansluten till en virtuell dator som körs och bara kan öka diskens storlek. | Int |
| kryptering | Krypteringsegenskapen kan användas för att kryptera vilande data med kundhanterade nycklar eller plattformshanterade nycklar. | Kryptering |
| encryptionSettingsCollection | Krypteringsinställningar samling som används är Azure Disk Encryption, kan innehålla flera krypteringsinställningar per disk eller ögonblicksbild. | EncryptionSettingsCollection |
| hyperVGeneration | Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar. | "V1" "V2" |
| Inkrementell | Om en ögonblicksbild är inkrementell. Inkrementella ögonblicksbilder på samma disk upptar mindre utrymme än fullständiga ögonblicksbilder och kan avgränsas. | Bool |
| networkAccessPolicy | Princip för åtkomst till disken via nätverk. | "AllowAll" "AllowPrivate" "DenyAll" |
| osType | Typ av operativsystem. | "Linux" "Windows" |
| publicNetworkAccess | Princip för att kontrollera exporten på disken. | "Inaktiverad" "Aktiverad" |
| purchasePlan | Inköpsplansinformation för avbildningen från vilken källdisken för ögonblicksbilden ursprungligen skapades. | PurchasePlan |
| securityProfile | Innehåller säkerhetsrelaterad information för resursen. | DiskSecurityProfile |
| supportedCapabilities | Lista över funktioner som stöds för avbildningen från vilken källdisken från ögonblicksbilden ursprungligen skapades. | SupportedCapabilities |
| supportsHibernation | Anger att operativsystemet på en ögonblicksbild stöder viloläge. | Bool |
CopyCompletionError
| Namn | Beskrivning | Värde |
|---|---|---|
| errorCode | Anger felkoden om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | "CopySourceNotFound" (krävs) |
| errorMessage | Anger felmeddelandet om bakgrundskopian av en resurs som skapats via åtgärden CopyStart misslyckas. | sträng (krävs) |
CreationData
| Namn | Beskrivning | Värde |
|---|---|---|
| createOption | Detta räknar upp möjliga källor för att skapa en disk. | "Bifoga" "Kopiera" "CopyStart" "Tom" "FromImage" "Importera" "ImportSecure" "Återställ" "Ladda upp" "UploadPreparedSecure" (krävs) |
| galleryImageReference | Krävs om du skapar från en galleribild. Id/sharedGalleryImageId/communityGalleryImageId för ImageDiskReference är ARM-ID:t för den delade galäravbildningsversionen som du vill skapa en disk från. | ImageDiskReference |
| imageReference | Information om diskkälla för PIR- eller användarbilder. | ImageDiskReference |
| logicalSectorSize | Logisk sektorstorlek i byte för Ultra-diskar. Värden som stöds är 512 ad 4096. 4096 är standardvärdet. | Int |
| performancePlus | Ange den här flaggan till true för att få en ökning av prestandamålet för den distribuerade disken, se här på respektive prestandamål. Den här flaggan kan bara anges när disken skapas och kan inte inaktiveras när den har aktiverats. | Bool |
| securityDataUri | Om createOption är ImportSecure är detta URI för en blob som ska importeras till vm-gästtillstånd. | sträng |
| sourceResourceId | Om createOption är Copy är detta ARM-ID för källögonblicksbilden eller disken. | sträng |
| sourceUri | Om createOption är Import är detta URI för en blob som ska importeras till en hanterad disk. | sträng |
| storageAccountId | Krävs om createOption är Import. Azure Resource Manager-identifieraren för lagringskontot som innehåller bloben som ska importeras som en disk. | sträng |
| uploadSizeBytes | Om createOption är Upload är det här storleken på innehållet i uppladdningen, inklusive VHD-sidfoten. Det här värdet ska vara mellan 20972032 (20 MiB + 512 byte för VHD-sidfoten) och 35183298347520 byte (32 TiB + 512 byte för VHD-sidfoten). | Int |
ImageDiskReference
| Namn | Beskrivning | Värde |
|---|---|---|
| communityGalleryImageId | En relativ URI som innehåller en azure compute gallery-avbildningsreferens för communityn. | sträng |
| Id | En relativ URI som innehåller antingen en plattformsbildlagringsplats, användarbild eller en bildreferens för Azure Compute Gallery. | sträng |
| Lun | Om disken skapas från en avbildnings datadisk är detta ett index som anger vilken av datadiskarna i avbildningen som ska användas. För OS-diskar är det här fältet null. | Int |
| sharedGalleryImageId | En relativ URI som innehåller en direkt delad Bildreferens för Azure Compute Gallery. | sträng |
Kryptering
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som ska användas för att aktivera kryptering i vila. | sträng |
| typ | Den typ av nyckel som används för att kryptera diskens data. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
| Namn | Beskrivning | Värde |
|---|---|---|
| Aktiverat | Ange den här flaggan till true och ange DiskEncryptionKey och valfri KeyEncryptionKey för att aktivera kryptering. Ange den här flaggan till false och ta bort DiskEncryptionKey och KeyEncryptionKey för att inaktivera kryptering. Om EncryptionSettings är null i begärandeobjektet förblir de befintliga inställningarna oförändrade. | bool (krävs) |
| encryptionSettings | En samling krypteringsinställningar, en för varje diskvolym. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beskriver vilken typ av kryptering som används för diskarna. När det här fältet har angetts kan det inte skrivas över. "1.0" motsvarar Azure Disk Encryption med AAD-appen.'1.1' motsvarar Azure Disk Encryption. | sträng |
EncryptionSettingsElement
| Namn | Beskrivning | Värde |
|---|---|---|
| diskEncryptionKey | Nyckelvalvshemlighets-URL och valv-ID för diskkrypteringsnyckeln | KeyVaultAndSecretReference |
| keyEncryptionKey | Key Vault-nyckel-URL och valv-ID för nyckelkrypteringsnyckeln. KeyEncryptionKey är valfritt och när det tillhandahålls används för att packa upp diskkrypteringsnyckeln. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
| Namn | Beskrivning | Värde |
|---|---|---|
| secretUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
SourceVault
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | Resurs-ID | sträng |
KeyVaultAndKeyReference
| Namn | Beskrivning | Värde |
|---|---|---|
| keyUrl | Url som pekar på en nyckel eller hemlighet i KeyVault | sträng (krävs) |
| sourceVault | Resurs-ID för KeyVault som innehåller nyckeln eller hemligheten | SourceVault- (krävs) |
PurchasePlan
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Plan-ID:t. | sträng (krävs) |
| produkt | Anger produkten av avbildningen från marketplace. Det här är samma värde som Erbjudandet under elementet imageReference. | sträng (krävs) |
| promotionCode | Erbjudandehöjningskoden. | sträng |
| förläggare | Utgivarens ID. | sträng (krävs) |
DiskSecurityProfile
| Namn | Beskrivning | Värde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId för diskkrypteringsuppsättningen som är associerad med konfidentiell virtuell dator som stöds disk krypterad med kundhanterad nyckel | sträng |
| securityType | Anger SecurityType för den virtuella datorn. Gäller endast för OS-diskar. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
| Namn | Beskrivning | Värde |
|---|---|---|
| acceleratedNetwork | Sant om avbildningen som OS-disken skapas från har stöd för accelererat nätverk. | Bool |
| arkitektur | CPU-arkitektur som stöds av en OS-disk. | "Arm64" "x64" |
| diskControllerTypes | De diskkontrollanter som en OS-disk stöder. Om den ställs in kan den vara SCSI eller SCSI, NVME eller NVME, SCSI. | sträng |
SnapshotSku
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | SKU-namnet. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |