Partager via

Instantanés Microsoft.Compute 2023-04-02

  • Article

Définition de ressource Bicep

Le type de ressource d’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 de ressource

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

resource symbolicname 'Microsoft.Compute/snapshots@2023-04-02' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    completionPercent: int
    copyCompletionError: {
      errorCode: 'string'
      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
      securityDataUri: 'string'
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    dataAccessAuthMode: 'string'
    diskAccessId: 'string'
    diskSizeGB: int
    encryption: {
      diskEncryptionSetId: 'string'
      type: 'string'
    }
    encryptionSettingsCollection: {
      enabled: bool
      encryptionSettings: [
        {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
      ]
      encryptionSettingsVersion: 'string'
    }
    hyperVGeneration: 'string'
    incremental: bool
    networkAccessPolicy: 'string'
    osType: 'string'
    publicNetworkAccess: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      promotionCode: 'string'
      publisher: 'string'
    }
    securityProfile: {
      secureVMDiskEncryptionSetId: 'string'
      securityType: 'string'
    }
    supportedCapabilities: {
      acceleratedNetwork: bool
      architecture: 'string'
      diskControllerTypes: 'string'
    }
    supportsHibernation: bool
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

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 Cela énumère les sources possibles de la création d’un disque. 'Attacher'
'Copy'
'CopyFromSanSnapshot'
'CopyStart'
'Empty'
'FromImage'
'Import'
'ImportSecure'
'Restore'
'Upload'
'UploadPreparedSecure' (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM de l’instantané de volume san élastique source. corde
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 d’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. Les valeurs prises en charge sont 512 ad 4096. 4096 est la valeur par défaut. Int
performancePlus Définissez cet indicateur sur true pour obtenir une amélioration de la cible de performances du disque déployé, voir ici sur la cible de performances respective. Cet indicateur ne peut être défini que sur l’heure de création du disque et ne peut pas être désactivé après l’activation. Bool
securityDataUri Si createOption est ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. corde
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de l’instantané ou du disque source. corde
sourceUri Si createOption est Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. corde
storageAccountId Obligatoire si createOption est Import. Identificateur Azure Resource Manager du compte de stockage contenant l’objet blob à importer en tant que disque. corde
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 page VHD) et 35183298347520 octets (32 Tio + 512 octets pour le pied de page VHD). Int

DiskSecurityProfile

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

Chiffrement

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

EncryptionSettingsCollection

Nom Description Valeur
Activé 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. corde

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey URL du secret Key Vault et ID du coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey URL de clé key vault et 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

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type de l’emplacement étendu. 'EdgeZone'

ImageDiskReference

Nom Description Valeur
communityGalleryImageId URI relatif contenant une référence d’image De la galerie de calcul Azure de la communauté. corde
id Uri relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image de la galerie de calcul Azure. corde
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 a la valeur Null. Int
sharedGalleryImageId Uri relatif contenant une référence d’image azure Compute Gallery partagée directe. corde

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

Nom Description Valeur
extendedLocation Emplacement étendu où l’instantané sera créé. Impossible de modifier l’emplacement étendu. ExtendedLocation
emplacement Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés des ressources d’instantané. SnapshotProperties
Sku Nom de la référence sku d’instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour l’instantané incrémentiel et le comportement par défaut est que la référence SKU est définie sur la même référence SKU que l’instantané précédent. snapshotSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

PurchasePlan

Nom Description Valeur
nom ID du plan. chaîne (obligatoire)
produit Spécifie le produit de l’image à partir 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. corde
éditeur ID de l’éditeur. chaîne (obligatoire)

ResourceTags

Nom Description Valeur

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. corde
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 ne peut augmenter que la taille du disque. Int
chiffrement La propriété de chiffrement peut être utilisée pour chiffrer les 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 est 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émental 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 de 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 de l’image à partir de laquelle le disque source de l’instantané a été créé à l’origine. PurchasePlan
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 de l’instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation sur un instantané prend en charge la mise en veille prolongée. Bool

SnapshotSku

Nom Description Valeur
nom Nom de la référence SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

SourceVault

Nom Description Valeur
id ID de ressource corde

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 peut être défini sur SCSI ou SCSI, NVME ou NVME, SCSI. corde

Définition de ressource de modèle ARM

Le type de ressource d’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 de ressource

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

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2023-04-02",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "completionPercent": "int",
    "copyCompletionError": {
      "errorCode": "string",
      "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",
      "securityDataUri": "string",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "dataAccessAuthMode": "string",
    "diskAccessId": "string",
    "diskSizeGB": "int",
    "encryption": {
      "diskEncryptionSetId": "string",
      "type": "string"
    },
    "encryptionSettingsCollection": {
      "enabled": "bool",
      "encryptionSettings": [
        {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        }
      ],
      "encryptionSettingsVersion": "string"
    },
    "hyperVGeneration": "string",
    "incremental": "bool",
    "networkAccessPolicy": "string",
    "osType": "string",
    "publicNetworkAccess": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "promotionCode": "string",
      "publisher": "string"
    },
    "securityProfile": {
      "secureVMDiskEncryptionSetId": "string",
      "securityType": "string"
    },
    "supportedCapabilities": {
      "acceleratedNetwork": "bool",
      "architecture": "string",
      "diskControllerTypes": "string"
    },
    "supportsHibernation": "bool"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

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 Cela énumère les sources possibles de la création d’un disque. 'Attacher'
'Copy'
'CopyFromSanSnapshot'
'CopyStart'
'Empty'
'FromImage'
'Import'
'ImportSecure'
'Restore'
'Upload'
'UploadPreparedSecure' (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM de l’instantané de volume san élastique source. corde
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 d’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. Les valeurs prises en charge sont 512 ad 4096. 4096 est la valeur par défaut. Int
performancePlus Définissez cet indicateur sur true pour obtenir une amélioration de la cible de performances du disque déployé, voir ici sur la cible de performances respective. Cet indicateur ne peut être défini que sur l’heure de création du disque et ne peut pas être désactivé après l’activation. Bool
securityDataUri Si createOption est ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. corde
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de l’instantané ou du disque source. corde
sourceUri Si createOption est Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. corde
storageAccountId Obligatoire si createOption est Import. Identificateur Azure Resource Manager du compte de stockage contenant l’objet blob à importer en tant que disque. corde
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 page VHD) et 35183298347520 octets (32 Tio + 512 octets pour le pied de page VHD). Int

DiskSecurityProfile

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

Chiffrement

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

EncryptionSettingsCollection

Nom Description Valeur
Activé 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. corde

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey URL du secret Key Vault et ID du coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey URL de clé key vault et 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

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type de l’emplacement étendu. 'EdgeZone'

ImageDiskReference

Nom Description Valeur
communityGalleryImageId URI relatif contenant une référence d’image De la galerie de calcul Azure de la communauté. corde
id Uri relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image de la galerie de calcul Azure. corde
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 a la valeur Null. Int
sharedGalleryImageId Uri relatif contenant une référence d’image azure Compute Gallery partagée directe. corde

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

Nom Description Valeur
apiVersion Version de l’API '2023-04-02'
extendedLocation Emplacement étendu où l’instantané sera créé. Impossible de modifier l’emplacement étendu. ExtendedLocation
emplacement Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés des ressources d’instantané. SnapshotProperties
Sku Nom de la référence sku d’instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour l’instantané incrémentiel et le comportement par défaut est que la référence SKU est définie sur la même référence SKU que l’instantané précédent. snapshotSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Compute/snapshots'

PurchasePlan

Nom Description Valeur
nom ID du plan. chaîne (obligatoire)
produit Spécifie le produit de l’image à partir 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. corde
éditeur ID de l’éditeur. chaîne (obligatoire)

ResourceTags

Nom Description Valeur

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. corde
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 ne peut augmenter que la taille du disque. Int
chiffrement La propriété de chiffrement peut être utilisée pour chiffrer les 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 est 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émental 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 de 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 de l’image à partir de laquelle le disque source de l’instantané a été créé à l’origine. PurchasePlan
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 de l’instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation sur un instantané prend en charge la mise en veille prolongée. Bool

SnapshotSku

Nom Description Valeur
nom Nom de la référence SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

SourceVault

Nom Description Valeur
id ID de ressource corde

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 peut être défini sur SCSI ou SCSI, NVME ou NVME, SCSI. corde

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource d’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 de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2023-04-02"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      completionPercent = int
      copyCompletionError = {
        errorCode = "string"
        errorMessage = "string"
      }
      creationData = {
        createOption = "string"
        elasticSanResourceId = "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
    }
  })
}

