Microsoft.Compute-momentopnamen 2022-07-02

Bicep-resourcedefinitie

Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.Compute/snapshots wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Compute/snapshots@2022-07-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    completionPercent: int
    copyCompletionError: {
      errorCode: 'CopySourceNotFound'
      errorMessage: 'string'
    }
    creationData: {
      createOption: 'string'
      galleryImageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      imageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      logicalSectorSize: int
      performancePlus: bool
      securityDataUri: 'string'
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    dataAccessAuthMode: 'string'
    diskAccessId: 'string'
    diskSizeGB: int
    encryption: {
      diskEncryptionSetId: 'string'
      type: 'string'
    }
    encryptionSettingsCollection: {
      enabled: bool
      encryptionSettings: [
        {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
      ]
      encryptionSettingsVersion: 'string'
    }
    hyperVGeneration: 'string'
    incremental: bool
    networkAccessPolicy: 'string'
    osType: 'string'
    publicNetworkAccess: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      promotionCode: 'string'
      publisher: 'string'
    }
    securityProfile: {
      secureVMDiskEncryptionSetId: 'string'
      securityType: 'string'
    }
    supportedCapabilities: {
      acceleratedNetwork: bool
      architecture: 'string'
      diskControllerTypes: 'string'
    }
    supportsHibernation: bool
  }
}

Eigenschapswaarden

momentopnamen

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek. Eindig met alfanumeriek of onderstrepingsteken.
location Resourcelocatie tekenreeks (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku De SKU-naam van de momentopnamen. Dit kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopname en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde SKU als de vorige momentopname SnapshotSku
extendedLocation De uitgebreide locatie waar de momentopname wordt gemaakt. De uitgebreide locatie kan niet worden gewijzigd. ExtendedLocation
properties Resource-eigenschappen van momentopnamen. SnapshotProperties

ExtendedLocation

Naam Description Waarde
naam De naam van de uitgebreide locatie. tekenreeks
type Het type van de uitgebreide locatie. 'EdgeZone'

SnapshotProperties

Naam Description Waarde
completionPercent Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de bewerking CopyStart. int
copyCompletionError Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de copystart-bewerking mislukt. CopyCompletionError
creationData Gegevens van 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. tekenreeks
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 van andere opties, duidt dit op een formaat wijzigen. Grootten zijn alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en kan alleen de grootte van de schijf vergroten. int
versleuteling 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 De verzameling versleutelingsinstellingen die wordt gebruikt voor Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. EncryptionSettingsCollection
hyperVGeneration 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 opgegeven. booleaans
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 de 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 van waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. SupportedCapabilities
supportsHibernation Geeft aan dat het besturingssysteem op een momentopname ondersteuning biedt voor de sluimerstand. booleaans

CopyCompletionError

Naam Description 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 Description 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 maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde galley-installatiekopie van waaruit een schijf wordt gemaakt. ImageDiskReference
imageReference Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. ImageDiskReference
logicalSectorSize Logische sectorgrootte 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 voor het prestatiedoel van de geïmplementeerde schijf. Kijk hier voor het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld bij het maken van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. booleaans
securityDataUri Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de VM-gaststatus. tekenreeks
sourceResourceId Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. tekenreeks
sourceUri Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. tekenreeks
storageAccountId Vereist als createOption Import is. De Azure Resource Manager-id van het opslagaccount met de blob die als schijf moet worden geïmporteerd. tekenreeks
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) zijn. int

ImageDiskReference

Naam Description Waarde
communityGalleryImageId Een relatieve URI met een verwijzing naar azure Compute Gallery-installatiekopieën van de community. tekenreeks
id Een relatieve URI die een opslagplaats voor platforminstallatiekopieën, gebruikersinstallatiekopieën of Azure Compute Gallery-installatiekopieën bevat. tekenreeks
Lun Als de schijf is 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. tekenreeks

Versleuteling

Naam Description Waarde
diskEncryptionSetId ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. tekenreeks
type Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Naam Description Waarde
enabled 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 AAD-app.'1.1' komt overeen met Azure Disk Encryption. tekenreeks

EncryptionSettingsElement

Naam Description 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 wordt gebruikt om de schijfversleutelingssleutel uit te pakken. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Naam Description 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)

SourceVault

Naam Description Waarde
id Resource-id tekenreeks

KeyVaultAndKeyReference

Naam Description 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)

PurchasePlan

Naam Description 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 Aanbieding onder het element imageReference. tekenreeks (vereist)
promotionCode De aanbiedingspromotiecode. tekenreeks
publisher De uitgever-id. tekenreeks (vereist)

