Partager via


Instantanés Microsoft.Compute

Définition de ressource Bicep

Le type de ressource instantanés peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/snapshots, ajoutez le Bicep suivant à votre modèle.

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
  }
}

Valeurs de propriétés

snapshots

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Nom de la référence sku des instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour la instantané incrémentielle et le comportement par défaut est que la référence SKU sera définie sur la même référence sku que la instantané précédente InstantanéSku
extendedLocation Emplacement étendu où le instantané sera créé. L’emplacement étendu ne peut pas être modifié. ExtendedLocation
properties Propriétés de la ressource d’instantané. SnapshotProperties

ExtendedLocation

Nom Description Valeur
name Nom de l’emplacement étendu. string
type Type de l’emplacement étendu. 'EdgeZone'

SnapshotProperties

Nom Description Valeur
completionPercent Pourcentage terminé pour la copie en arrière-plan lorsqu’une ressource est créée via l’opération CopyStart. int
copyCompletionError Indique les détails de l’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. CopyCompletionError
creationData Informations sur la source de disque. Les informations CreationData ne peuvent pas être modifiées une fois le disque créé. CreationData (obligatoire)
dataAccessAuthMode Exigences d’authentification supplémentaires lors de l’exportation ou du chargement sur un disque ou un instantané. 'AzureActiveDirectory'
'None'
diskAccessId ID ARM de la ressource DiskAccess pour l’utilisation de points de terminaison privés sur des disques. string
diskSizeGB Si creationData.createOption est Vide, ce champ est obligatoire et indique la taille du disque à créer. Si ce champ est présent pour les mises à jour ou la création avec d’autres options, il indique un redimensionnement. Les redimensionnements ne sont autorisés que si le disque n’est pas attaché à une machine virtuelle en cours d’exécution et peuvent uniquement augmenter la taille du disque. int
le chiffrement La propriété de chiffrement peut être utilisée pour chiffrer des données au repos avec des clés gérées par le client ou des clés gérées par la plateforme. Chiffrement
encryptionSettingsCollection La collection de paramètres de chiffrement utilisée comme Azure Disk Encryption peut contenir plusieurs paramètres de chiffrement par disque ou instantané. EncryptionSettingsCollection
hyperVGeneration Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation. 'V1'
'V2'
incrémentielles Indique si un instantané est incrémentiel. Les instantanés incrémentiels sur le même disque occupent moins d’espace que les instantanés complets et peuvent être différents. bool
networkAccessPolicy Stratégie d’accès au disque via le réseau. 'AllowAll'
'AllowPrivate'
'DenyAll'
osType Type système d’exploitation. 'Linux'
'Windows'
publicNetworkAccess Stratégie de contrôle de l’exportation sur le disque. 'Désactivé'
'Enabled'
purchasePlan Informations sur le plan d’achat pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. Plan d’achat
securityProfile Contient les informations relatives à la sécurité de la ressource. DiskSecurityProfile
supportedCapabilities Liste des fonctionnalités prises en charge pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation d’un instantané prend en charge la mise en veille prolongée. bool

CopyCompletionError

Nom Description Valeur
errorCode Indique le code d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. 'CopySourceNotFound' (obligatoire)
errorMessage Indique le message d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. chaîne (obligatoire)

CreationData

