Freigeben über


Microsoft.Compute Snapshots 2023-10-02

Bicep-Ressourcendefinition

Der Snapshots-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/Snapshots-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Compute/snapshots@2023-10-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'
      elasticSanResourceId: 'string'
      galleryImageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      imageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      logicalSectorSize: int
      performancePlus: bool
      provisionedBandwidthCopySpeed: 'string'
      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
  }
}

Eigenschaftswerte

Schnappschüsse

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit alphanumerisch. Enden Sie mit alphanumerisch oder unterstrich.
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Sku Der Snapshots-Sku-Name. Kann Standard_LRS, Premium_LRS oder Standard_ZRS sein. Dies ist ein optionaler Parameter für die inkrementelle Momentaufnahme, und das Standardverhalten ist die SKU auf dieselbe Sku wie die vorherige Momentaufnahme festgelegt. SnapshotSku-
extendedLocation Der erweiterte Speicherort, an dem die Momentaufnahme erstellt wird. Der erweiterte Speicherort kann nicht geändert werden. ExtendedLocation-
Eigenschaften Snapshot-Ressourceneigenschaften. SnapshotProperties-

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Schnur
Art Der Typ des erweiterten Speicherorts. "EdgeZone"

SnapshotProperties

Name Beschreibung Wert
completionPercent Prozentsatz abgeschlossen für die Hintergrundkopie, wenn eine Ressource über den CopyStart-Vorgang erstellt wird. Int
copyCompletionError Gibt die Fehlerdetails an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. CopyCompletionError-
creationData Informationen zur Datenträgerquelle. CreationData-Informationen können nicht geändert werden, nachdem der Datenträger erstellt wurde. CreationData- (erforderlich)
dataAccessAuthMode Zusätzliche Authentifizierungsanforderungen beim Exportieren oder Hochladen auf einen Datenträger oder eine Momentaufnahme. "AzureActiveDirectory"
'None'
diskAccessId ARM-ID der DiskAccess-Ressource für die Verwendung privater Endpunkte auf Datenträgern. Schnur
diskSizeGB Wenn creationData.createOption leer ist, ist dieses Feld obligatorisch und gibt die Größe des zu erstellenden Datenträgers an. Wenn dieses Feld für Updates oder die Erstellung mit anderen Optionen vorhanden ist, gibt es eine Größenänderung an. Größenänderungen sind nur zulässig, wenn der Datenträger nicht an eine ausgeführte VM angefügt ist und nur die Größe des Datenträgers erhöhen kann. Int
Verschlüsselung Verschlüsselungseigenschaft kann verwendet werden, um ruhende Daten mit vom Kunden verwalteten Schlüsseln oder plattformverwalteten Schlüsseln zu verschlüsseln. Verschlüsselungs-
encryptionSettingsCollection Die Sammlung von Verschlüsselungseinstellungen, die als Azure Disk Encryption verwendet wird, kann mehrere Verschlüsselungseinstellungen pro Datenträger oder Momentaufnahme enthalten. EncryptionSettingsCollection-
hyperVGeneration Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger. 'V1'
'V2'
inkremental Gibt an, ob eine Momentaufnahme inkrementell ist. Inkrementelle Momentaufnahmen auf demselben Datenträger belegen weniger Speicherplatz als vollständige Momentaufnahmen und können diffed werden. Bool
networkAccessPolicy Richtlinie für den Zugriff auf den Datenträger über das Netzwerk. "AllowAll"
"AllowPrivate"
'DenyAll'
osType Der Betriebssystemtyp. "Linux"
"Windows"
publicNetworkAccess Richtlinie zum Steuern des Exports auf dem Datenträger. "Deaktiviert"
"Aktiviert"
purchasePlan Kaufplaninformationen für das Image, von dem der Quelldatenträger für die Momentaufnahme ursprünglich erstellt wurde. PurchasePlan-
securityProfile Enthält die sicherheitsbezogenen Informationen für die Ressource. DiskSecurityProfile-
supportedCapabilities Liste der unterstützten Funktionen für das Image, von dem der Quelldatenträger aus der Momentaufnahme ursprünglich erstellt wurde. SupportedCapabilities-
supportsHibernation Gibt an, dass das Betriebssystem in einer Momentaufnahme den Ruhezustand unterstützt. Bool

CopyCompletionError

Name Beschreibung Wert
errorCode Gibt den Fehlercode an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. 'CopySourceNotFound' (erforderlich)
errorMessage Gibt die Fehlermeldung an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. Zeichenfolge (erforderlich)