DiskSecurityProfile

Naam Description Waarde
secureVMDiskEncryptionSetId ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf met vertrouwelijke VM die is versleuteld met door de klant beheerde sleutel tekenreeks
securityType Hiermee geeft u het SecurityType van de VM op. Alleen van toepassing op besturingssysteemschijven. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Naam Description Waarde
acceleratedNetwork Waar als de installatiekopieën van waaruit de besturingssysteemschijf is gemaakt, versnelde netwerken ondersteunen. booleaans
architectuur CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. 'Arm64'
'x64'
diskControllerTypes De schijfcontrollers die door een besturingssysteemschijf worden ondersteund. Als dit is ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. tekenreeks

SnapshotSku

Naam Description Waarde
naam De SKU-naam. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

Resourcedefinitie van ARM-sjabloon

Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.Compute/snapshots wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2022-07-02",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "completionPercent": "int",
    "copyCompletionError": {
      "errorCode": "CopySourceNotFound",
      "errorMessage": "string"
    },
    "creationData": {
      "createOption": "string",
      "galleryImageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "imageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "logicalSectorSize": "int",
      "performancePlus": "bool",
      "securityDataUri": "string",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "dataAccessAuthMode": "string",
    "diskAccessId": "string",
    "diskSizeGB": "int",
    "encryption": {
      "diskEncryptionSetId": "string",
      "type": "string"
    },
    "encryptionSettingsCollection": {
      "enabled": "bool",
      "encryptionSettings": [
        {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        }
      ],
      "encryptionSettingsVersion": "string"
    },
    "hyperVGeneration": "string",
    "incremental": "bool",
    "networkAccessPolicy": "string",
    "osType": "string",
    "publicNetworkAccess": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "promotionCode": "string",
      "publisher": "string"
    },
    "securityProfile": {
      "secureVMDiskEncryptionSetId": "string",
      "securityType": "string"
    },
    "supportedCapabilities": {
      "acceleratedNetwork": "bool",
      "architecture": "string",
      "diskControllerTypes": "string"
    },
    "supportsHibernation": "bool"
  }
}

Eigenschapswaarden

momentopnamen

Naam Description Waarde
type Het resourcetype 'Microsoft.Compute/snapshots'
apiVersion De resource-API-versie '2022-07-02'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek. Eindig met alfanumeriek of onderstrepingsteken.
location Resourcelocatie tekenreeks (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku De SKU-naam van de momentopnamen. Dit kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopname en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde SKU als de vorige momentopname SnapshotSku
extendedLocation De uitgebreide locatie waar de momentopname wordt gemaakt. De uitgebreide locatie kan niet worden gewijzigd. ExtendedLocation
properties Resource-eigenschappen van momentopnamen. SnapshotProperties

ExtendedLocation

Naam Description Waarde
naam De naam van de uitgebreide locatie. tekenreeks
type Het type van de uitgebreide locatie. 'EdgeZone'

SnapshotProperties

Naam Description Waarde
completionPercent Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de bewerking CopyStart. int
copyCompletionError Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de copystart-bewerking mislukt. CopyCompletionError
creationData Gegevens van 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. tekenreeks
diskSizeGB Als creationData.createOption Leeg is, is dit veld verplicht en geeft het de grootte aan van de schijf die moet worden gemaakt. Als dit veld aanwezig is voor updates of maken met andere opties, geeft dit een formaatgrootte aan. Het formaat wijzigen is alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en de schijf alleen groter kan worden. int
versleuteling De eigenschap Versleuteling kan worden gebruikt om data-at-rest te versleutelen met door de klant beheerde sleutels of door het platform beheerde sleutels. Versleuteling
encryptionSettingsCollection De verzameling versleutelingsinstellingen die wordt gebruikt als Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. EncryptionSettingsCollection
hyperVGeneration 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 opgegeven. booleaans
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 de 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 van waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. SupportedCapabilities
supportsHibernation Geeft aan dat het besturingssysteem op een momentopname ondersteuning biedt voor de sluimerstand. booleaans

CopyCompletionError

Naam Description 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 Description 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 maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde galley-installatiekopie van waaruit een schijf wordt gemaakt. ImageDiskReference
imageReference Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. ImageDiskReference
logicalSectorSize Logische sectorgrootte 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 voor het prestatiedoel van de geïmplementeerde schijf. Kijk hier voor het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld bij het maken van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. booleaans
securityDataUri Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de VM-gaststatus. tekenreeks
sourceResourceId Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. tekenreeks
sourceUri Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. tekenreeks
storageAccountId Vereist als createOption Import is. De Azure Resource Manager-id van het opslagaccount met de blob die als schijf moet worden geïmporteerd. tekenreeks
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) zijn. int