Nom Description Valeur
createOption Cette opération énumère les sources possibles de la création d’un disque. 'Attacher'
'Copier'
'CopyFromSanSnapshot'
'CopyStart'
'Empty'
'FromImage'
'Importer'
'ImportSecure'
'Restaurer'
'Charger'
'UploadPreparedSecure' (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM du volume san élastique source instantané. string
galleryImageReference Obligatoire si vous créez à partir d’une image de galerie. L’id/sharedGalleryImageId/communityGalleryImageId de l’ImageDiskReference sera l’ID ARM de la version de l’image de galère partagée à partir de laquelle créer un disque. ImageDiskReference
imageReference Informations sur la source de disque pour les images PIR ou utilisateur. ImageDiskReference
logicalSectorSize Taille du secteur logique en octets pour les disques Ultra. (valeurs prises en charge : 512 et 4096, par défaut 4096) int
performancePlus Définissez cet indicateur sur true pour obtenir une amélioration de la cible de performances du disque déployé, consultez ici sur la cible de performances correspondante. Cet indicateur ne peut être défini qu’au moment de la création du disque et ne peut pas être désactivé une fois activé. bool
provisionedBandwidthCopySpeed Si ce champ est défini sur un instantané et que createOption a la valeur CopyStart, le instantané sera copié à une vitesse plus rapide. 'Amélioré'
'None'
securityDataUri Si createOption a la valeur ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. string
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de la instantané ou du disque source. string
sourceUri Si createOption est Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. string
storageAccountId Obligatoire si createOption est Import. Azure Resource Manager identificateur du compte de stockage contenant l’objet blob à importer en tant que disque. string
uploadSizeBytes Si createOption est Upload, il s’agit de la taille du contenu du chargement, y compris le pied de page du disque dur virtuel. Cette valeur doit être comprise entre 20972032 (20 Mio + 512 octets pour le pied de disque dur virtuel) et 35183298347520 octets (32 Tio + 512 octets pour le pied de disque dur virtuel). int

ImageDiskReference

Nom Description Valeur
communityGalleryImageId Uri relatif contenant une référence d’image Azure Compute Gallery de communauté. string
id Uri relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image Azure Compute Gallery. string
lun Si le disque est créé à partir du disque de données d’une image, il s’agit d’un index qui indique les disques de données de l’image à utiliser. Pour les disques de système d’exploitation, ce champ est null. int
sharedGalleryImageId Uri relatif contenant une référence d’image Azure Compute Gallery partagée directe. string

Chiffrement

Nom Description Valeur
diskEncryptionSetId ResourceId du jeu de chiffrement de disque à utiliser pour activer le chiffrement au repos. string
type Type de clé utilisé pour chiffrer les données du disque. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Nom Description Valeur
enabled Définissez cet indicateur sur true et fournissez DiskEncryptionKey et keyEncryptionKey facultatif pour activer le chiffrement. Définissez cet indicateur sur false et supprimez DiskEncryptionKey et KeyEncryptionKey pour désactiver le chiffrement. Si EncryptionSettings a la valeur Null dans l’objet de requête, les paramètres existants restent inchangés. bool (obligatoire)
encryptionSettings Collection de paramètres de chiffrement, un pour chaque volume de disque. EncryptionSettingsElement[]
encryptionSettingsVersion Décrit le type de chiffrement utilisé pour les disques. Une fois ce champ défini, il ne peut pas être remplacé. « 1.0 » correspond à Azure Disk Encryption avec l’application AAD.'1.1' correspond à Azure Disk Encryption. string

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey url secrète Key Vault et ID de coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey Key Vault l’URL de clé et l’ID de coffre de la clé de chiffrement de clé. KeyEncryptionKey est facultatif et, lorsqu’il est fourni, est utilisé pour désencapsuler la clé de chiffrement de disque. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nom Description Valeur
secretUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

SourceVault

Nom Description Valeur
id ID de ressource string

KeyVaultAndKeyReference

Nom Description Valeur
keyUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

Plan d’achat

Nom Description Valeur
name ID de plan. chaîne (obligatoire)
product Spécifie le produit de l’image de la Place de marché. Il s’agit de la même valeur que Offer sous l’élément imageReference. chaîne (obligatoire)
promotionCode Code de promotion de l’offre. string
publisher ID de l’éditeur. chaîne (obligatoire)

DiskSecurityProfile

Nom Description Valeur
secureVMDiskEncryptionSetId ResourceId du jeu de chiffrement de disque associé à un disque pris en charge par une machine virtuelle confidentielle chiffré avec une clé gérée par le client string
securityType Spécifie le SecurityType de la machine virtuelle. Applicable uniquement aux disques de système d’exploitation. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_NonPersistedTPM'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Nom Description Valeur
acceleratedNetwork True si l’image à partir de laquelle le disque du système d’exploitation est créé prend en charge la mise en réseau accélérée. bool
architecture Architecture du processeur prise en charge par un disque de système d’exploitation. 'Arm64'
'x64'
diskControllerTypes Contrôleurs de disque pris en charge par un disque de système d’exploitation. S’il est défini, il peut être SCSI ou SCSI, NVME ou NVME, SCSI. string

InstantanéSku

Nom Description Valeur
name Nom de la référence sku. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

Définition de ressources de modèle ARM

Le type de ressource instantanés peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/snapshots, ajoutez le code JSON suivant à votre modèle.

{
  "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"
  }
}

Valeurs de propriétés

snapshots