CreationData

Name Beschreibung Wert
createOption Dadurch werden die möglichen Quellen der Erstellung eines Datenträgers aufgezählt. "Anfügen"
"Kopieren"
"CopyFromSanSnapshot"
"CopyStart"
"Leer"
'FromImage'
"Import"
"ImportSecure"
"Wiederherstellen"
"Hochladen"
"UploadPreparedSecure" (erforderlich)
elasticSanResourceId Erforderlich, wenn createOption "CopyFromSanSnapshot" ist. Dies ist die ARM-ID der Snapshot des elastisch-volume der Quelle. Schnur
galleryImageReference Erforderlich, wenn sie aus einem Katalogbild erstellt werden. Die ID/sharedGalleryImageId/communityGalleryImageId der ImageDiskReference ist die ARM-ID der freigegebenen Galley-Imageversion, aus der ein Datenträger erstellt werden soll. ImageDiskReference-
imageReference Datenträgerquellinformationen für PIR- oder Benutzerimages. ImageDiskReference-
LogicalSectorSize Logische Sektorgröße in Byte für Ultra-Datenträger. Unterstützte Werte sind 512 Ad 4096. 4096 ist die Standardeinstellung. Int
performancePlus Legen Sie dieses Kennzeichen auf "true" fest, um das Leistungsziel des bereitgestellten Datenträgers zu steigern. Weitere Informationen finden Sie hier im jeweiligen Leistungsziel. Dieses Kennzeichen kann nur für die Erstellungszeit des Datenträgers festgelegt werden und kann nach der Aktivierung nicht deaktiviert werden. Bool
provisionedBandwidthCopySpeed Wenn dieses Feld für eine Momentaufnahme festgelegt ist und createOption "CopyStart" lautet, wird die Momentaufnahme mit einer schnelleren Geschwindigkeit kopiert. "Erweitert"
'None'
securityDataUri Wenn createOption importSecure ist, ist dies der URI eines Blobs, das in den Gastzustand des virtuellen Computers importiert werden soll. Schnur
sourceResourceId Wenn createOption "Copy" lautet, ist dies die ARM-ID der Quellmomentaufnahme oder des Quelldatenträgers. Schnur
sourceUri Wenn createOption import ist, ist dies der URI eines BLOB, das in einen verwalteten Datenträger importiert werden soll. Schnur
storageAccountId Erforderlich, wenn createOption import ist. Der Azure Resource Manager-Bezeichner des Speicherkontos, das das BLOB enthält, das als Datenträger importiert werden soll. Schnur
uploadSizeBytes Wenn createOption "Upload" lautet, ist dies die Größe des Inhalts des Uploads, einschließlich der VHD-Fußzeile. Dieser Wert sollte zwischen 20972032 (20 MiB + 512 Bytes für die VHD-Fußzeile) und 35183298347520 Bytes (32 TiB + 512 Bytes für die VHD-Fußzeile) sein. Int

ImageDiskReference

Name Beschreibung Wert
communityGalleryImageId Ein relativer URI, der eine Azure Compute Gallery-Community-Imagereferenz enthält. Schnur
id Ein relativer URI, der entweder ein Plattformimage-Repository, ein Benutzerimage oder einen Azure Compute Gallery-Imageverweis enthält. Schnur
lun Wenn der Datenträger vom Datenträger eines Images erstellt wird, ist dies ein Index, der angibt, welche der Datenträger im Image verwendet werden sollen. Bei Betriebssystemdatenträgern ist dieses Feld null. Int
sharedGalleryImageId Ein relativer URI, der einen direkten freigegebenen Azure Compute Gallery-Bildverweis enthält. Schnur

Verschlüsselung

Name Beschreibung Wert
diskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der zum Aktivieren der ruhenden Verschlüsselung verwendet werden soll. Schnur
Art Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird. "EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionSettingsCollection

Name Beschreibung Wert
ermöglichte Legen Sie dieses Kennzeichen auf "true" fest, und stellen Sie "DiskEncryptionKey" und optional "KeyEncryptionKey" bereit, um die Verschlüsselung zu aktivieren. Legen Sie dieses Kennzeichen auf "false" fest, und entfernen Sie "DiskEncryptionKey" und "KeyEncryptionKey", um die Verschlüsselung zu deaktivieren. Wenn EncryptionSettings im Anforderungsobjekt null ist, bleiben die vorhandenen Einstellungen unverändert. bool (erforderlich)
encryptionSettings Eine Sammlung von Verschlüsselungseinstellungen, eine für jedes Datenträgervolume. EncryptionSettingsElement[]
encryptionSettingsVersion Beschreibt, welche Art von Verschlüsselung für die Datenträger verwendet wird. Nachdem dieses Feld festgelegt wurde, kann es nicht überschrieben werden. "1.0" entspricht azure Disk Encryption mit AAD-App.'1.1' entspricht azure Disk Encryption. Schnur

EncryptionSettingsElement

Name Beschreibung Wert
diskEncryptionKey Key Vault Secret URL und Tresor-ID des Datenträgerverschlüsselungsschlüssels KeyVaultAndSecretReference-
keyEncryptionKey Schlüsseltresorschlüssel-URL und Tresor-ID des Schlüsselverschlüsselungsschlüssels. KeyEncryptionKey ist optional und wird verwendet, um den Datenträgerverschlüsselungsschlüssel aufzuheben. KeyVaultAndKeyReference-

KeyVaultAndSecretReference

Name Beschreibung Wert
secretUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

SourceVault

Name Beschreibung Wert
id Ressourcen-ID Schnur

KeyVaultAndKeyReference

Name Beschreibung Wert
keyUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

PurchasePlan

Name Beschreibung Wert
Name Die Plan-ID. Zeichenfolge (erforderlich)
Produkt Gibt das Produkt des Bilds vom Marketplace an. Dies ist derselbe Wert wie Offer unter dem imageReference-Element. Zeichenfolge (erforderlich)
promotionCode Der Angebotsaktionscode. Schnur
Verlag Die Herausgeber-ID. Zeichenfolge (erforderlich)

DiskSecurityProfile

Name Beschreibung Wert
secureVMDiskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der mit dem vom Kunden verwalteten Schlüssel verschlüsselten vertraulichen virtuellen Computer verknüpft ist Schnur
securityType Gibt den SecurityType der VM an. Gilt nur für Betriebssystemdatenträger. "ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

SupportedCapabilities

Name Beschreibung Wert
acceleratedNetwork True, wenn das Image, von dem der Betriebssystemdatenträger erstellt wird, beschleunigte Netzwerke unterstützt. Bool
Architektur Cpu-Architektur, die von einem Betriebssystemdatenträger unterstützt wird. "Arm64"
'x64'
diskControllerTypes Die Datenträgercontroller, die ein Betriebssystemdatenträger unterstützt. Bei Festlegung kann es sich um SCSI oder SCSI, NVME oder NVME, SCSI, sein. Schnur

SnapshotSku

Name Beschreibung Wert
Name Der Sku-Name. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

ARM-Vorlagenressourcendefinition

Der Snapshots-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/Snapshots-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2023-10-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",
      "elasticSanResourceId": "string",
      "galleryImageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "imageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "logicalSectorSize": "int",
      "performancePlus": "bool",
      "provisionedBandwidthCopySpeed": "string",
      "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"
  }
}

Eigenschaftswerte

Schnappschüsse

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/Snapshots"
apiVersion Die Ressourcen-API-Version '2023-10-02'
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit alphanumerisch. Enden Sie mit alphanumerisch oder unterstrich.
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Sku Der Snapshots-Sku-Name. Kann Standard_LRS, Premium_LRS oder Standard_ZRS sein. Dies ist ein optionaler Parameter für die inkrementelle Momentaufnahme, und das Standardverhalten ist die SKU auf dieselbe Sku wie die vorherige Momentaufnahme festgelegt. SnapshotSku-
extendedLocation Der erweiterte Speicherort, an dem die Momentaufnahme erstellt wird. Der erweiterte Speicherort kann nicht geändert werden. ExtendedLocation-
Eigenschaften Snapshot-Ressourceneigenschaften. SnapshotProperties-

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Schnur
Art Der Typ des erweiterten Speicherorts. "EdgeZone"

SnapshotProperties