ImageDiskReference

Naam Description Waarde
communityGalleryImageId Een relatieve URI met een verwijzing naar azure Compute Gallery-installatiekopieën van de community. tekenreeks
id Een relatieve URI die een opslagplaats voor platforminstallatiekopieën, gebruikersinstallatiekopieën of Azure Compute Gallery-installatiekopieën bevat. tekenreeks
Lun Als de schijf is 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. tekenreeks

Versleuteling

Naam Description Waarde
diskEncryptionSetId ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. tekenreeks
type Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Naam Description Waarde
enabled 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 AAD-app.'1.1' komt overeen met Azure Disk Encryption. tekenreeks

EncryptionSettingsElement

Naam Description 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 wordt gebruikt om de schijfversleutelingssleutel uit te pakken. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Naam Description 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)

SourceVault

Naam Description Waarde
id Resource-id tekenreeks

KeyVaultAndKeyReference

Naam Description 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)

PurchasePlan

Naam Description 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 Aanbieding onder het element imageReference. tekenreeks (vereist)
promotionCode De aanbiedingspromotiecode. tekenreeks
publisher De uitgever-id. tekenreeks (vereist)

DiskSecurityProfile

Naam Description Waarde
secureVMDiskEncryptionSetId ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf met vertrouwelijke VM die is versleuteld met door de klant beheerde sleutel tekenreeks
securityType Hiermee geeft u het SecurityType van de VM op. Alleen van toepassing op besturingssysteemschijven. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Naam Description Waarde
acceleratedNetwork True als de installatiekopieën van waaruit de besturingssysteemschijf is gemaakt, versneld netwerken ondersteunen. booleaans
architectuur CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. 'Arm64'
'x64'
diskControllerTypes De schijfcontrollers die door een besturingssysteemschijf worden ondersteund. Indien ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. tekenreeks

SnapshotSku