Valeurs de propriété

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 Cela énumère les sources possibles de la création d’un disque. 'Attacher'
'Copy'
'CopyFromSanSnapshot'
'CopyStart'
'Empty'
'FromImage'
'Import'
'ImportSecure'
'Restore'
'Upload'
'UploadPreparedSecure' (obligatoire)
elasticSanResourceId Obligatoire si createOption est CopyFromSanSnapshot. Il s’agit de l’ID ARM de l’instantané de volume san élastique source. corde
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 d’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. Les valeurs prises en charge sont 512 ad 4096. 4096 est la valeur par défaut. Int
performancePlus Définissez cet indicateur sur true pour obtenir une amélioration de la cible de performances du disque déployé, voir ici sur la cible de performances respective. Cet indicateur ne peut être défini que sur l’heure de création du disque et ne peut pas être désactivé après l’activation. Bool
securityDataUri Si createOption est ImportSecure, il s’agit de l’URI d’un objet blob à importer dans l’état invité de la machine virtuelle. corde
sourceResourceId Si createOption est Copy, il s’agit de l’ID ARM de l’instantané ou du disque source. corde
sourceUri Si createOption est Import, il s’agit de l’URI d’un objet blob à importer dans un disque managé. corde
storageAccountId Obligatoire si createOption est Import. Identificateur Azure Resource Manager du compte de stockage contenant l’objet blob à importer en tant que disque. corde
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 page VHD) et 35183298347520 octets (32 Tio + 512 octets pour le pied de page VHD). Int