Name Beschreibung Wert
completionPercent Prozentsatz abgeschlossen für die Hintergrundkopie, wenn eine Ressource über den CopyStart-Vorgang erstellt wird. Int
copyCompletionError Gibt die Fehlerdetails an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. CopyCompletionError-
creationData Informationen zur Datenträgerquelle. CreationData-Informationen können nicht geändert werden, nachdem der Datenträger erstellt wurde. CreationData- (erforderlich)
dataAccessAuthMode Zusätzliche Authentifizierungsanforderungen beim Exportieren oder Hochladen auf einen Datenträger oder eine Momentaufnahme. "AzureActiveDirectory"
'None'
diskAccessId ARM-ID der DiskAccess-Ressource für die Verwendung privater Endpunkte auf Datenträgern. Schnur
diskSizeGB Wenn creationData.createOption leer ist, ist dieses Feld obligatorisch und gibt die Größe des zu erstellenden Datenträgers an. Wenn dieses Feld für Updates oder die Erstellung mit anderen Optionen vorhanden ist, gibt es eine Größenänderung an. Größenänderungen sind nur zulässig, wenn der Datenträger nicht an eine ausgeführte VM angefügt ist und nur die Größe des Datenträgers erhöhen kann. Int
Verschlüsselung Verschlüsselungseigenschaft kann verwendet werden, um ruhende Daten mit vom Kunden verwalteten Schlüsseln oder plattformverwalteten Schlüsseln zu verschlüsseln. Verschlüsselungs-
encryptionSettingsCollection Die Sammlung von Verschlüsselungseinstellungen, die als Azure Disk Encryption verwendet wird, kann mehrere Verschlüsselungseinstellungen pro Datenträger oder Momentaufnahme enthalten. EncryptionSettingsCollection-
hyperVGeneration Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger. 'V1'
'V2'
inkremental Gibt an, ob eine Momentaufnahme inkrementell ist. Inkrementelle Momentaufnahmen auf demselben Datenträger belegen weniger Speicherplatz als vollständige Momentaufnahmen und können diffed werden. Bool
networkAccessPolicy Richtlinie für den Zugriff auf den Datenträger über das Netzwerk. "AllowAll"
"AllowPrivate"
'DenyAll'
osType Der Betriebssystemtyp. "Linux"
"Windows"
publicNetworkAccess Richtlinie zum Steuern des Exports auf dem Datenträger. "Deaktiviert"
"Aktiviert"
purchasePlan Kaufplaninformationen für das Image, von dem der Quelldatenträger für die Momentaufnahme ursprünglich erstellt wurde. PurchasePlan-
securityProfile Enthält die sicherheitsbezogenen Informationen für die Ressource. DiskSecurityProfile-
supportedCapabilities Liste der unterstützten Funktionen für das Image, von dem der Quelldatenträger aus der Momentaufnahme ursprünglich erstellt wurde. SupportedCapabilities-
supportsHibernation Gibt an, dass das Betriebssystem in einer Momentaufnahme den Ruhezustand unterstützt. Bool

CopyCompletionError

Name Beschreibung Wert
errorCode Gibt den Fehlercode an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. 'CopySourceNotFound' (erforderlich)
errorMessage Gibt die Fehlermeldung an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. Zeichenfolge (erforderlich)

CreationData

Name Beschreibung Wert
createOption Dadurch werden die möglichen Quellen der Erstellung eines Datenträgers aufgezählt. "Anfügen"
"Kopieren"
"CopyFromSanSnapshot"
"CopyStart"
"Leer"
'FromImage'
"Import"
"ImportSecure"
"Wiederherstellen"
"Hochladen"
"UploadPreparedSecure" (erforderlich)
elasticSanResourceId Erforderlich, wenn createOption "CopyFromSanSnapshot" ist. Dies ist die ARM-ID der Snapshot des elastisch-volume der Quelle. Schnur
galleryImageReference Erforderlich, wenn sie aus einem Katalogbild erstellt werden. Die ID/sharedGalleryImageId/communityGalleryImageId der ImageDiskReference ist die ARM-ID der freigegebenen Galley-Imageversion, aus der ein Datenträger erstellt werden soll. ImageDiskReference-
imageReference Datenträgerquellinformationen für PIR- oder Benutzerimages. ImageDiskReference-
LogicalSectorSize Logische Sektorgröße in Byte für Ultra-Datenträger. Unterstützte Werte sind 512 Ad 4096. 4096 ist die Standardeinstellung. Int
performancePlus Legen Sie dieses Kennzeichen auf "true" fest, um das Leistungsziel des bereitgestellten Datenträgers zu steigern. Weitere Informationen finden Sie hier im jeweiligen Leistungsziel. Dieses Kennzeichen kann nur für die Erstellungszeit des Datenträgers festgelegt werden und kann nach der Aktivierung nicht deaktiviert werden. Bool
provisionedBandwidthCopySpeed Wenn dieses Feld für eine Momentaufnahme festgelegt ist und createOption "CopyStart" lautet, wird die Momentaufnahme mit einer schnelleren Geschwindigkeit kopiert. "Erweitert"
'None'
securityDataUri Wenn createOption importSecure ist, ist dies der URI eines Blobs, das in den Gastzustand des virtuellen Computers importiert werden soll. Schnur
sourceResourceId Wenn createOption "Copy" lautet, ist dies die ARM-ID der Quellmomentaufnahme oder des Quelldatenträgers. Schnur
sourceUri Wenn createOption import ist, ist dies der URI eines BLOB, das in einen verwalteten Datenträger importiert werden soll. Schnur
storageAccountId Erforderlich, wenn createOption import ist. Der Azure Resource Manager-Bezeichner des Speicherkontos, das das BLOB enthält, das als Datenträger importiert werden soll. Schnur
uploadSizeBytes Wenn createOption "Upload" lautet, ist dies die Größe des Inhalts des Uploads, einschließlich der VHD-Fußzeile. Dieser Wert sollte zwischen 20972032 (20 MiB + 512 Bytes für die VHD-Fußzeile) und 35183298347520 Bytes (32 TiB + 512 Bytes für die VHD-Fußzeile) sein. Int