Naam Description Waarde
naam De naam van de SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype momentopnamen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor 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@2022-07-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      completionPercent = int
      copyCompletionError = {
        errorCode = "CopySourceNotFound"
        errorMessage = "string"
      }
      creationData = {
        createOption = "string"
        galleryImageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        imageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        logicalSectorSize = int
        performancePlus = bool
        securityDataUri = "string"
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      dataAccessAuthMode = "string"
      diskAccessId = "string"
      diskSizeGB = int
      encryption = {
        diskEncryptionSetId = "string"
        type = "string"
      }
      encryptionSettingsCollection = {
        enabled = bool
        encryptionSettings = [
          {
            diskEncryptionKey = {
              secretUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
            keyEncryptionKey = {
              keyUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
          }
        ]
        encryptionSettingsVersion = "string"
      }
      hyperVGeneration = "string"
      incremental = bool
      networkAccessPolicy = "string"
      osType = "string"
      publicNetworkAccess = "string"
      purchasePlan = {
        name = "string"
        product = "string"
        promotionCode = "string"
        publisher = "string"
      }
      securityProfile = {
        secureVMDiskEncryptionSetId = "string"
        securityType = "string"
      }
      supportedCapabilities = {
        acceleratedNetwork = bool
        architecture = "string"
        diskControllerTypes = "string"
      }
      supportsHibernation = bool
    }
    sku = {
      name = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

Eigenschapswaarden

momentopnamen

Naam Description Waarde
type Het resourcetype "Microsoft.Compute/snapshots@2022-07-02"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met alfanumeriek. Eindig met alfanumeriek of onderstrepingsteken.
location Resourcelocatie tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden.
sku De SKU-naam van de momentopnamen. Dit kan Standard_LRS, Premium_LRS of Standard_ZRS zijn. Dit is een optionele parameter voor incrementele momentopname en het standaardgedrag is dat de SKU wordt ingesteld op dezelfde SKU als de vorige momentopname SnapshotSku
extendedLocation De uitgebreide locatie waar de momentopname wordt gemaakt. Uitgebreide locatie kan niet worden gewijzigd. ExtendedLocation
properties Eigenschappen van momentopnameresources. SnapshotProperties

ExtendedLocation

Naam Description Waarde
naam De naam van de uitgebreide locatie. tekenreeks
type Het type van de uitgebreide locatie. "EdgeZone"

SnapshotProperties

Naam Description Waarde
completionPercent Percentage voltooid voor de achtergrondkopie wanneer een resource wordt gemaakt via de bewerking CopyStart. int
copyCompletionError Geeft de foutdetails aan als de achtergrondkopie van een resource die is gemaakt via de copystart-bewerking mislukt. CopyCompletionError
creationData Gegevens van 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. tekenreeks
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 van andere opties, duidt dit op een formaat wijzigen. Grootten zijn alleen toegestaan als de schijf niet is gekoppeld aan een actieve VM en kan alleen de grootte van de schijf vergroten. int
versleuteling 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 De verzameling versleutelingsinstellingen die wordt gebruikt voor Azure Disk Encryption, kan meerdere versleutelingsinstellingen per schijf of momentopname bevatten. EncryptionSettingsCollection
hyperVGeneration 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 dan volledige momentopnamen en kunnen worden opgegeven. booleaans
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 de 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 van waaruit de bronschijf van de momentopname oorspronkelijk is gemaakt. SupportedCapabilities
supportsHibernation Geeft aan dat het besturingssysteem op een momentopname de sluimerstand ondersteunt. booleaans

CopyCompletionError

Naam Description 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 Description 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 galerieinstallatiekopie maakt. De id/sharedGalleryImageId/communityGalleryImageId van de ImageDiskReference is de ARM-id van de versie van de gedeelde installatiekopie van waaruit een schijf wordt gemaakt. ImageDiskReference
imageReference Schijfbroninformatie voor PIR- of gebruikersinstallatiekopieën. ImageDiskReference
logicalSectorSize Logische sectorgrootte 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 voor het prestatiedoel van de geïmplementeerde schijf. Kijk hier voor het respectieve prestatiedoel. Deze vlag kan alleen worden ingesteld bij het maken van de schijf en kan niet worden uitgeschakeld nadat deze is ingeschakeld. booleaans
securityDataUri Als createOption ImportSecure is, is dit de URI van een blob die moet worden geïmporteerd in de VM-gaststatus. tekenreeks
sourceResourceId Als createOption Copy is, is dit de ARM-id van de bronmomentopname of schijf. tekenreeks
sourceUri Als createOption import is, is dit de URI van een blob die moet worden geïmporteerd in een beheerde schijf. tekenreeks
storageAccountId Vereist als createOption Import is. De Azure Resource Manager-id van het opslagaccount met de blob die als schijf moet worden geïmporteerd. tekenreeks
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) zijn. int

ImageDiskReference

Naam Description Waarde
communityGalleryImageId Een relatieve URI met een verwijzing naar azure Compute Gallery-installatiekopieën van de community. tekenreeks
id Een relatieve URI die een opslagplaats voor platforminstallatiekopieën, gebruikersinstallatiekopieën of Azure Compute Gallery-installatiekopieën bevat. tekenreeks
Lun Als de schijf is 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. tekenreeks

Versleuteling

Naam Description Waarde
diskEncryptionSetId ResourceId van de schijfversleutelingsset die moet worden gebruikt voor het inschakelen van versleuteling at rest. tekenreeks
type Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen. "EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionSettingsCollection

Naam Description Waarde
enabled 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 AAD-app.'1.1' komt overeen met Azure Disk Encryption. tekenreeks

EncryptionSettingsElement

Naam Description 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 wordt gebruikt om de schijfversleutelingssleutel uit te pakken. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Naam Description 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)

SourceVault

Naam Description Waarde
id Resource-id tekenreeks

KeyVaultAndKeyReference

Naam Description 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)

PurchasePlan

Naam Description 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 Aanbieding onder het element imageReference. tekenreeks (vereist)
promotionCode De aanbiedingspromotiecode. tekenreeks
publisher De uitgever-id. tekenreeks (vereist)

DiskSecurityProfile

Naam Description Waarde
secureVMDiskEncryptionSetId ResourceId van de schijfversleutelingsset die is gekoppeld aan de schijf met vertrouwelijke VM die is versleuteld met door de klant beheerde sleutel tekenreeks
securityType Hiermee geeft u het SecurityType van de VM op. Alleen van toepassing op besturingssysteemschijven. "ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

SupportedCapabilities

Naam Description Waarde
acceleratedNetwork True als de installatiekopieën van waaruit de besturingssysteemschijf is gemaakt, versneld netwerken ondersteunen. booleaans
architectuur CPU-architectuur die wordt ondersteund door een besturingssysteemschijf. "Arm64"
"x64"
diskControllerTypes De schijfcontrollers die door een besturingssysteemschijf worden ondersteund. Indien ingesteld, kan dit SCSI of SCSI, NVME of NVME, SCSI zijn. tekenreeks

SnapshotSku

Naam Description Waarde
naam De naam van de SKU. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"