Nom Description Valeur
type Type de ressource « Microsoft.Compute/snapshots »
apiVersion Version de l’API de ressource '2023-10-02'
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Nom de la référence sku des instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour la instantané incrémentielle et le comportement par défaut est que la référence SKU sera définie sur la même référence sku que la instantané précédente InstantanéSku
extendedLocation Emplacement étendu où le instantané sera créé. L’emplacement étendu ne peut pas être modifié. ExtendedLocation
properties Propriétés de la ressource d’instantané. SnapshotProperties

ExtendedLocation

Nom Description Valeur
name Nom de l’emplacement étendu. string
type Type de l’emplacement étendu. 'EdgeZone'

SnapshotProperties

Nom Description Valeur
completionPercent Pourcentage terminé pour la copie en arrière-plan lorsqu’une ressource est créée via l’opération CopyStart. int
copyCompletionError Indique les détails de l’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. CopyCompletionError
creationData Informations sur la source de disque. Les informations CreationData ne peuvent pas être modifiées une fois le disque créé. CreationData (obligatoire)
dataAccessAuthMode Exigences d’authentification supplémentaires lors de l’exportation ou du chargement sur un disque ou un instantané. 'AzureActiveDirectory'
'None'
diskAccessId ID ARM de la ressource DiskAccess pour l’utilisation de points de terminaison privés sur des disques. string
diskSizeGB Si creationData.createOption est Vide, ce champ est obligatoire et indique la taille du disque à créer. Si ce champ est présent pour les mises à jour ou la création avec d’autres options, il indique un redimensionnement. Les redimensionnements ne sont autorisés que si le disque n’est pas attaché à une machine virtuelle en cours d’exécution et peuvent uniquement augmenter la taille du disque. int
le chiffrement La propriété de chiffrement peut être utilisée pour chiffrer des données au repos avec des clés gérées par le client ou des clés gérées par la plateforme. Chiffrement
encryptionSettingsCollection La collection de paramètres de chiffrement utilisée comme Azure Disk Encryption peut contenir plusieurs paramètres de chiffrement par disque ou instantané. EncryptionSettingsCollection
hyperVGeneration Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation. 'V1'
'V2'
incrémentielles Indique si un instantané est incrémentiel. Les instantanés incrémentiels sur le même disque occupent moins d’espace que les instantanés complets et peuvent être différents. bool
networkAccessPolicy Stratégie d’accès au disque via le réseau. 'AllowAll'
'AllowPrivate'
'DenyAll'
osType Type système d’exploitation. 'Linux'
'Windows'
publicNetworkAccess Stratégie de contrôle de l’exportation sur le disque. 'Désactivé'
'Enabled'
purchasePlan Informations sur le plan d’achat pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. Plan d’achat
securityProfile Contient les informations relatives à la sécurité de la ressource. DiskSecurityProfile
supportedCapabilities Liste des fonctionnalités prises en charge pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation d’un instantané prend en charge la mise en veille prolongée. bool

CopyCompletionError

Nom Description Valeur
errorCode Indique le code d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. 'CopySourceNotFound' (obligatoire)
errorMessage Indique le message d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. chaîne (obligatoire)

CreationData