ImageDiskReference

Name Beschreibung Wert
communityGalleryImageId Ein relativer URI, der eine Azure Compute Gallery-Community-Imagereferenz enthält. Schnur
id Ein relativer URI, der entweder ein Plattformimage-Repository, ein Benutzerimage oder einen Azure Compute Gallery-Imageverweis enthält. Schnur
lun Wenn der Datenträger vom Datenträger eines Images erstellt wird, ist dies ein Index, der angibt, welche der Datenträger im Image verwendet werden sollen. Bei Betriebssystemdatenträgern ist dieses Feld null. Int
sharedGalleryImageId Ein relativer URI, der einen direkten freigegebenen Azure Compute Gallery-Bildverweis enthält. Schnur

Verschlüsselung

Name Beschreibung Wert
diskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der zum Aktivieren der ruhenden Verschlüsselung verwendet werden soll. Schnur
Art Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird. "EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionSettingsCollection

Name Beschreibung Wert
ermöglichte Legen Sie dieses Kennzeichen auf "true" fest, und stellen Sie "DiskEncryptionKey" und optional "KeyEncryptionKey" bereit, um die Verschlüsselung zu aktivieren. Legen Sie dieses Kennzeichen auf "false" fest, und entfernen Sie "DiskEncryptionKey" und "KeyEncryptionKey", um die Verschlüsselung zu deaktivieren. Wenn EncryptionSettings im Anforderungsobjekt null ist, bleiben die vorhandenen Einstellungen unverändert. bool (erforderlich)
encryptionSettings Eine Sammlung von Verschlüsselungseinstellungen, eine für jedes Datenträgervolume. EncryptionSettingsElement[]
encryptionSettingsVersion Beschreibt, welche Art von Verschlüsselung für die Datenträger verwendet wird. Nachdem dieses Feld festgelegt wurde, kann es nicht überschrieben werden. "1.0" entspricht azure Disk Encryption mit AAD-App.'1.1' entspricht azure Disk Encryption. Schnur

EncryptionSettingsElement

Name Beschreibung Wert
diskEncryptionKey Key Vault Secret URL und Tresor-ID des Datenträgerverschlüsselungsschlüssels KeyVaultAndSecretReference-
keyEncryptionKey Schlüsseltresorschlüssel-URL und Tresor-ID des Schlüsselverschlüsselungsschlüssels. KeyEncryptionKey ist optional und wird verwendet, um den Datenträgerverschlüsselungsschlüssel aufzuheben. KeyVaultAndKeyReference-

KeyVaultAndSecretReference

Name Beschreibung Wert
secretUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

SourceVault

Name Beschreibung Wert
id Ressourcen-ID Schnur

KeyVaultAndKeyReference

Name Beschreibung Wert
keyUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

PurchasePlan

Name Beschreibung Wert
Name Die Plan-ID. Zeichenfolge (erforderlich)
Produkt Gibt das Produkt des Bilds vom Marketplace an. Dies ist derselbe Wert wie Offer unter dem imageReference-Element. Zeichenfolge (erforderlich)
promotionCode Der Angebotsaktionscode. Schnur
Verlag Die Herausgeber-ID. Zeichenfolge (erforderlich)