DiskSecurityProfile

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

Chiffrement

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

EncryptionSettingsCollection

Nom Description Valeur
Activé 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. corde

EncryptionSettingsElement

Nom Description Valeur
diskEncryptionKey URL du secret Key Vault et ID du coffre de la clé de chiffrement de disque KeyVaultAndSecretReference
keyEncryptionKey URL de clé key vault et 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

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type de l’emplacement étendu. 'EdgeZone'

ImageDiskReference

Nom Description Valeur
communityGalleryImageId URI relatif contenant une référence d’image De la galerie de calcul Azure de la communauté. corde
id Uri relatif contenant un référentiel d’images de plateforme, une image utilisateur ou une référence d’image de la galerie de calcul Azure. corde
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 a la valeur Null. Int
sharedGalleryImageId Uri relatif contenant une référence d’image azure Compute Gallery partagée directe. corde

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

Nom Description Valeur
extendedLocation Emplacement étendu où l’instantané sera créé. Impossible de modifier l’emplacement étendu. ExtendedLocation
emplacement Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés des ressources d’instantané. SnapshotProperties
Sku Nom de la référence sku d’instantanés. Peut être Standard_LRS, Premium_LRS ou Standard_ZRS. Il s’agit d’un paramètre facultatif pour l’instantané incrémentiel et le comportement par défaut est que la référence SKU est définie sur la même référence SKU que l’instantané précédent. snapshotSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Compute/snapshots@2023-04-02 »

PurchasePlan

Nom Description Valeur
nom ID du plan. chaîne (obligatoire)
produit Spécifie le produit de l’image à partir 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. corde
éditeur ID de l’éditeur. chaîne (obligatoire)

ResourceTags

Nom Description Valeur

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. corde
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 ne peut augmenter que la taille du disque. Int
chiffrement La propriété de chiffrement peut être utilisée pour chiffrer les 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 est 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émental 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 de 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 de l’image à partir de laquelle le disque source de l’instantané a été créé à l’origine. PurchasePlan
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 de l’instantané a été créé à l’origine. SupportedCapabilities
supportsHibernation Indique que le système d’exploitation sur un instantané prend en charge la mise en veille prolongée. Bool

SnapshotSku

Nom Description Valeur
nom Nom de la référence SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

SourceVault

Nom Description Valeur
id ID de ressource corde

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 peut être défini sur SCSI ou SCSI, NVME ou NVME, SCSI. corde