Nom Description Valeur
createOption Cette opération énumère les sources possibles de la création d’un disque. 'Attacher'
'Copier'
'CopyFromSanSnapshot'
'CopyStart'
'Empty'
'FromImage'
'Importer'
'ImportSecure'
'Restaurer'
'Charger'
'UploadPreparedSecure' (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM du volume san élastique source instantané. string
galleryImageReference Obligatoire si vous créez à partir d’une image de galerie. L’id/sharedGalleryImageId/communityGalleryImageId de l’ImageDiskReference sera l’ID ARM de la version de l’image de galère partagée à partir de laquelle créer un disque. ImageDiskReference
imageReference Informations sur la source de disque pour les images PIR ou utilisateur. ImageDiskReference
logicalSectorSize Taille du secteur logique en octets pour les disques Ultra. (valeurs prises en charge : 512 et 4096, par défaut 4096) int
performancePlus Définissez cet indicateur sur true pour obtenir une amélioration de la cible de performances du disque déployé, consultez ici sur la cible de performances correspondante. Cet indicateur ne peut être défini qu’au moment de la création du disque et ne peut pas être désactivé une fois activé. bool
provisionedBandwidthCopySpeed Si ce champ est défini sur un instantané et que createOption a la valeur CopyStart, le instantané sera copié à une vitesse plus rapide. 'Amélioré'
'None'
securityDataUri Si createOption a la valeur ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. string
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de la instantané ou du disque source. string
sourceUri Si createOption est Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. string
storageAccountId Obligatoire si createOption est Import. Azure Resource Manager identificateur du compte de stockage contenant l’objet blob à importer en tant que disque. string
uploadSizeBytes Si createOption est Upload, il s’agit de la taille du contenu du chargement, y compris le pied de page du disque dur virtuel. Cette valeur doit être comprise entre 20972032 (20 Mio + 512 octets pour le pied de disque dur virtuel) et 35183298347520 octets (32 Tio + 512 octets pour le pied de disque dur virtuel). int

ImageDiskReference

Nom Description Valeur
communityGalleryImageId Uri relatif contenant une référence d’image Azure Compute Gallery de communauté. string
id Uri relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image Azure Compute Gallery. string
lun Si le disque est créé à partir du disque de données d’une image, il s’agit d’un index qui indique les disques de données de l’image à utiliser. Pour les disques de système d’exploitation, ce champ est null. int
sharedGalleryImageId Uri relatif contenant une référence d’image Azure Compute Gallery partagée directe. string

Chiffrement

Nom Description Valeur
diskEncryptionSetId ResourceId du jeu de chiffrement de disque à utiliser pour activer le chiffrement au repos. string
type Type de clé utilisé pour chiffrer les données du disque. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Nom Description Valeur
enabled Définissez cet indicateur sur true et fournissez DiskEncryptionKey et keyEncryptionKey facultatif pour activer le chiffrement. Définissez cet indicateur sur false et supprimez DiskEncryptionKey et KeyEncryptionKey pour désactiver le chiffrement. Si EncryptionSettings a la valeur Null dans l’objet de requête, les paramètres existants restent inchangés. bool (obligatoire)
encryptionSettings Collection de paramètres de chiffrement, un pour chaque volume de disque. EncryptionSettingsElement[]
encryptionSettingsVersion Décrit le type de chiffrement utilisé pour les disques. Une fois ce champ défini, il ne peut pas être remplacé. « 1.0 » correspond à Azure Disk Encryption avec l’application AAD.'1.1' correspond à Azure Disk Encryption. string

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey url secrète Key Vault et ID de coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey Key Vault l’URL de clé et l’ID de coffre de la clé de chiffrement de clé. KeyEncryptionKey est facultatif et, lorsqu’il est fourni, est utilisé pour désencapsuler la clé de chiffrement de disque. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nom Description Valeur
secretUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

SourceVault

Nom Description Valeur
id ID de ressource string

KeyVaultAndKeyReference

Nom Description Valeur
keyUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

Plan d’achat

Nom Description Valeur
name ID de plan. chaîne (obligatoire)
product Spécifie le produit de l’image de la Place de marché. Il s’agit de la même valeur que Offer sous l’élément imageReference. chaîne (obligatoire)
promotionCode Code de promotion de l’offre. string
publisher ID de l’éditeur. chaîne (obligatoire)

DiskSecurityProfile

Nom Description Valeur
secureVMDiskEncryptionSetId ResourceId du jeu de chiffrement de disque associé à un disque pris en charge par une machine virtuelle confidentielle chiffré avec une clé gérée par le client string
securityType Spécifie le SecurityType de la machine virtuelle. Applicable uniquement aux disques de système d’exploitation. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_NonPersistedTPM'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Nom Description Valeur
acceleratedNetwork True si l’image à partir de laquelle le disque du système d’exploitation est créé prend en charge la mise en réseau accélérée. bool
architecture Architecture du processeur prise en charge par un disque de système d’exploitation. 'Arm64'
'x64'
diskControllerTypes Contrôleurs de disque pris en charge par un disque de système d’exploitation. S’il est défini, il peut être SCSI ou SCSI, NVME ou NVME, SCSI. string

InstantanéSku

Nom Description Valeur
name Nom de la référence sku. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource instantanés peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/snapshots, ajoutez le Terraform suivant à votre modèle.

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"
    }
  })
}

Valeurs de propriétés

snapshots

Nom Description Valeur
type Type de ressource « Microsoft.Compute/snapshots@2023-10-02 »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
sku Nom de la référence sku des instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour la instantané incrémentielle et le comportement par défaut est que la référence SKU sera définie sur la même référence sku que la instantané précédente InstantanéSku
extendedLocation Emplacement étendu où le instantané sera créé. L’emplacement étendu ne peut pas être modifié. ExtendedLocation
properties Propriétés de la ressource d’instantané. SnapshotProperties