DiskSecurityProfile

Name Beschreibung Wert
secureVMDiskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der mit dem vom Kunden verwalteten Schlüssel verschlüsselten vertraulichen virtuellen Computer verknüpft ist Schnur
securityType Gibt den SecurityType der VM an. Gilt nur für Betriebssystemdatenträger. "ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

SupportedCapabilities

Name Beschreibung Wert
acceleratedNetwork True, wenn das Image, von dem der Betriebssystemdatenträger erstellt wird, beschleunigte Netzwerke unterstützt. Bool
Architektur Cpu-Architektur, die von einem Betriebssystemdatenträger unterstützt wird. "Arm64"
'x64'
diskControllerTypes Die Datenträgercontroller, die ein Betriebssystemdatenträger unterstützt. Bei Festlegung kann es sich um SCSI oder SCSI, NVME oder NVME, SCSI, sein. Schnur

SnapshotSku

Name Beschreibung Wert
Name Der Sku-Name. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Snapshots-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/Snapshots-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2023-10-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"
        elasticSanResourceId = "string"
        galleryImageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        imageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        logicalSectorSize = int
        performancePlus = bool
        provisionedBandwidthCopySpeed = "string"
        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"
    }
  })
}

Eigenschaftswerte

Schnappschüsse

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.Compute/snapshots@2023-10-02"
Name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit alphanumerisch. Enden Sie mit alphanumerisch oder unterstrich.
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
parent_id Verwenden Sie die ID dieser Ressourcengruppe, um sie in einer Ressourcengruppe bereitzustellen. Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Sku Der Snapshots-Sku-Name. Kann Standard_LRS, Premium_LRS oder Standard_ZRS sein. Dies ist ein optionaler Parameter für die inkrementelle Momentaufnahme, und das Standardverhalten ist die SKU auf dieselbe Sku wie die vorherige Momentaufnahme festgelegt. SnapshotSku-
extendedLocation Der erweiterte Speicherort, an dem die Momentaufnahme erstellt wird. Der erweiterte Speicherort kann nicht geändert werden. ExtendedLocation-
Eigenschaften Snapshot-Ressourceneigenschaften. SnapshotProperties-

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Schnur
Art Der Typ des erweiterten Speicherorts. "EdgeZone"

SnapshotProperties

Name Beschreibung Wert
completionPercent Prozentsatz abgeschlossen für die Hintergrundkopie, wenn eine Ressource über den CopyStart-Vorgang erstellt wird. Int
copyCompletionError Gibt die Fehlerdetails an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. CopyCompletionError-
creationData Informationen zur Datenträgerquelle. CreationData-Informationen können nicht geändert werden, nachdem der Datenträger erstellt wurde. CreationData- (erforderlich)
dataAccessAuthMode Zusätzliche Authentifizierungsanforderungen beim Exportieren oder Hochladen auf einen Datenträger oder eine Momentaufnahme. "AzureActiveDirectory"
"Keine"
diskAccessId ARM-ID der DiskAccess-Ressource für die Verwendung privater Endpunkte auf Datenträgern. Schnur
diskSizeGB Wenn creationData.createOption leer ist, ist dieses Feld obligatorisch und gibt die Größe des zu erstellenden Datenträgers an. Wenn dieses Feld für Updates oder die Erstellung mit anderen Optionen vorhanden ist, gibt es eine Größenänderung an. Größenänderungen sind nur zulässig, wenn der Datenträger nicht an eine ausgeführte VM angefügt ist und nur die Größe des Datenträgers erhöhen kann. Int
Verschlüsselung Verschlüsselungseigenschaft kann verwendet werden, um ruhende Daten mit vom Kunden verwalteten Schlüsseln oder plattformverwalteten Schlüsseln zu verschlüsseln. Verschlüsselungs-
encryptionSettingsCollection Die Sammlung von Verschlüsselungseinstellungen, die als Azure Disk Encryption verwendet wird, kann mehrere Verschlüsselungseinstellungen pro Datenträger oder Momentaufnahme enthalten. EncryptionSettingsCollection-
hyperVGeneration Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger. "V1"
"V2"
inkremental Gibt an, ob eine Momentaufnahme inkrementell ist. Inkrementelle Momentaufnahmen auf demselben Datenträger belegen weniger Speicherplatz als vollständige Momentaufnahmen und können diffed werden. Bool
networkAccessPolicy Richtlinie für den Zugriff auf den Datenträger über das Netzwerk. "AllowAll"
"AllowPrivate"
"DenyAll"
osType Der Betriebssystemtyp. "Linux"
"Windows"
publicNetworkAccess Richtlinie zum Steuern des Exports auf dem Datenträger. "Deaktiviert"
"Aktiviert"
purchasePlan Kaufplaninformationen für das Image, von dem der Quelldatenträger für die Momentaufnahme ursprünglich erstellt wurde. PurchasePlan-
securityProfile Enthält die sicherheitsbezogenen Informationen für die Ressource. DiskSecurityProfile-
supportedCapabilities Liste der unterstützten Funktionen für das Image, von dem der Quelldatenträger aus der Momentaufnahme ursprünglich erstellt wurde. SupportedCapabilities-
supportsHibernation Gibt an, dass das Betriebssystem in einer Momentaufnahme den Ruhezustand unterstützt. Bool

