Microsoft.Compute-momentopnamen 2023-01-02
Bicep-resourcedefinitie
Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource voor Microsoft.Compute/snapshots wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Compute/snapshots@2023-01-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
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'
}
tags: {
{customized property}: 'string'
}
}
Eigenschapswaarden
CopyCompletionError
| Naam | Beschrijving | Waarde |
|---|---|---|
| errorCode | Geeft de foutcode aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | 'CopySourceNotFound' (vereist) |
| errorMessage | Geeft het foutbericht aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | tekenreeks (vereist) |
CreationData
| Naam | Beschrijving | Waarde |
|---|---|---|
| createOption | Hiermee worden de mogelijke bronnen van het maken van een schijf opgesomd. | 'Bijvoegen' 'Kopiëren' 'CopyStart' 'Leeg' 'FromImage' 'Importeren' 'ImportSecure' 'Herstellen' 'Uploaden' 'UploadPreparedSecure' (vereist) |
| galleryImageReference | Vereist als u een galerie-installatiekopieën maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde kombuisinstallatiekopie waaruit een schijf moet worden gemaakt. | ImageDiskReference- |
| imageReference | Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. | ImageDiskReference- |
| logicalSectorSize | Grootte van logische sector in bytes voor Ultra-schijven. Ondersteunde waarden zijn 512 ad 4096. 4096 is de standaardwaarde. | Int |
| performancePlus | Stel deze vlag in op True om een boost te krijgen op het prestatiedoel van de schijf die is geïmplementeerd, zie hier over het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld op de aanmaaktijd van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. | Bool |
| securityDataUri | Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de gaststatus van de VM. | snaar |
| sourceResourceId | Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. | snaar |
| sourceUri | Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. | snaar |
| storageAccountId | Vereist als createOption import is. De Azure Resource Manager-id van het opslagaccount met de blob die moet worden geïmporteerd als een schijf. | snaar |
| uploadSizeBytes | Als createOption Upload is, is dit de grootte van de inhoud van de upload, inclusief de VHD-voettekst. Deze waarde moet tussen 20972032 (20 MiB + 512 bytes voor de VHD-voettekst) en 35183298347520 bytes (32 TiB + 512 bytes voor de VHD-voettekst). | Int |
DiskSecurityProfile
| Naam | Beschrijving | Waarde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf die is versleuteld met een door de klant beheerde sleutel | snaar |
| securityType | Hiermee geeft u het SecurityType van de VIRTUELE machine. Alleen van toepassing op besturingssysteemschijven. | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
Codering
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionSetId | ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. | snaar |
| type | Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Stel deze vlag in op true en geef DiskEncryptionKey en optionele KeyEncryptionKey op om versleuteling in te schakelen. Stel deze vlag in op false en verwijder DiskEncryptionKey en KeyEncryptionKey om versleuteling uit te schakelen. Als EncryptionSettings null is in het aanvraagobject, blijven de bestaande instellingen ongewijzigd. | bool (vereist) |
| encryptionSettings | Een verzameling versleutelingsinstellingen, één voor elk schijfvolume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beschrijft welk type versleuteling wordt gebruikt voor de schijven. Zodra dit veld is ingesteld, kan het niet worden overschreven. '1.0' komt overeen met Azure Disk Encryption met de AAD-app.'1.1' komt overeen met Azure Disk Encryption. | snaar |
EncryptionSettingsElement
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionKey | Key Vault Geheime URL en kluis-id van de schijfversleutelingssleutel | KeyVaultAndSecretReference- |
| keyEncryptionKey | Key Vault-sleutel-URL en kluis-id van de sleutelversleutelingssleutel. KeyEncryptionKey is optioneel en wanneer deze wordt opgegeven, wordt gebruikt om de schijfversleutelingssleutel uit te pakken. | KeyVaultAndKeyReference- |
ExtendedLocation
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De naam van de uitgebreide locatie. | snaar |
| type | Het type van de uitgebreide locatie. | 'EdgeZone' |
ImageDiskReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| communityGalleryImageId | Een relatieve URI met een azure Compute Gallery-installatiekopiereferentie voor de community. | snaar |
| legitimatiebewijs | Een relatieve URI met een opslagplaats voor platforminstallatiekopieën, een gebruikersinstallatiekopie of een azure Compute Gallery-installatiekopie. | snaar |
| Lun | Als de schijf wordt gemaakt op basis van de gegevensschijf van een installatiekopieën, is dit een index die aangeeft welke van de gegevensschijven in de installatiekopieën moeten worden gebruikt. Voor besturingssysteemschijven is dit veld null. | Int |
| sharedGalleryImageId | Een relatieve URI met een direct gedeelde Azure Compute Gallery-installatiekopiereferentie. | snaar |
KeyVaultAndKeyReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| keyUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
KeyVaultAndSecretReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| secretUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
Microsoft.Compute/momentopnamen
| Naam | Beschrijving | Waarde |
|---|---|---|
| extendedLocation | De uitgebreide locatie waar de momentopname wordt gemaakt. De uitgebreide locatie kan niet worden gewijzigd. | ExtendedLocation- |
| plaats | Resourcelocatie | tekenreeks (vereist) |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van momentopnameresources. | SnapshotProperties- |
| Sku | De SKU-naam van de momentopnamen. Kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopnamen en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde sKU als de vorige momentopname | SnapshotSku |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
PurchasePlan
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De plan-id. | tekenreeks (vereist) |
| product | Hiermee geeft u het product van de installatiekopieën van de marketplace. Dit is dezelfde waarde als Offer onder het element imageReference. | tekenreeks (vereist) |
| promotionCode | De aanbiedingspromotiecode. | snaar |
| uitgever | De uitgever-id. | tekenreeks (vereist) |
ResourceTags
| Naam | Beschrijving | Waarde |
|---|
SnapshotProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| completionPercent | Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de kopieerbewerking. | Int |
| copyCompletionError | Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | CopyCompletionError- |
| creationData | Informatie over de schijfbron. CreationData-gegevens kunnen niet worden gewijzigd nadat de schijf is gemaakt. | CreationData- (vereist) |
| dataAccessAuthMode | Aanvullende verificatievereisten bij het exporteren of uploaden naar een schijf of momentopname. | 'AzureActiveDirectory' 'Geen' |
| diskAccessId | ARM-id van de DiskAccess-resource voor het gebruik van privé-eindpunten op schijven. | snaar |
| diskSizeGB | Als creationData.createOption leeg is, is dit veld verplicht en wordt de grootte van de schijf aangegeven die moet worden gemaakt. Als dit veld aanwezig is voor updates of het maken met andere opties, wordt het formaat aangegeven. Grootten zijn alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en alleen de grootte van de schijf kan vergroten. | Int |
| Codering | Versleutelingseigenschap kan worden gebruikt voor het versleutelen van data-at-rest met door de klant beheerde sleutels of door het platform beheerde sleutels. | versleuteling |
| encryptionSettingsCollection | Verzameling versleutelingsinstellingen die worden gebruikt voor Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. | EncryptionSettingsCollection- |
| hyperVGeneratie | De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven. | 'V1' 'V2' |
| Incrementele | Of een momentopname incrementeel is. Incrementele momentopnamen op dezelfde schijf nemen minder ruimte in beslag dan volledige momentopnamen en kunnen worden gesynchroniseerd. | Bool |
| networkAccessPolicy | Beleid voor toegang tot de schijf via het netwerk. | 'AllowAll' AllowPrivate 'DenyAll' |
| osType | Het type besturingssysteem. | 'Linux' 'Windows' |
| publicNetworkAccess | Beleid voor het beheren van export op de schijf. | 'Uitgeschakeld' 'Ingeschakeld' |
| purchasePlan | Aankoopplangegevens voor de installatiekopie van waaruit de bronschijf voor de momentopname oorspronkelijk is gemaakt. | PurchasePlan- |
| securityProfile | Bevat de beveiligingsgerelateerde informatie voor de resource. | DiskSecurityProfile |
| supportedCapabilities | Lijst met ondersteunde mogelijkheden voor de installatiekopie waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. | SupportedCapabilities |
| supportsHibernation | Geeft aan dat het besturingssysteem op een momentopname de sluimerstand ondersteunt. | Bool |
SnapshotSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De SKU-naam. | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
| Naam | Beschrijving | Waarde |
|---|---|---|
| legitimatiebewijs | Resource-id | snaar |
SupportedCapabilities
| Naam | Beschrijving | Waarde |
|---|---|---|
| acceleratedNetwork | Is waar als de installatiekopieën van waaruit de besturingssysteemschijf wordt gemaakt, ondersteuning bieden voor versneld netwerken. | Bool |
| architectuur | CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. | 'Arm64' 'x64' |
| diskControllerTypes | De schijfcontrollers die een besturingssysteemschijf ondersteunt. Als deze is ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. | snaar |
Resourcedefinitie van ARM-sjabloon
Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Compute/snapshots-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2023-01-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",
"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"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschapswaarden
CopyCompletionError
| Naam | Beschrijving | Waarde |
|---|---|---|
| errorCode | Geeft de foutcode aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | 'CopySourceNotFound' (vereist) |
| errorMessage | Geeft het foutbericht aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | tekenreeks (vereist) |
CreationData
| Naam | Beschrijving | Waarde |
|---|---|---|
| createOption | Hiermee worden de mogelijke bronnen van het maken van een schijf opgesomd. | 'Bijvoegen' 'Kopiëren' 'CopyStart' 'Leeg' 'FromImage' 'Importeren' 'ImportSecure' 'Herstellen' 'Uploaden' 'UploadPreparedSecure' (vereist) |
| galleryImageReference | Vereist als u een galerie-installatiekopieën maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde kombuisinstallatiekopie waaruit een schijf moet worden gemaakt. | ImageDiskReference- |
| imageReference | Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. | ImageDiskReference- |
| logicalSectorSize | Grootte van logische sector in bytes voor Ultra-schijven. Ondersteunde waarden zijn 512 ad 4096. 4096 is de standaardwaarde. | Int |
| performancePlus | Stel deze vlag in op True om een boost te krijgen op het prestatiedoel van de schijf die is geïmplementeerd, zie hier over het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld op de aanmaaktijd van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. | Bool |
| securityDataUri | Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de gaststatus van de VM. | snaar |
| sourceResourceId | Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. | snaar |
| sourceUri | Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. | snaar |
| storageAccountId | Vereist als createOption import is. De Azure Resource Manager-id van het opslagaccount met de blob die moet worden geïmporteerd als een schijf. | snaar |
| uploadSizeBytes | Als createOption Upload is, is dit de grootte van de inhoud van de upload, inclusief de VHD-voettekst. Deze waarde moet tussen 20972032 (20 MiB + 512 bytes voor de VHD-voettekst) en 35183298347520 bytes (32 TiB + 512 bytes voor de VHD-voettekst). | Int |
DiskSecurityProfile
| Naam | Beschrijving | Waarde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf die is versleuteld met een door de klant beheerde sleutel | snaar |
| securityType | Hiermee geeft u het SecurityType van de VIRTUELE machine. Alleen van toepassing op besturingssysteemschijven. | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
Codering
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionSetId | ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. | snaar |
| type | Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Stel deze vlag in op true en geef DiskEncryptionKey en optionele KeyEncryptionKey op om versleuteling in te schakelen. Stel deze vlag in op false en verwijder DiskEncryptionKey en KeyEncryptionKey om versleuteling uit te schakelen. Als EncryptionSettings null is in het aanvraagobject, blijven de bestaande instellingen ongewijzigd. | bool (vereist) |
| encryptionSettings | Een verzameling versleutelingsinstellingen, één voor elk schijfvolume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beschrijft welk type versleuteling wordt gebruikt voor de schijven. Zodra dit veld is ingesteld, kan het niet worden overschreven. '1.0' komt overeen met Azure Disk Encryption met de AAD-app.'1.1' komt overeen met Azure Disk Encryption. | snaar |
EncryptionSettingsElement
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionKey | Key Vault Geheime URL en kluis-id van de schijfversleutelingssleutel | KeyVaultAndSecretReference- |
| keyEncryptionKey | Key Vault-sleutel-URL en kluis-id van de sleutelversleutelingssleutel. KeyEncryptionKey is optioneel en wanneer deze wordt opgegeven, wordt gebruikt om de schijfversleutelingssleutel uit te pakken. | KeyVaultAndKeyReference- |
ExtendedLocation
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De naam van de uitgebreide locatie. | snaar |
| type | Het type van de uitgebreide locatie. | 'EdgeZone' |
ImageDiskReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| communityGalleryImageId | Een relatieve URI met een azure Compute Gallery-installatiekopiereferentie voor de community. | snaar |
| legitimatiebewijs | Een relatieve URI met een opslagplaats voor platforminstallatiekopieën, een gebruikersinstallatiekopie of een azure Compute Gallery-installatiekopie. | snaar |
| Lun | Als de schijf wordt gemaakt op basis van de gegevensschijf van een installatiekopieën, is dit een index die aangeeft welke van de gegevensschijven in de installatiekopieën moeten worden gebruikt. Voor besturingssysteemschijven is dit veld null. | Int |
| sharedGalleryImageId | Een relatieve URI met een direct gedeelde Azure Compute Gallery-installatiekopiereferentie. | snaar |
KeyVaultAndKeyReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| keyUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
KeyVaultAndSecretReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| secretUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
Microsoft.Compute/momentopnamen
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2023-01-02' |
| extendedLocation | De uitgebreide locatie waar de momentopname wordt gemaakt. De uitgebreide locatie kan niet worden gewijzigd. | ExtendedLocation- |
| plaats | Resourcelocatie | tekenreeks (vereist) |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van momentopnameresources. | SnapshotProperties- |
| Sku | De SKU-naam van de momentopnamen. Kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopnamen en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde sKU als de vorige momentopname | SnapshotSku |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| type | Het resourcetype | 'Microsoft.Compute/snapshots' |
PurchasePlan
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De plan-id. | tekenreeks (vereist) |
| product | Hiermee geeft u het product van de installatiekopieën van de marketplace. Dit is dezelfde waarde als Offer onder het element imageReference. | tekenreeks (vereist) |
| promotionCode | De aanbiedingspromotiecode. | snaar |
| uitgever | De uitgever-id. | tekenreeks (vereist) |
ResourceTags
| Naam | Beschrijving | Waarde |
|---|
SnapshotProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| completionPercent | Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de kopieerbewerking. | Int |
| copyCompletionError | Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | CopyCompletionError- |
| creationData | Informatie over de schijfbron. CreationData-gegevens kunnen niet worden gewijzigd nadat de schijf is gemaakt. | CreationData- (vereist) |
| dataAccessAuthMode | Aanvullende verificatievereisten bij het exporteren of uploaden naar een schijf of momentopname. | 'AzureActiveDirectory' 'Geen' |
| diskAccessId | ARM-id van de DiskAccess-resource voor het gebruik van privé-eindpunten op schijven. | snaar |
| diskSizeGB | Als creationData.createOption leeg is, is dit veld verplicht en wordt de grootte van de schijf aangegeven die moet worden gemaakt. Als dit veld aanwezig is voor updates of het maken met andere opties, wordt het formaat aangegeven. Grootten zijn alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en alleen de grootte van de schijf kan vergroten. | Int |
| Codering | Versleutelingseigenschap kan worden gebruikt voor het versleutelen van data-at-rest met door de klant beheerde sleutels of door het platform beheerde sleutels. | versleuteling |
| encryptionSettingsCollection | Verzameling versleutelingsinstellingen die worden gebruikt voor Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. | EncryptionSettingsCollection- |
| hyperVGeneratie | De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven. | 'V1' 'V2' |
| Incrementele | Of een momentopname incrementeel is. Incrementele momentopnamen op dezelfde schijf nemen minder ruimte in beslag dan volledige momentopnamen en kunnen worden gesynchroniseerd. | Bool |
| networkAccessPolicy | Beleid voor toegang tot de schijf via het netwerk. | 'AllowAll' AllowPrivate 'DenyAll' |
| osType | Het type besturingssysteem. | 'Linux' 'Windows' |
| publicNetworkAccess | Beleid voor het beheren van export op de schijf. | 'Uitgeschakeld' 'Ingeschakeld' |
| purchasePlan | Aankoopplangegevens voor de installatiekopie van waaruit de bronschijf voor de momentopname oorspronkelijk is gemaakt. | PurchasePlan- |
| securityProfile | Bevat de beveiligingsgerelateerde informatie voor de resource. | DiskSecurityProfile |
| supportedCapabilities | Lijst met ondersteunde mogelijkheden voor de installatiekopie waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. | SupportedCapabilities |
| supportsHibernation | Geeft aan dat het besturingssysteem op een momentopname de sluimerstand ondersteunt. | Bool |
SnapshotSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De SKU-naam. | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
| Naam | Beschrijving | Waarde |
|---|---|---|
| legitimatiebewijs | Resource-id | snaar |
SupportedCapabilities
| Naam | Beschrijving | Waarde |
|---|---|---|
| acceleratedNetwork | Is waar als de installatiekopieën van waaruit de besturingssysteemschijf wordt gemaakt, ondersteuning bieden voor versneld netwerken. | Bool |
| architectuur | CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. | 'Arm64' 'x64' |
| diskControllerTypes | De schijfcontrollers die een besturingssysteemschijf ondersteunt. Als deze is ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. | snaar |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Compute/snapshots-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2023-01-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
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
}
})
}
Eigenschapswaarden
CopyCompletionError
| Naam | Beschrijving | Waarde |
|---|---|---|
| errorCode | Geeft de foutcode aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | 'CopySourceNotFound' (vereist) |
| errorMessage | Geeft het foutbericht aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | tekenreeks (vereist) |
CreationData
| Naam | Beschrijving | Waarde |
|---|---|---|
| createOption | Hiermee worden de mogelijke bronnen van het maken van een schijf opgesomd. | 'Bijvoegen' 'Kopiëren' 'CopyStart' 'Leeg' 'FromImage' 'Importeren' 'ImportSecure' 'Herstellen' 'Uploaden' 'UploadPreparedSecure' (vereist) |
| galleryImageReference | Vereist als u een galerie-installatiekopieën maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde kombuisinstallatiekopie waaruit een schijf moet worden gemaakt. | ImageDiskReference- |
| imageReference | Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. | ImageDiskReference- |
| logicalSectorSize | Grootte van logische sector in bytes voor Ultra-schijven. Ondersteunde waarden zijn 512 ad 4096. 4096 is de standaardwaarde. | Int |
| performancePlus | Stel deze vlag in op True om een boost te krijgen op het prestatiedoel van de schijf die is geïmplementeerd, zie hier over het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld op de aanmaaktijd van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. | Bool |
| securityDataUri | Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de gaststatus van de VM. | snaar |
| sourceResourceId | Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. | snaar |
| sourceUri | Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. | snaar |
| storageAccountId | Vereist als createOption import is. De Azure Resource Manager-id van het opslagaccount met de blob die moet worden geïmporteerd als een schijf. | snaar |
| uploadSizeBytes | Als createOption Upload is, is dit de grootte van de inhoud van de upload, inclusief de VHD-voettekst. Deze waarde moet tussen 20972032 (20 MiB + 512 bytes voor de VHD-voettekst) en 35183298347520 bytes (32 TiB + 512 bytes voor de VHD-voettekst). | Int |
DiskSecurityProfile
| Naam | Beschrijving | Waarde |
|---|---|---|
| secureVMDiskEncryptionSetId | ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf die is versleuteld met een door de klant beheerde sleutel | snaar |
| securityType | Hiermee geeft u het SecurityType van de VIRTUELE machine. Alleen van toepassing op besturingssysteemschijven. | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch' |
Codering
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionSetId | ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. | snaar |
| type | Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Stel deze vlag in op true en geef DiskEncryptionKey en optionele KeyEncryptionKey op om versleuteling in te schakelen. Stel deze vlag in op false en verwijder DiskEncryptionKey en KeyEncryptionKey om versleuteling uit te schakelen. Als EncryptionSettings null is in het aanvraagobject, blijven de bestaande instellingen ongewijzigd. | bool (vereist) |
| encryptionSettings | Een verzameling versleutelingsinstellingen, één voor elk schijfvolume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | Beschrijft welk type versleuteling wordt gebruikt voor de schijven. Zodra dit veld is ingesteld, kan het niet worden overschreven. '1.0' komt overeen met Azure Disk Encryption met de AAD-app.'1.1' komt overeen met Azure Disk Encryption. | snaar |
EncryptionSettingsElement
| Naam | Beschrijving | Waarde |
|---|---|---|
| diskEncryptionKey | Key Vault Geheime URL en kluis-id van de schijfversleutelingssleutel | KeyVaultAndSecretReference- |
| keyEncryptionKey | Key Vault-sleutel-URL en kluis-id van de sleutelversleutelingssleutel. KeyEncryptionKey is optioneel en wanneer deze wordt opgegeven, wordt gebruikt om de schijfversleutelingssleutel uit te pakken. | KeyVaultAndKeyReference- |
ExtendedLocation
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De naam van de uitgebreide locatie. | snaar |
| type | Het type van de uitgebreide locatie. | 'EdgeZone' |
ImageDiskReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| communityGalleryImageId | Een relatieve URI met een azure Compute Gallery-installatiekopiereferentie voor de community. | snaar |
| legitimatiebewijs | Een relatieve URI met een opslagplaats voor platforminstallatiekopieën, een gebruikersinstallatiekopie of een azure Compute Gallery-installatiekopie. | snaar |
| Lun | Als de schijf wordt gemaakt op basis van de gegevensschijf van een installatiekopieën, is dit een index die aangeeft welke van de gegevensschijven in de installatiekopieën moeten worden gebruikt. Voor besturingssysteemschijven is dit veld null. | Int |
| sharedGalleryImageId | Een relatieve URI met een direct gedeelde Azure Compute Gallery-installatiekopiereferentie. | snaar |
KeyVaultAndKeyReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| keyUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
KeyVaultAndSecretReference
| Naam | Beschrijving | Waarde |
|---|---|---|
| secretUrl | URL die verwijst naar een sleutel of geheim in KeyVault | tekenreeks (vereist) |
| sourceVault | Resource-id van de KeyVault die de sleutel of het geheim bevat | SourceVault- (vereist) |
Microsoft.Compute/momentopnamen
| Naam | Beschrijving | Waarde |
|---|---|---|
| extendedLocation | De uitgebreide locatie waar de momentopname wordt gemaakt. De uitgebreide locatie kan niet worden gewijzigd. | ExtendedLocation- |
| plaats | Resourcelocatie | tekenreeks (vereist) |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Eigenschappen van momentopnameresources. | SnapshotProperties- |
| Sku | De SKU-naam van de momentopnamen. Kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopnamen en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde sKU als de vorige momentopname | SnapshotSku |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
| type | Het resourcetype | "Microsoft.Compute/snapshots@2023-01-02" |
PurchasePlan
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De plan-id. | tekenreeks (vereist) |
| product | Hiermee geeft u het product van de installatiekopieën van de marketplace. Dit is dezelfde waarde als Offer onder het element imageReference. | tekenreeks (vereist) |
| promotionCode | De aanbiedingspromotiecode. | snaar |
| uitgever | De uitgever-id. | tekenreeks (vereist) |
ResourceTags
| Naam | Beschrijving | Waarde |
|---|
SnapshotProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| completionPercent | Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de kopieerbewerking. | Int |
| copyCompletionError | Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de CopyStart-bewerking mislukt. | CopyCompletionError- |
| creationData | Informatie over de schijfbron. CreationData-gegevens kunnen niet worden gewijzigd nadat de schijf is gemaakt. | CreationData- (vereist) |
| dataAccessAuthMode | Aanvullende verificatievereisten bij het exporteren of uploaden naar een schijf of momentopname. | 'AzureActiveDirectory' 'Geen' |
| diskAccessId | ARM-id van de DiskAccess-resource voor het gebruik van privé-eindpunten op schijven. | snaar |
| diskSizeGB | Als creationData.createOption leeg is, is dit veld verplicht en wordt de grootte van de schijf aangegeven die moet worden gemaakt. Als dit veld aanwezig is voor updates of het maken met andere opties, wordt het formaat aangegeven. Grootten zijn alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en alleen de grootte van de schijf kan vergroten. | Int |
| Codering | Versleutelingseigenschap kan worden gebruikt voor het versleutelen van data-at-rest met door de klant beheerde sleutels of door het platform beheerde sleutels. | versleuteling |
| encryptionSettingsCollection | Verzameling versleutelingsinstellingen die worden gebruikt voor Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. | EncryptionSettingsCollection- |
| hyperVGeneratie | De hypervisorgeneratie van de virtuele machine. Alleen van toepassing op besturingssysteemschijven. | 'V1' 'V2' |
| Incrementele | Of een momentopname incrementeel is. Incrementele momentopnamen op dezelfde schijf nemen minder ruimte in beslag dan volledige momentopnamen en kunnen worden gesynchroniseerd. | Bool |
| networkAccessPolicy | Beleid voor toegang tot de schijf via het netwerk. | 'AllowAll' AllowPrivate 'DenyAll' |
| osType | Het type besturingssysteem. | 'Linux' 'Windows' |
| publicNetworkAccess | Beleid voor het beheren van export op de schijf. | 'Uitgeschakeld' 'Ingeschakeld' |
| purchasePlan | Aankoopplangegevens voor de installatiekopie van waaruit de bronschijf voor de momentopname oorspronkelijk is gemaakt. | PurchasePlan- |
| securityProfile | Bevat de beveiligingsgerelateerde informatie voor de resource. | DiskSecurityProfile |
| supportedCapabilities | Lijst met ondersteunde mogelijkheden voor de installatiekopie waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. | SupportedCapabilities |
| supportsHibernation | Geeft aan dat het besturingssysteem op een momentopname de sluimerstand ondersteunt. | Bool |
SnapshotSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De SKU-naam. | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
SourceVault
| Naam | Beschrijving | Waarde |
|---|---|---|
| legitimatiebewijs | Resource-id | snaar |
SupportedCapabilities
| Naam | Beschrijving | Waarde |
|---|---|---|
| acceleratedNetwork | Is waar als de installatiekopieën van waaruit de besturingssysteemschijf wordt gemaakt, ondersteuning bieden voor versneld netwerken. | Bool |
| architectuur | CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. | 'Arm64' 'x64' |
| diskControllerTypes | De schijfcontrollers die een besturingssysteemschijf ondersteunt. Als deze is ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. | snaar |