ExtendedLocation

Nom Description Valeur
name Nom de l’emplacement étendu. string
type Type de l’emplacement étendu. « EdgeZone »

SnapshotProperties

Nom Description Valeur
completionPercent Pourcentage terminé pour la copie en arrière-plan lorsqu’une ressource est créée via l’opération CopyStart. int
copyCompletionError Indique les détails de l’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. CopyCompletionError
creationData Informations sur la source de disque. Les informations CreationData ne peuvent pas être modifiées une fois le disque créé. CreationData (obligatoire)
dataAccessAuthMode Exigences d’authentification supplémentaires lors de l’exportation ou du chargement sur un disque ou un instantané. « AzureActiveDirectory »
"None"
diskAccessId ID ARM de la ressource DiskAccess pour l’utilisation de points de terminaison privés sur des disques. string
diskSizeGB Si creationData.createOption est Vide, ce champ est obligatoire et indique la taille du disque à créer. Si ce champ est présent pour les mises à jour ou la création avec d’autres options, il indique un redimensionnement. Les redimensionnements ne sont autorisés que si le disque n’est pas attaché à une machine virtuelle en cours d’exécution et peuvent uniquement augmenter la taille du disque. int
le chiffrement La propriété de chiffrement peut être utilisée pour chiffrer des données au repos avec des clés gérées par le client ou des clés gérées par la plateforme. Chiffrement
encryptionSettingsCollection La collection de paramètres de chiffrement utilisée comme Azure Disk Encryption peut contenir plusieurs paramètres de chiffrement par disque ou instantané. EncryptionSettingsCollection
hyperVGeneration Génération d’hyperviseur de la machine virtuelle. Applicable uniquement aux disques du système d’exploitation. « V1 »
« V2 »
incrémentielles Indique si un instantané est incrémentiel. Les instantanés incrémentiels sur le même disque occupent moins d’espace que les instantanés complets et peuvent être différents. bool
networkAccessPolicy Stratégie d’accès au disque via le réseau. « AllowAll »
« AllowPrivate »
« DenyAll »
osType Type système d’exploitation. « Linux »
« Windows »
publicNetworkAccess Stratégie de contrôle de l’exportation sur le disque. « Désactivé »
« Activé »
purchasePlan Informations sur le plan d’achat pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. Plan d’achat
securityProfile Contient les informations relatives à la sécurité de la ressource. DiskSecurityProfile
supportedCapabilities Liste des fonctionnalités prises en charge pour l’image à partir de laquelle le disque source du instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation d’un instantané prend en charge la mise en veille prolongée. bool

CopyCompletionError

Nom Description Valeur
errorCode Indique le code d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. « CopySourceNotFound » (obligatoire)
errorMessage Indique le message d’erreur si la copie en arrière-plan d’une ressource créée via l’opération CopyStart échoue. chaîne (obligatoire)

CreationData