CopyCompletionError

Name Beschreibung Wert
errorCode Gibt den Fehlercode an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. "CopySourceNotFound" (erforderlich)
errorMessage Gibt die Fehlermeldung an, wenn die Hintergrundkopie einer Ressource, die über den CopyStart-Vorgang erstellt wurde, fehlschlägt. Zeichenfolge (erforderlich)

CreationData

Name Beschreibung Wert
createOption Dadurch werden die möglichen Quellen der Erstellung eines Datenträgers aufgezählt. "Anfügen"
"Kopieren"
"CopyFromSanSnapshot"
"CopyStart"
"Leer"
"FromImage"
"Import"
"ImportSecure"
"Wiederherstellen"
"Hochladen"
"UploadPreparedSecure" (erforderlich)
elasticSanResourceId Erforderlich, wenn createOption "CopyFromSanSnapshot" ist. Dies ist die ARM-ID der Snapshot des elastisch-volume der Quelle. Schnur
galleryImageReference Erforderlich, wenn sie aus einem Katalogbild erstellt werden. Die ID/sharedGalleryImageId/communityGalleryImageId der ImageDiskReference ist die ARM-ID der freigegebenen Galley-Imageversion, aus der ein Datenträger erstellt werden soll. ImageDiskReference-
imageReference Datenträgerquellinformationen für PIR- oder Benutzerimages. ImageDiskReference-
LogicalSectorSize Logische Sektorgröße in Byte für Ultra-Datenträger. Unterstützte Werte sind 512 Ad 4096. 4096 ist die Standardeinstellung. Int
performancePlus Legen Sie dieses Kennzeichen auf "true" fest, um das Leistungsziel des bereitgestellten Datenträgers zu steigern. Weitere Informationen finden Sie hier im jeweiligen Leistungsziel. Dieses Kennzeichen kann nur für die Erstellungszeit des Datenträgers festgelegt werden und kann nach der Aktivierung nicht deaktiviert werden. Bool
provisionedBandwidthCopySpeed Wenn dieses Feld für eine Momentaufnahme festgelegt ist und createOption "CopyStart" lautet, wird die Momentaufnahme mit einer schnelleren Geschwindigkeit kopiert. "Erweitert"
"Keine"
securityDataUri Wenn createOption importSecure ist, ist dies der URI eines Blobs, das in den Gastzustand des virtuellen Computers importiert werden soll. Schnur
sourceResourceId Wenn createOption "Copy" lautet, ist dies die ARM-ID der Quellmomentaufnahme oder des Quelldatenträgers. Schnur
sourceUri Wenn createOption import ist, ist dies der URI eines BLOB, das in einen verwalteten Datenträger importiert werden soll. Schnur
storageAccountId Erforderlich, wenn createOption import ist. Der Azure Resource Manager-Bezeichner des Speicherkontos, das das BLOB enthält, das als Datenträger importiert werden soll. Schnur
uploadSizeBytes Wenn createOption "Upload" lautet, ist dies die Größe des Inhalts des Uploads, einschließlich der VHD-Fußzeile. Dieser Wert sollte zwischen 20972032 (20 MiB + 512 Bytes für die VHD-Fußzeile) und 35183298347520 Bytes (32 TiB + 512 Bytes für die VHD-Fußzeile) sein. Int

ImageDiskReference

Name Beschreibung Wert
communityGalleryImageId Ein relativer URI, der eine Azure Compute Gallery-Community-Imagereferenz enthält. Schnur
id Ein relativer URI, der entweder ein Plattformimage-Repository, ein Benutzerimage oder einen Azure Compute Gallery-Imageverweis enthält. Schnur
lun Wenn der Datenträger vom Datenträger eines Images erstellt wird, ist dies ein Index, der angibt, welche der Datenträger im Image verwendet werden sollen. Bei Betriebssystemdatenträgern ist dieses Feld null. Int
sharedGalleryImageId Ein relativer URI, der einen direkten freigegebenen Azure Compute Gallery-Bildverweis enthält. Schnur

Verschlüsselung

Name Beschreibung Wert
diskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der zum Aktivieren der ruhenden Verschlüsselung verwendet werden soll. Schnur
Art Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird. "EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionSettingsCollection

Name Beschreibung Wert
ermöglichte Legen Sie dieses Kennzeichen auf "true" fest, und stellen Sie "DiskEncryptionKey" und optional "KeyEncryptionKey" bereit, um die Verschlüsselung zu aktivieren. Legen Sie dieses Kennzeichen auf "false" fest, und entfernen Sie "DiskEncryptionKey" und "KeyEncryptionKey", um die Verschlüsselung zu deaktivieren. Wenn EncryptionSettings im Anforderungsobjekt null ist, bleiben die vorhandenen Einstellungen unverändert. bool (erforderlich)
encryptionSettings Eine Sammlung von Verschlüsselungseinstellungen, eine für jedes Datenträgervolume. EncryptionSettingsElement[]
encryptionSettingsVersion Beschreibt, welche Art von Verschlüsselung für die Datenträger verwendet wird. Nachdem dieses Feld festgelegt wurde, kann es nicht überschrieben werden. "1.0" entspricht azure Disk Encryption mit AAD-App.'1.1' entspricht azure Disk Encryption. Schnur

EncryptionSettingsElement

Name Beschreibung Wert
diskEncryptionKey Key Vault Secret URL und Tresor-ID des Datenträgerverschlüsselungsschlüssels KeyVaultAndSecretReference-
keyEncryptionKey Schlüsseltresorschlüssel-URL und Tresor-ID des Schlüsselverschlüsselungsschlüssels. KeyEncryptionKey ist optional und wird verwendet, um den Datenträgerverschlüsselungsschlüssel aufzuheben. KeyVaultAndKeyReference-

KeyVaultAndSecretReference

Name Beschreibung Wert
secretUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

SourceVault

Name Beschreibung Wert
id Ressourcen-ID Schnur

KeyVaultAndKeyReference

Name Beschreibung Wert
keyUrl URL, die auf einen Schlüssel oder geheimen Schlüssel in KeyVault verweist Zeichenfolge (erforderlich)
sourceVault Ressourcen-ID des KeyVaults, der den Schlüssel oder geheimen Schlüssel enthält SourceVault- (erforderlich)

PurchasePlan

Name Beschreibung Wert
Name Die Plan-ID. Zeichenfolge (erforderlich)
Produkt Gibt das Produkt des Bilds vom Marketplace an. Dies ist derselbe Wert wie Offer unter dem imageReference-Element. Zeichenfolge (erforderlich)
promotionCode Der Angebotsaktionscode. Schnur
Verlag Die Herausgeber-ID. Zeichenfolge (erforderlich)

DiskSecurityProfile

Name Beschreibung Wert
secureVMDiskEncryptionSetId ResourceId des Datenträgerverschlüsselungssatzes, der mit dem vom Kunden verwalteten Schlüssel verschlüsselten vertraulichen virtuellen Computer verknüpft ist Schnur
securityType Gibt den SecurityType der VM an. Gilt nur für Betriebssystemdatenträger. "ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

SupportedCapabilities

Name Beschreibung Wert
acceleratedNetwork True, wenn das Image, von dem der Betriebssystemdatenträger erstellt wird, beschleunigte Netzwerke unterstützt. Bool
Architektur Cpu-Architektur, die von einem Betriebssystemdatenträger unterstützt wird. "Arm64"
"x64"
diskControllerTypes Die Datenträgercontroller, die ein Betriebssystemdatenträger unterstützt. Bei Festlegung kann es sich um SCSI oder SCSI, NVME oder NVME, SCSI, sein. Schnur

SnapshotSku

Name Beschreibung Wert
Name Der Sku-Name. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"