Nom Description Valeur
createOption Cette opération énumère les sources possibles de la création d’un disque. « Attacher »
"Copy"
« CopyFromSanSnapshot »
« CopyStart »
"Empty"
« FromImage »
« Importer »
« ImportSecure »
« Restaurer »
« Charger »
« UploadPreparedSecure » (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM du volume san élastique source instantané. string
galleryImageReference Obligatoire si vous créez à partir d’une image de galerie. Id/sharedGalleryImageId/communityGalleryImageId de l’ImageDiskReference sera l’ID ARM de la version d’image de cuisine partagée à partir de laquelle créer un disque. ImageDiskReference
imageReference Informations sur la source de disque pour les images PIR ou utilisateur. ImageDiskReference
logicalSectorSize Taille de secteur logique en octets pour les disques Ultra. (valeurs prises en charge : 512 et 4096, par défaut 4096) int
performancePlus Définissez cet indicateur sur true pour améliorer la cible de performances du disque déployé. Consultez ici la cible de performances correspondante. Cet indicateur ne peut être défini qu’au moment de la création du disque et ne peut pas être désactivé une fois activé. bool
provisionedBandwidthCopySpeed Si ce champ est défini sur un instantané et que createOption a la valeur CopyStart, le instantané est copié à une vitesse plus rapide. « Amélioré »
"None"
securityDataUri Si createOption a la valeur ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. string
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de la instantané ou du disque source. string
sourceUri Si createOption a la valeur Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. string
storageAccountId Obligatoire si createOption a la valeur Import. Azure Resource Manager identificateur du compte de stockage contenant l’objet blob à importer en tant que disque. string
uploadSizeBytes Si createOption a la valeur Upload, il s’agit de la taille du contenu du chargement, y compris le pied de page du disque dur virtuel. Cette valeur doit être comprise entre 20972032 (20 Mio + 512 octets pour le pied de page du disque dur virtuel) et 35183298347520 octets (32 Tio + 512 octets pour le pied de page VHD). int

ImageDiskReference

Nom Description Valeur
communityGalleryImageId URI relatif contenant une référence d’image Azure Compute Gallery de communauté. string
id URI relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image Azure Compute Gallery. string
lun Si le disque est créé à partir du disque de données d’une image, il s’agit d’un index qui indique les disques de données de l’image à utiliser. Pour les disques de système d’exploitation, ce champ est null. int
sharedGalleryImageId URI relatif contenant une référence d’image Azure Compute Gallery partagée directe. string

Chiffrement

Nom Description Valeur
diskEncryptionSetId ResourceId du jeu de chiffrement de disque à utiliser pour activer le chiffrement au repos. string
type Type de clé utilisé pour chiffrer les données du disque. « EncryptionAtRestWithCustomerKey »
« EncryptionAtRestWithPlatformAndCustomerKeys »
« EncryptionAtRestWithPlatformKey »

EncryptionSettingsCollection

Nom Description Valeur
enabled Définissez cet indicateur sur true et fournissez DiskEncryptionKey et facultatif KeyEncryptionKey pour activer le chiffrement. Définissez cet indicateur sur false et supprimez DiskEncryptionKey et KeyEncryptionKey pour désactiver le chiffrement. Si EncryptionSettings est null dans l’objet de requête, les paramètres existants restent inchangés. bool (obligatoire)
encryptionSettings Collection de paramètres de chiffrement, un pour chaque volume de disque. EncryptionSettingsElement[]
encryptionSettingsVersion Décrit le type de chiffrement utilisé pour les disques. Une fois ce champ défini, il ne peut pas être remplacé. « 1.0 » correspond à Azure Disk Encryption avec l’application AAD. « 1.1 » correspond à Azure Disk Encryption. string

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey url secrète Key Vault et ID de coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey Key Vault l’URL de clé et l’ID de coffre de la clé de chiffrement de clé. KeyEncryptionKey est facultatif et, lorsqu’il est fourni, est utilisé pour désencapsuler la clé de chiffrement de disque. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nom Description Valeur
secretUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

SourceVault

Nom Description Valeur
id ID de ressource string

KeyVaultAndKeyReference

Nom Description Valeur
keyUrl URL pointant vers une clé ou un secret dans KeyVault chaîne (obligatoire)
sourceVault ID de ressource du KeyVault contenant la clé ou le secret SourceVault (obligatoire)

Plan d’achat

Nom Description Valeur
name ID de plan. chaîne (obligatoire)
product Spécifie le produit de l’image de la Place de marché. Il s’agit de la même valeur que Offer sous l’élément imageReference. chaîne (obligatoire)
promotionCode Code de promotion de l’offre. string
publisher ID de l’éditeur. chaîne (obligatoire)

DiskSecurityProfile

Nom Description Valeur
secureVMDiskEncryptionSetId ResourceId du jeu de chiffrement de disque associé à un disque pris en charge par une machine virtuelle confidentielle chiffré avec une clé gérée par le client string
securityType Spécifie le SecurityType de la machine virtuelle. Applicable uniquement aux disques de système d’exploitation. « ConfidentialVM_DiskEncryptedWithCustomerKey »
« ConfidentialVM_DiskEncryptedWithPlatformKey »
« ConfidentialVM_NonPersistedTPM »
« ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey »
« TrustedLaunch »

SupportedCapabilities

Nom Description Valeur
acceleratedNetwork True si l’image à partir de laquelle le disque du système d’exploitation est créé prend en charge la mise en réseau accélérée. bool
architecture Architecture du processeur prise en charge par un disque de système d’exploitation. « Arm64 »
« x64 »
diskControllerTypes Contrôleurs de disque pris en charge par un disque de système d’exploitation. S’il est défini, il peut être SCSI ou SCSI, NVME ou NVME, SCSI. string

InstantanéSku

Nom Description Valeur
name Nom de la référence sku. « Premium_LRS »
« Standard_LRS »
« Standard_ZRS »