Virtual Machines - List All

Répertorie tous les ordinateurs virtuels de l’abonnement spécifié. Utilisez la propriété nextLink dans la réponse pour accéder à la page suivante des machines virtuelles.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2021-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2021-03-01&statusOnly={statusOnly}

Paramètres URI

Name In Required Type Description
subscriptionId
path True
  • string

informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API cliente.

statusOnly
query
  • string

statusOnly = true permet d’extraire l’état d’exécution de toutes les machines virtuelles de l’abonnement.

Réponses

Name Type Description
200 OK

Ok

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Définitions

AdditionalCapabilities

Active ou désactive une fonctionnalité sur la machine virtuelle ou le groupe de machines virtuelles identiques.

AdditionalUnattendContent

spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et la passe à laquelle le contenu est appliqué.

ApiError

Erreur d’API.

ApiErrorBase

Base d’erreurs d’API.

AvailablePatchSummary

Décrit les propriétés d’une vue d’instance de machine virtuelle pour obtenir un résumé des correctifs disponibles.

BillingProfile

Spécifie les détails relatifs à la facturation d’une machine virtuelle Azure spot ou VMSS.

Version d’API minimale : 2019-03-01.

BootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie et la capture d’écran de la console pour diagnostiquer l’état de la machine virtuelle.

Vous pouvez facilement afficher la sortie du journal de la console.

Azure vous permet également d’afficher une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

BootDiagnosticsInstanceView

Vue d’instance d’un diagnostic de démarrage de machine virtuelle.

CachingTypes

Obtient le type de mise en cache.

ComponentNames

Nom du composant. actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.

DataDisk

Décrit un disque de données.

DeleteOptions

Spécifier le comportement de l’interface réseau lors de la suppression de la machine virtuelle

DiagnosticsProfile

Spécifie l’état des paramètres de diagnostic de démarrage.

Version d’API minimale : 2015-06-15.

DiffDiskOptions

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.

DiffDiskPlacement

Spécifie le placement du disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache ou l’espace disque des ressources pour la configuration du disque de système d’exploitation éphémère. pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, consultez exigences de taille de disque de système d’exploitation éphémère pour Windows machine virtuelle sur https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et machine virtuelle Linux à l’adressehttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiffDiskSettings

Décrit les paramètres des paramètres de disque éphémère qui peuvent être spécifiés pour le disque du système d’exploitation.

Remarque : les paramètres de disque éphémère peuvent uniquement être spécifiés pour le disque managé.

DiskCreateOptionTypes

Spécifie la manière dont la machine virtuelle doit être créée.

Les valeurs possibles sont les suivantes :

Attacher \u2013 cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle.

FromImage \u2013 cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous utilisez également l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la place de marché, vous utilisez également l’élément plan décrit précédemment.

DiskDeleteOptionTypes

Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle.

Valeurs possibles :

Supprimer Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lors de la suppression de la machine virtuelle.

Détacher Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle.

La valeur par défaut est détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur supprimer. L’utilisateur ne peut pas modifier l’option de suppression du disque de système d’exploitation éphémère.

DiskDetachOptionTypes

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou qui est déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach.

detachOption : ForceDetach s’applique uniquement aux disques de données gérés. Si une tentative de détachement précédente du disque de données ne s’est pas terminée en raison d’une défaillance inattendue de l’ordinateur virtuel et que le disque n’est toujours pas libéré, utilisez l’option forcer le détachement en dernier recours pour détacher le disque de façon forcée de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement.

Cette fonctionnalité est toujours en mode Aperçu et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’un disque de données, mettez à jour toBeDetached sur « true » en même temps que le paramètre detachOption : « ForceDetach ».

DiskEncryptionSetParameters

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque.

Remarque : l’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. https://aka.ms/mdssewithcmkoverviewPour plus d’informations, consultez.

DiskEncryptionSettings

décrit un Paramètres de chiffrement pour un disque

DiskInstanceView

Vue d’instance du disque.

ExtendedLocation

Type complexe de l’emplacement étendu.

ExtendedLocationTypes

Type de l’emplacement étendu.

HardwareProfile

Spécifie les paramètres matériels de la machine virtuelle.

HyperVGenerationType

Spécifie le type HyperVGeneration

ImageReference

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de place de marché ou une image de machine virtuelle, mais qui n’est pas utilisée dans d’autres opérations de création. Remarque : l’éditeur de référence d’image et l’offre ne peuvent être définis que lorsque vous créez le groupe identique.

InnerError

Détails de l’erreur interne.

InstanceViewStatus

État de l’affichage de l’instance.

IPVersions

Disponible à partir de Api-Version 2019-07-01, il indique si le configuration IP spécifique est IPv4 ou IPv6. La valeur par défaut est IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».

KeyVaultKeyReference

Décrit une référence à Key Vault clé

KeyVaultSecretReference

Décrit une référence à Key Vault Secret

LastPatchInstallationSummary

Décrit les propriétés du dernier résumé des correctifs installés.

LinuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle.

Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur les distributions de Azure-Endorsed.

LinuxPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

LinuxPatchSettings

Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Linux.

LinuxVMGuestPatchMode

Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit avoir la valeur true

MaintenanceOperationResultCodeTypes

Code du dernier résultat de l’opération de maintenance.

MaintenanceRedeployStatus

État de l’opération de maintenance.

ManagedDiskParameters

Paramètres d’un disque managé.

NetworkApiVersion

spécifie la version de l’API Microsoft. Network utilisée lors de la création de ressources de mise en réseau dans les configurations de l’interface réseau

NetworkInterfaceReference

Décrit une référence d’interface réseau.

NetworkProfile

Spécifie les interfaces réseau ou la configuration réseau de l’ordinateur virtuel.

OperatingSystemTypes

Le système d’exploitation du osDiskImage.

OSDisk

Spécifie des informations sur le disque de système d’exploitation utilisé par l’ordinateur virtuel.

Pour plus d’informations sur les disques, consultez à propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

OSProfile

Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains paramètres ne peuvent pas être modifiés une fois que la machine virtuelle est approvisionnée.

PassNames

Nom du test. Actuellement, la seule valeur autorisée est OobeSystem.

PatchOperationStatus

État global de réussite ou d’échec de l’opération. Elle reste « en cours » jusqu’à ce que l’opération se termine. À ce stade, il deviendra « Unknown », « failed », « SUCCEEDED » ou « CompletedWithWarnings ».

PatchSettings

Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Windows.

Plan

Spécifie des informations sur l’image de la place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la place de marché. Avant de pouvoir utiliser une image de la place de marché à partir d’une API, vous devez activer l’image à des fins de programmation. dans la Portail Azure, recherchez l’image de la place de marché que vous souhaitez utiliser, puis cliquez sur souhaitez déployer par programmation, Prise en main->. Entrez les informations requises, puis cliquez sur Enregistrer.

ProtocolTypes

Spécifie le protocole de l’écouteur WinRM.

Les valeurs possibles sont les suivantes :
protocoles

https

PublicIPAddressSku

Décrit la référence SKU d’adresse IP publique

PublicIPAddressSkuName

Spécifier le nom de référence SKU d’adresse IP publique

PublicIPAddressSkuTier

Spécifier le niveau SKU d’adresse IP publique

PublicIPAllocationMethod

Spécifier le type d’allocation d’adresse IP publique

ResourceIdentityType

Type d’identité utilisé pour la machine virtuelle. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.

ScheduledEventsProfile
SecurityProfile

Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.

SecurityTypes

Spécifie le SecurityType de l’ordinateur virtuel. Elle est définie en tant que TrustedLaunch pour activer UefiSettings.

Valeur par défaut : UefiSettings ne sera pas activé, sauf si cette propriété est définie sur TrustedLaunch.

SettingNames

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.

SshConfiguration

Configuration SSH pour les machines virtuelles basées sur Linux exécutées sur Azure

SshPublicKey

Contient des informations sur la clé publique du certificat SSH et le chemin sur la machine virtuelle Linux où la clé publique est placée.

StatusLevelTypes

Code de niveau.

StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage du disque du système d’exploitation géré ne peut être défini que lorsque vous créez le groupe identique. Remarque : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

StorageProfile

Spécifie les paramètres de stockage des disques de machine virtuelle.

SubResource
TerminateNotificationProfile
UefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle.

Version d’API minimale : 2020-12-01

UserAssignedIdentities

Liste des identités d’utilisateur associées à la machine virtuelle. Les références de clés de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

VaultCertificate

Décrit une référence de certificat unique dans un Key Vault, et où le certificat doit résider sur la machine virtuelle.

VaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.

VirtualHardDisk

Décrit l’URI d’un disque.

VirtualMachine

Décrit un ordinateur virtuel.

VirtualMachineAgentInstanceView

Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur l’ordinateur virtuel.

VirtualMachineEvictionPolicyTypes

Spécifie la stratégie d’éviction pour l’ordinateur virtuel Azure spot et le jeu de mise à l’échelle des points Azure.

Pour les machines virtuelles Azure spot, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2019-03-01.

Pour les jeux de mise à l’échelle des points Azure, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2017-10-30-preview.

VirtualMachineExtension

Décrit une extension de machine virtuelle.

VirtualMachineExtensionHandlerInstanceView

Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.

VirtualMachineExtensionInstanceView

Vue d’instance d’une extension de machine virtuelle.

VirtualMachineHealthStatus

État d’intégrité de la machine virtuelle.

VirtualMachineIdentity

Identité de la machine virtuelle.

VirtualMachineInstanceView

Vue d’instance d’une machine virtuelle.

VirtualMachineIpTag

Contient la balise IP associée à l’adresse IP publique.

VirtualMachineListResult

Liste des réponses d’opération de l’ordinateur virtuel.

VirtualMachineNetworkInterfaceConfiguration

Décrit une configuration d’interface réseau de machine virtuelle.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Décrit les paramètres DNS d’une configuration de réseau d’ordinateurs virtuels.

VirtualMachineNetworkInterfaceIPConfiguration

Décrit la configuration IP d’un profil réseau d’ordinateur virtuel.

VirtualMachinePatchStatus

État des opérations sur les correctifs de machine virtuelle.

VirtualMachinePriorityTypes

Spécifie la priorité de la machine virtuelle.

Version d’API minimale : 2019-03-01

VirtualMachinePublicIPAddressConfiguration

Décrit la configuration PublicIPAddress d’une configuration IP de machines virtuelles

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Décrit les paramètres DNS d’une configuration de réseau d’ordinateurs virtuels.

VirtualMachineSizeTypes

Spécifie la taille de la machine virtuelle.

Le type de données enum est actuellement déconseillé et sera supprimé du 23 décembre 2023.

Méthode recommandée pour récupérer la liste des tailles disponibles à l’aide de ces API :

Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité

Répertorier toutes les tailles de machine virtuelle disponibles dans une région

Répertorie toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles de machines virtuelles, consultez tailles des machines virtuelles.

Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.

WindowsConfiguration

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

WindowsPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

WindowsVMGuestPatchMode

Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

Manuel : vous contrôlez l’application des correctifs sur une machine virtuelle. Pour ce faire, vous devez appliquer les correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées. la propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur true.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration. enableAutomaticUpdates doivent avoir la valeur true

WinRMConfiguration

décrit Windows Remote Management configuration de la machine virtuelle

WinRMListener

décrit le protocole et l’empreinte numérique de Windows Remote Management écouteur

AdditionalCapabilities

Active ou désactive une fonctionnalité sur la machine virtuelle ou le groupe de machines virtuelles identiques.

Name Type Description
ultraSSDEnabled
  • boolean

Indicateur qui active ou désactive une capacité à avoir un ou plusieurs disques de données gérés avec UltraSSD_LRS type de compte de stockage sur la machine virtuelle ou VMSS. Les disques managés avec le type de compte de stockage UltraSSD_LRS peuvent être ajoutés à un ordinateur virtuel ou à un groupe de machines virtuelles identiques uniquement si cette propriété est activée.

AdditionalUnattendContent

spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et la passe à laquelle le contenu est appliqué.

Name Type Description
componentName

Nom du composant. actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.

content
  • string

Spécifie le contenu au format XML qui est ajouté au fichier unattend.xml pour le chemin d’accès et le composant spécifiés. Le code XML doit être inférieur à 4Ko et doit inclure l’élément racine pour le paramètre ou la fonctionnalité en cours d’insertion.

passName

Nom du test. Actuellement, la seule valeur autorisée est OobeSystem.

settingName

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.

ApiError

Erreur d’API.

Name Type Description
code
  • string

Code d'erreur.

details

Détails de l’erreur de l’API

innererror

Erreur interne de l’API

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs d’API.

Name Type Description
code
  • string

Code d'erreur.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur particulière.

AvailablePatchSummary

Décrit les propriétés d’une vue d’instance de machine virtuelle pour obtenir un résumé des correctifs disponibles.

Name Type Description
assessmentActivityId
  • string

ID d’activité de l’opération qui a produit ce résultat. Il est utilisé pour mettre en corrélation les journaux de CRP et d’extension.

criticalAndSecurityPatchCount
  • integer

Le nombre de correctifs critiques ou de sécurité qui ont été détectés comme étant disponibles et pas encore installés.

error

Erreurs rencontrées lors de l’exécution de l’opération. Le tableau de détails contient la liste de ces éléments.

lastModifiedTime
  • string

Horodatage UTC au début de l’opération.

otherPatchCount
  • integer

Nombre de tous les correctifs disponibles, sauf critique et sécurité.

rebootPending
  • boolean

État de redémarrage global de la machine virtuelle. Cela est vrai lorsque des correctifs partiellement installés requièrent un redémarrage pour terminer l’installation, mais que le redémarrage n’a pas encore eu lieu.

startTime
  • string

Horodatage UTC au début de l’opération.

status

État global de réussite ou d’échec de l’opération. Elle reste « en cours » jusqu’à ce que l’opération se termine. À ce stade, il deviendra « Unknown », « failed », « SUCCEEDED » ou « CompletedWithWarnings ».

BillingProfile

Spécifie les détails relatifs à la facturation d’une machine virtuelle Azure spot ou VMSS.

Version d’API minimale : 2019-03-01.

Name Type Description
maxPrice
  • number

Spécifie le prix maximal que vous êtes prêt à payer pour une machine virtuelle Azure spot VMSS. Ce prix est en dollars américains.

Ce prix sera comparé au tarif de l’emplacement Azure actuel pour la taille de la machine virtuelle. En outre, les prix sont comparés au moment de la création/mise à jour d’Azure direct VM/VMSS et l’opération échoue uniquement si le maxPrice est supérieur au tarif de la place de marché Azure actuel.

Le maxPrice est également utilisé pour supprimer une machine virtuelle/VMSS Azure spot si le prix de la place Azure actuel dépasse le maxPrice après la création d’une machine virtuelle/VMSS.

Les valeurs possibles sont les suivantes :

-Toute valeur décimale supérieure à zéro. Exemple : 0,01538

-1 – indique le prix par défaut à la demande.

Vous pouvez affecter la valeur-1 à maxPrice pour indiquer que la machine virtuelle/VMSS Azure spot ne doit pas être supprimée pour des raisons de prix. En outre, le prix maximal par défaut est-1 s’il n’est pas fourni par vous.

Version d’API minimale : 2019-03-01.

BootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie et la capture d’écran de la console pour diagnostiquer l’état de la machine virtuelle.

Vous pouvez facilement afficher la sortie du journal de la console.

Azure vous permet également d’afficher une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

Name Type Description
enabled
  • boolean

Indique si les diagnostics de démarrage doivent être activés sur la machine virtuelle.

storageUri
  • string

URI du compte de stockage à utiliser pour placer la capture d’écran et la sortie de la console.

Si storageUri n’est pas spécifié lors de l’activation des diagnostics de démarrage, le stockage managé est utilisé.

BootDiagnosticsInstanceView

Vue d’instance d’un diagnostic de démarrage de machine virtuelle.

Name Type Description
consoleScreenshotBlobUri
  • string

URI de l’objet blob de capture d’écran de la console.

Remarque : cela ne sera pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.

serialConsoleLogBlobUri
  • string

URI de l’objet BLOB du journal de la console série.

Remarque : cela ne sera pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.

status

Informations d’état des diagnostics de démarrage de la machine virtuelle.

Remarque : elle sera définie uniquement si des erreurs se sont produites lors de l’activation des diagnostics de démarrage.

CachingTypes

Obtient le type de mise en cache.

Name Type Description
None
  • string
ReadOnly
  • string
ReadWrite
  • string

ComponentNames

Nom du composant. actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.

Name Type Description
Microsoft-Windows-Shell-Setup
  • string

DataDisk

Décrit un disque de données.

Name Type Description
caching

Spécifie les exigences de mise en cache.

Les valeurs possibles sont les suivantes :

Aucun

Lecture seule

Lecture/écriture

Valeur par défaut : aucune pour le stockage standard. ReadOnly pour le stockage Premium

createOption

Spécifie la manière dont la machine virtuelle doit être créée.

Les valeurs possibles sont les suivantes :

Attacher \u2013 cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle.

FromImage \u2013 cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous utilisez également l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la place de marché, vous utilisez également l’élément plan décrit précédemment.

deleteOption

Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle.

Valeurs possibles :

Supprimer Si cette valeur est utilisée, le disque de données est supprimé lors de la suppression de la machine virtuelle.

Détacher Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle.

La valeur par défaut est détacher .

detachOption

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou qui est déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach.

detachOption : ForceDetach s’applique uniquement aux disques de données gérés. Si une tentative de détachement précédente du disque de données ne s’est pas terminée en raison d’une défaillance inattendue de l’ordinateur virtuel et que le disque n’est toujours pas libéré, utilisez l’option forcer le détachement en dernier recours pour détacher le disque de façon forcée de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement.

Cette fonctionnalité est toujours en mode Aperçu et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’un disque de données, mettez à jour toBeDetached sur « true » en même temps que le paramètre detachOption : « ForceDetach ».

diskIOPSReadWrite
  • integer

Spécifie les e/s par seconde Read-Write pour le disque managé lorsque StorageAccountType est UltraSSD_LRS. Retourné uniquement pour les disques de machine virtuelle VirtualMachine identiques. Ne peut être mis à jour qu’à l’aide des mises à jour du groupe de machines virtuelles VirtualMachine.

diskMBpsReadWrite
  • integer

Spécifie la bande passante en Mo par seconde pour le disque managé lorsque StorageAccountType est UltraSSD_LRS. Retourné uniquement pour les disques de machine virtuelle VirtualMachine identiques. Ne peut être mis à jour qu’à l’aide des mises à jour du groupe de machines virtuelles VirtualMachine.

diskSizeGB
  • integer

Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle.

Cette valeur ne peut pas être supérieure à 1023 Go

image

Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel sera copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.

lun
  • integer

Spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données dans la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle.

managedDisk

Paramètres du disque managé.

name
  • string

Nom du disque.

toBeDetached
  • boolean

Spécifie si le disque de données est en cours de détachement du VirtualMachine/VirtualMachineScaleset

vhd

Disque dur virtuel.

writeAcceleratorEnabled
  • boolean

Spécifie si les writeAccelerator doivent être activés ou désactivés sur le disque.

DeleteOptions

Spécifier le comportement de l’interface réseau lors de la suppression de la machine virtuelle

Name Type Description
Delete
  • string
Detach
  • string

DiagnosticsProfile

Spécifie l’état des paramètres de diagnostic de démarrage.

Version d’API minimale : 2015-06-15.

Name Type Description
bootDiagnostics

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie et la capture d’écran de la console pour diagnostiquer l’état de la machine virtuelle.

Vous pouvez facilement afficher la sortie du journal de la console.

Azure vous permet également d’afficher une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

DiffDiskOptions

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.

Name Type Description
Local
  • string

DiffDiskPlacement

Spécifie le placement du disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache ou l’espace disque des ressources pour la configuration du disque de système d’exploitation éphémère. pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, consultez exigences de taille de disque de système d’exploitation éphémère pour Windows machine virtuelle sur https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et machine virtuelle Linux à l’adressehttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Name Type Description
CacheDisk
  • string
ResourceDisk
  • string

DiffDiskSettings

Décrit les paramètres des paramètres de disque éphémère qui peuvent être spécifiés pour le disque du système d’exploitation.

Remarque : les paramètres de disque éphémère peuvent uniquement être spécifiés pour le disque managé.

Name Type Description
option

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.

placement

Spécifie le placement du disque éphémère pour le disque du système d’exploitation.

Les valeurs possibles sont les suivantes :

CacheDisk

ResourceDisk

Valeur par défaut : CacheDisk si l’une des machines virtuelles est configurée pour la taille de machine virtuelle, sinon ResourceDisk est utilisé.

reportez-vous à la documentation sur la taille de machine virtuelle pour Windows machine virtuelle sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et Linux à l’adresse https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier les tailles de machine virtuelle qui exposent un disque de cache.

DiskCreateOptionTypes

Spécifie la manière dont la machine virtuelle doit être créée.

Les valeurs possibles sont les suivantes :

Attacher \u2013 cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle.

FromImage \u2013 cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous utilisez également l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la place de marché, vous utilisez également l’élément plan décrit précédemment.

Name Type Description
Attach
  • string
Empty
  • string
FromImage
  • string

DiskDeleteOptionTypes

Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle.

Valeurs possibles :

Supprimer Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lors de la suppression de la machine virtuelle.

Détacher Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle.

La valeur par défaut est détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur supprimer. L’utilisateur ne peut pas modifier l’option de suppression du disque de système d’exploitation éphémère.

Name Type Description
Delete
  • string
Detach
  • string

DiskDetachOptionTypes

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou qui est déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach.

detachOption : ForceDetach s’applique uniquement aux disques de données gérés. Si une tentative de détachement précédente du disque de données ne s’est pas terminée en raison d’une défaillance inattendue de l’ordinateur virtuel et que le disque n’est toujours pas libéré, utilisez l’option forcer le détachement en dernier recours pour détacher le disque de façon forcée de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement.

Cette fonctionnalité est toujours en mode Aperçu et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’un disque de données, mettez à jour toBeDetached sur « true » en même temps que le paramètre detachOption : « ForceDetach ».

Name Type Description
ForceDetach
  • string

DiskEncryptionSetParameters

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque.

Remarque : l’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. https://aka.ms/mdssewithcmkoverviewPour plus d’informations, consultez.

Name Type Description
id
  • string

ID de ressource

DiskEncryptionSettings

décrit un Paramètres de chiffrement pour un disque

Name Type Description
diskEncryptionKey

Spécifie l’emplacement de la clé de chiffrement de disque, qui est une Key Vault secrète.

enabled
  • boolean

Spécifie si le chiffrement de disque doit être activé sur l’ordinateur virtuel.

keyEncryptionKey

Spécifie l’emplacement de la clé de chiffrement à clé dans Key Vault.

DiskInstanceView

Vue d’instance du disque.

Name Type Description
encryptionSettings

Spécifie les paramètres de chiffrement du disque du système d’exploitation.

Version d’API minimale : 2015-06-15

name
  • string

Nom du disque.

statuses

Informations sur l’état des ressources.

ExtendedLocation

Type complexe de l’emplacement étendu.

Name Type Description
name
  • string

Nom de l’emplacement étendu.

type

Type de l’emplacement étendu.

ExtendedLocationTypes

Type de l’emplacement étendu.

Name Type Description
EdgeZone
  • string

HardwareProfile

Spécifie les paramètres matériels de la machine virtuelle.

Name Type Description
vmSize

Spécifie la taille de la machine virtuelle.

Le type de données enum est actuellement déconseillé et sera supprimé du 23 décembre 2023.

Méthode recommandée pour récupérer la liste des tailles disponibles à l’aide de ces API :

Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité

Répertorier toutes les tailles de machine virtuelle disponibles dans une région

Répertorie toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles de machines virtuelles, consultez tailles des machines virtuelles.

Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.

HyperVGenerationType

Spécifie le type HyperVGeneration

Name Type Description
V1
  • string
V2
  • string

ImageReference

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de place de marché ou une image de machine virtuelle, mais qui n’est pas utilisée dans d’autres opérations de création. Remarque : l’éditeur de référence d’image et l’offre ne peuvent être définis que lorsque vous créez le groupe identique.

Name Type Description
exactVersion
  • string

Spécifie des nombres décimaux, la version de l’image de plateforme ou de l’image de la place de marché utilisée pour créer la machine virtuelle. Ce champ ReadOnly diffère de « version », uniquement si la valeur spécifiée dans le champ « version » est « latest ».

id
  • string

ID de ressource

offer
  • string

Spécifie l’offre de l’image de plateforme ou de l’image de place de marché utilisée pour créer la machine virtuelle.

publisher
  • string

Éditeur d’images.

sku
  • string

Référence SKU de l’image.

version
  • string

Spécifie la version de l’image de plateforme ou de l’image de place de marché utilisée pour créer la machine virtuelle. Les formats autorisés sont major. minor. Build ou’latest'. Major, minor et Build sont des nombres décimaux. Spécifiez « latest » pour utiliser la version la plus récente d’une image disponible au moment du déploiement. Même si vous utilisez’latest', l’image de machine virtuelle n’est pas automatiquement mise à jour après le déploiement, même si une nouvelle version est disponible.

InnerError

Détails de l’erreur interne.

Name Type Description
errordetail
  • string

Le message d’erreur interne ou le vidage de l’exception.

exceptiontype
  • string

Type d'exception.

InstanceViewStatus

État de l’affichage de l’instance.

Name Type Description
code
  • string

Code d'état.

displayStatus
  • string

Étiquette abrégée localisable pour l’État.

level

Code de niveau.

message
  • string

Message d’état détaillé, y compris pour les alertes et les messages d’erreur.

time
  • string

Heure de l’État.

IPVersions

Disponible à partir de Api-Version 2019-07-01, il indique si le configuration IP spécifique est IPv4 ou IPv6. La valeur par défaut est IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».

Name Type Description
IPv4
  • string
IPv6
  • string

KeyVaultKeyReference

Décrit une référence à Key Vault clé

Name Type Description
keyUrl
  • string

URL faisant référence à une clé de chiffrement à clé dans Key Vault.

sourceVault

URL relative de l’Key Vault contenant la clé.

KeyVaultSecretReference

Décrit une référence à Key Vault Secret

Name Type Description
secretUrl
  • string

URL référençant une clé secrète dans un Key Vault.

sourceVault

URL relative de l’Key Vault contenant le secret.

LastPatchInstallationSummary

Décrit les propriétés du dernier résumé des correctifs installés.

Name Type Description
error

Erreurs rencontrées lors de l’exécution de l’opération. Le tableau de détails contient la liste de ces éléments.

excludedPatchCount
  • integer

Nombre de tous les correctifs disponibles, mais exclus explicitement par une correspondance de liste d’exclusion spécifiée par le client.

failedPatchCount
  • integer

Nombre de correctifs dont l’installation a échoué.

installationActivityId
  • string

ID d’activité de l’opération qui a produit ce résultat. Il est utilisé pour mettre en corrélation les journaux de CRP et d’extension.

installedPatchCount
  • integer

Nombre de correctifs installés avec succès.

lastModifiedTime
  • string

Horodatage UTC au début de l’opération.

maintenanceWindowExceeded
  • boolean

Indique si l’opération a été exécutée avant la fin de toutes les actions prévues

notSelectedPatchCount
  • integer

Nombre de tous les correctifs disponibles, mais qui ne vont pas être installés car il ne correspondait pas à une entrée de classification ou de liste d’inclusion.

pendingPatchCount
  • integer

Le nombre de tous les correctifs disponibles censés être installés au cours de l’opération d’installation des correctifs.

startTime
  • string

Horodatage UTC au début de l’opération.

status

État global de réussite ou d’échec de l’opération. Elle reste « en cours » jusqu’à ce que l’opération se termine. À ce stade, il deviendra « Unknown », « failed », « SUCCEEDED » ou « CompletedWithWarnings ».

LinuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle.

Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur les distributions de Azure-Endorsed.

Name Type Description
disablePasswordAuthentication
  • boolean

Spécifie si l’authentification par mot de passe doit être désactivée.

patchSettings

[Fonctionnalité en version préliminaire] Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Linux.

provisionVMAgent
  • boolean

Indique si l'agent de machine virtuelle doit être configuré sur la machine virtuelle.

Quand cette propriété n’est pas spécifiée dans le corps de la demande, le comportement par défaut consiste à lui affecter la valeur true. Cela permet de s’assurer que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.

ssh

Spécifie la configuration de la clé SSH pour un système d’exploitation Linux.

LinuxPatchAssessmentMode

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

LinuxPatchSettings

Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Linux.

Name Type Description
assessmentMode

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

patchMode

Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit avoir la valeur true

LinuxVMGuestPatchMode

Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit avoir la valeur true

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

MaintenanceOperationResultCodeTypes

Code du dernier résultat de l’opération de maintenance.

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

État de l’opération de maintenance.

Name Type Description
isCustomerInitiatedMaintenanceAllowed
  • boolean

True si le client est autorisé à effectuer la maintenance.

lastOperationMessage
  • string

Message retourné pour la dernière opération de maintenance.

lastOperationResultCode

Code du dernier résultat de l’opération de maintenance.

maintenanceWindowEndTime
  • string

Heure de fin de la fenêtre de maintenance.

maintenanceWindowStartTime
  • string

Heure de début de la fenêtre de maintenance.

preMaintenanceWindowEndTime
  • string

Heure de fin de la fenêtre de pré-maintenance.

preMaintenanceWindowStartTime
  • string

Heure de début de la fenêtre de pré-maintenance.

ManagedDiskParameters

Paramètres d’un disque managé.

Name Type Description
diskEncryptionSet

Spécifie l’ID de ressource du jeu de chiffrement de disque géré par le client pour le disque managé.

id
  • string

ID de ressource

storageAccountType

Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage du disque du système d’exploitation géré ne peut être défini que lorsque vous créez le groupe identique. Remarque : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

NetworkApiVersion

spécifie la version de l’API Microsoft. Network utilisée lors de la création de ressources de mise en réseau dans les configurations de l’interface réseau

Name Type Description
2020-11-01
  • string

NetworkInterfaceReference

Décrit une référence d’interface réseau.

Name Type Description
id
  • string

ID de ressource

properties.deleteOption

Spécifier le comportement de l’interface réseau lors de la suppression de la machine virtuelle

properties.primary
  • boolean

Spécifie l’interface réseau principale au cas où l’ordinateur virtuel dispose d’une interface réseau supérieure à 1.

NetworkProfile

Spécifie les interfaces réseau ou la configuration réseau de l’ordinateur virtuel.

Name Type Description
networkApiVersion

spécifie la version de l’API Microsoft. Network utilisée lors de la création de ressources de mise en réseau dans les configurations de l’interface réseau

networkInterfaceConfigurations

Spécifie les configurations de mise en réseau qui seront utilisées pour créer les ressources réseau de l’ordinateur virtuel.

networkInterfaces

Spécifie la liste des ID de ressource pour les interfaces réseau associées à la machine virtuelle.

OperatingSystemTypes

Le système d’exploitation du osDiskImage.

Name Type Description
Linux
  • string
Windows
  • string

OSDisk

Spécifie des informations sur le disque de système d’exploitation utilisé par l’ordinateur virtuel.

Pour plus d’informations sur les disques, consultez à propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

Name Type Description
caching

Spécifie les exigences de mise en cache.

Les valeurs possibles sont les suivantes :

Aucun

Lecture seule

Lecture/écriture

Valeur par défaut : aucune pour le stockage standard. ReadOnly pour le stockage Premium.

createOption

Spécifie la manière dont la machine virtuelle doit être créée.

Les valeurs possibles sont les suivantes :

Attacher \u2013 cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle.

FromImage \u2013 cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous utilisez également l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la place de marché, vous utilisez également l’élément plan décrit précédemment.

deleteOption

Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle.

Valeurs possibles :

Supprimer Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lors de la suppression de la machine virtuelle.

Détacher Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle.

La valeur par défaut est détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur supprimer. L’utilisateur ne peut pas modifier l’option de suppression du disque de système d’exploitation éphémère.

diffDiskSettings

spécifie le disque éphémère Paramètres pour le disque du système d’exploitation utilisé par l’ordinateur virtuel.

diskSizeGB
  • integer

Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle.

Cette valeur ne peut pas être supérieure à 1023 Go

encryptionSettings

Spécifie les paramètres de chiffrement du disque du système d’exploitation.

Version d’API minimale : 2015-06-15

image

Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel sera copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.

managedDisk

Paramètres du disque managé.

name
  • string

Nom du disque.

osType

Cette propriété vous permet de spécifier le type du système d’exploitation qui est inclus dans le disque en cas de création d’une machine virtuelle à partir d’une image d’utilisateur ou d’un disque dur virtuel spécialisé.

Les valeurs possibles sont les suivantes :

Windows

Linux

vhd

Disque dur virtuel.

writeAcceleratorEnabled
  • boolean

Spécifie si les writeAccelerator doivent être activés ou désactivés sur le disque.

OSProfile

Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains paramètres ne peuvent pas être modifiés une fois que la machine virtuelle est approvisionnée.

Name Type Description
adminPassword
  • string

Spécifie le mot de passe du compte administrateur.

longueur minimale (Windows) : 8 caractères

Longueur minimale (Linux) : 6 caractères

longueur Max (Windows) : 123 caractères

Longueur maximale (Linux) : 72 caractères

Exigences de complexité : 3 conditions sur 4 ci-dessous doivent être remplies
Contient des caractères inférieurs
A des caractères supérieurs
A un chiffre
A un caractère spécial (correspondance regex [\ W_])

Valeurs non autorisées : « abc@123 », « P@ $ $w 0rd », « P@ssw0rd », « P@ssword123 », « PA $ $Word », « pass@word1 », « Password ! », « Password1 », « Password22 », « ILOVEYOU ! »

pour réinitialisation du mot de passe, consultez comment réinitialiser le service Bureau à distance ou son mot de passe de connexion dans une machine virtuelle Windows

Pour réinitialiser le mot de passe racine, consultez gérer les utilisateurs, SSH et vérifier ou réparer les disques sur les machines virtuelles Linux Azure à l’aide de l’extension VMAccess

adminUsername
  • string

Spécifie le nom du compte administrateur.

Cette propriété ne peut pas être mise à jour après la création de la machine virtuelle.

restriction de Windows uniquement : Ne peut pas se terminer par "."

Valeurs non autorisées : « administrateur », « admin », « utilisateur », « utilisateur1 », « test », « utilisateur2 », « test1 », « utilisateur3 », « admin1 », « 1 », « 123 », « a », « actuser », « ADM », « un administrateur 2 », « ASPNET », « Backup », « console », « David », « Guest », « John », « Owner », « root », « Server », « SQL », « support », « support_388945a0 », « sys », « test2 », « test3 », « User4 », « user5 ».

Longueur minimale (Linux) : 1 caractère

Longueur maximale (Linux) : 64 caractères

longueur Max (Windows) : 20 caractères.

allowExtensionOperations
  • boolean

Spécifie si les opérations d’extension doivent être autorisées sur l’ordinateur virtuel.

Il peut uniquement être défini sur false quand aucune extension n’est présente sur la machine virtuelle.

computerName
  • string

Spécifie le nom du système d’exploitation hôte de la machine virtuelle.

Ce nom ne peut pas être mis à jour après la création de la machine virtuelle.

longueur Max (Windows) : 15 caractères

Longueur maximale (Linux) : 64 caractères.

Pour connaître les conventions d’affectation des noms et les restrictions, consultez instructions d’implémentation des services d’infrastructure Azure.

customData
  • string

Spécifie une chaîne codée en base 64 de données personnalisées. La chaîne codée en base 64 est décodée dans un tableau binaire enregistré dans un fichier sur la machine virtuelle. La longueur maximale du tableau binaire est 65535 octets.

Remarque : ne transmettez pas de secrets ou de mots de passe dans la propriété customData

Cette propriété ne peut pas être mise à jour après la création de la machine virtuelle.

customData est transmis à la machine virtuelle pour être enregistré en tant que fichier. pour plus d’informations, consultez données personnalisées sur les machines virtuelles Azure .

Pour utiliser Cloud-init pour votre machine virtuelle Linux, consultez utilisation de Cloud-init pour personnaliser une machine virtuelle Linux lors de la création

linuxConfiguration

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle.

Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur les distributions de Azure-Endorsed.

requireGuestProvisionSignal
  • boolean

Spécifie si le signal de configuration de l’invité est requis pour déduire la réussite de la configuration de l’ordinateur virtuel. Remarque : cette propriété est destinée uniquement au test privé, et tous les clients ne doivent pas affecter la valeur false à la propriété.

secrets

Spécifie le jeu de certificats à installer sur la machine virtuelle. Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l' extension de machine virtuelle Azure Key Vault pour Linux ou l' extension de machine virtuelle Azure Key Vault pour Windows.

windowsConfiguration

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

PassNames

Nom du test. Actuellement, la seule valeur autorisée est OobeSystem.

Name Type Description
OobeSystem
  • string

PatchOperationStatus

État global de réussite ou d’échec de l’opération. Elle reste « en cours » jusqu’à ce que l’opération se termine. À ce stade, il deviendra « Unknown », « failed », « SUCCEEDED » ou « CompletedWithWarnings ».

Name Type Description
CompletedWithWarnings
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string
Unknown
  • string

PatchSettings

Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Windows.

Name Type Description
assessmentMode

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

enableHotpatching
  • boolean

Permet aux clients de corriger leurs machines virtuelles Azure sans nécessiter un redémarrage. Pour enableHotpatching, « provisionVMAgent » doit avoir la valeur true et « patchMode » doit avoir la valeur « AutomaticByPlatform ».

patchMode

Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

Les valeurs possibles sont les suivantes :

Manuel : vous contrôlez l’application des correctifs sur une machine virtuelle. Pour ce faire, vous devez appliquer les correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées. la propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur true.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration. enableAutomaticUpdates doivent avoir la valeur true

Plan

Spécifie des informations sur l’image de la place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la place de marché. Avant de pouvoir utiliser une image de la place de marché à partir d’une API, vous devez activer l’image à des fins de programmation. dans la Portail Azure, recherchez l’image de la place de marché que vous souhaitez utiliser, puis cliquez sur souhaitez déployer par programmation, Prise en main->. Entrez les informations requises, puis cliquez sur Enregistrer.

Name Type Description
name
  • string

ID de plan.

product
  • string

Spécifie le produit de l’image à partir de la place de marché. Il s’agit de la même valeur que l’offre sous l’élément imageReference.

promotionCode
  • string

Code promotionnel.

publisher
  • string

ID de l’éditeur.

ProtocolTypes

Spécifie le protocole de l’écouteur WinRM.

Les valeurs possibles sont les suivantes :
protocoles

https

Name Type Description
Http
  • string
Https
  • string

PublicIPAddressSku

Décrit la référence SKU d’adresse IP publique

Name Type Description
name

Spécifier le nom de référence SKU d’adresse IP publique

tier

Spécifier le niveau SKU d’adresse IP publique

PublicIPAddressSkuName

Spécifier le nom de référence SKU d’adresse IP publique

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

Spécifier le niveau SKU d’adresse IP publique

Name Type Description
Global
  • string
Regional
  • string

PublicIPAllocationMethod

Spécifier le type d’allocation d’adresse IP publique

Name Type Description
Dynamic
  • string
Static
  • string

ResourceIdentityType

Type d’identité utilisé pour la machine virtuelle. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ScheduledEventsProfile

Name Type Description
terminateNotificationProfile

Spécifie la fin des configurations liées aux événements planifiés.

SecurityProfile

Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.

Name Type Description
encryptionAtHost
  • boolean

Cette propriété peut être utilisée par l’utilisateur dans la demande d’activation ou de désactivation du chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque de ressource/Temp sur l’hôte lui-même.

Valeur par défaut : le chiffrement sur l’hôte est désactivé, sauf si cette propriété a la valeur true pour la ressource.

securityType

Spécifie le SecurityType de l’ordinateur virtuel. Elle est définie en tant que TrustedLaunch pour activer UefiSettings.

Valeur par défaut : UefiSettings ne sera pas activé, sauf si cette propriété est définie sur TrustedLaunch.

uefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle.

Version d’API minimale : 2020-12-01

SecurityTypes

Spécifie le SecurityType de l’ordinateur virtuel. Elle est définie en tant que TrustedLaunch pour activer UefiSettings.

Valeur par défaut : UefiSettings ne sera pas activé, sauf si cette propriété est définie sur TrustedLaunch.

Name Type Description
TrustedLaunch
  • string

SettingNames

Spécifie le nom du paramètre auquel le contenu s'applique. Les valeurs possibles sont : FirstLogonCommands et AutoLogon.

Name Type Description
AutoLogon
  • string
FirstLogonCommands
  • string

SshConfiguration

Configuration SSH pour les machines virtuelles basées sur Linux exécutées sur Azure

Name Type Description
publicKeys

Liste des clés publiques SSH utilisées pour l’authentification auprès des machines virtuelles Linux.

SshPublicKey

Contient des informations sur la clé publique du certificat SSH et le chemin sur la machine virtuelle Linux où la clé publique est placée.

Name Type Description
keyData
  • string

Certificat de clé publique SSH utilisé pour l’authentification auprès de la machine virtuelle via SSH. La clé doit être au moins 2048 bits et au format SSH-RSA.

Pour créer des clés SSH, consultez [créer des clés SSH sur Linux et Mac pour les machines virtuelles Linux dans Azure] https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed) .

path
  • string

Spécifie le chemin d’accès complet sur la machine virtuelle créée où est stockée la clé publique SSH. Si le fichier existe déjà, la clé spécifiée est automatiquement ajoutée au fichier. Exemple:/Home/user/.ssh/authorized_keys

StatusLevelTypes

Code de niveau.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage du disque du système d’exploitation géré ne peut être défini que lorsque vous créez le groupe identique. Remarque : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

Name Type Description
Premium_LRS
  • string
Premium_ZRS
  • string
StandardSSD_LRS
  • string
StandardSSD_ZRS
  • string
Standard_LRS
  • string
UltraSSD_LRS
  • string

StorageProfile

Spécifie les paramètres de stockage des disques de machine virtuelle.

Name Type Description
dataDisks

Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle.

Pour plus d’informations sur les disques, consultez à propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

imageReference

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de place de marché ou une image de machine virtuelle, mais qui n’est pas utilisée dans d’autres opérations de création.

osDisk

Spécifie des informations sur le disque de système d’exploitation utilisé par l’ordinateur virtuel.

Pour plus d’informations sur les disques, consultez à propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

SubResource

Name Type Description
id
  • string

ID de ressource

TerminateNotificationProfile

Name Type Description
enable
  • boolean

Spécifie si l’événement planifié Terminate est activé ou désactivé.

notBeforeTimeout
  • string

Durée configurable pendant laquelle la suppression d’un ordinateur virtuel devra potentiellement approuver l’événement planifié de fin avant l’approbation automatique de l’événement (délai dépassé). La configuration doit être spécifiée au format ISO 8601, la valeur par défaut est 5 minutes (PT5M)

UefiSettings

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle.

Version d’API minimale : 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

Spécifie si le démarrage sécurisé doit être activé sur la machine virtuelle.

Version d’API minimale : 2020-12-01

vTpmEnabled
  • boolean

Spécifie si vTPM doit être activé sur l’ordinateur virtuel.

Version d’API minimale : 2020-12-01

UserAssignedIdentities

Liste des identités d’utilisateur associées à la machine virtuelle. Les références de clés de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

Name Type Description

VaultCertificate

Décrit une référence de certificat unique dans un Key Vault, et où le certificat doit résider sur la machine virtuelle.

Name Type Description
certificateStore
  • string

pour les machines virtuelles Windows, spécifie le magasin de certificats sur la Machine virtuelle à laquelle le certificat doit être ajouté. Le magasin de certificats spécifié est implicitement dans le compte LocalMachine.

Pour les machines virtuelles Linux, le fichier de certificat est placé sous le répertoire/var/lib/waagent, avec le nom de fichier < UppercaseThumbprint > . CRT pour le fichier de certificat x509 et < UppercaseThumbprint > . PRV pour la clé privée. Ces deux fichiers sont au format. pem.

certificateUrl
  • string

Il s’agit de l’URL d’un certificat qui a été chargé sur Key Vault en tant que secret. Pour ajouter un secret à la Key Vault, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être l’encodage Base64 de l’objet JSON suivant, qui est encodé au format UTF-8 :

{
« Data » : « <encodée en base64-Certificate> »,
« dataType » : « pfx »,
« Password » : «  »
}
Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l' extension de machine virtuelle Azure Key Vault pour Linux ou l' extension de machine virtuelle Azure Key Vault pour Windows.

VaultSecretGroup

Décrit un ensemble de certificats qui se trouvent tous dans le même Key Vault.

Name Type Description
sourceVault

URL relative de l’Key Vault contenant tous les certificats dans VaultCertificates.

vaultCertificates

Liste des références de coffre de clés dans SourceVault qui contiennent des certificats.

VirtualHardDisk

Décrit l’URI d’un disque.

Name Type Description
uri
  • string

Spécifie l’URI du disque dur virtuel.

VirtualMachine

Décrit un ordinateur virtuel.

Name Type Description
extendedLocation

Emplacement étendu de l’ordinateur virtuel.

id
  • string

ID de ressource

identity

Identité de la machine virtuelle, si elle est configurée.

location
  • string

Emplacement de la ressource

name
  • string

Nom de la ressource

plan

Spécifie des informations sur l’image de la place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la place de marché. Avant de pouvoir utiliser une image de la place de marché à partir d’une API, vous devez activer l’image à des fins de programmation. dans la Portail Azure, recherchez l’image de la place de marché que vous souhaitez utiliser, puis cliquez sur souhaitez déployer par programmation, Prise en main->. Entrez les informations requises, puis cliquez sur Enregistrer.

properties.additionalCapabilities

Spécifie que des fonctionnalités supplémentaires sont activées ou désactivées sur la machine virtuelle.

properties.availabilitySet

Spécifie des informations sur le groupe à haute disponibilité auquel la machine virtuelle doit être affectée. Les machines virtuelles spécifiées dans le même groupe à haute disponibilité sont attribuées à des nœuds différents pour optimiser la disponibilité. Pour plus d’informations sur les groupes à haute disponibilité, consultez vue d’ensemble des groupes à haute disponibilité.

Pour plus d’informations sur la maintenance planifiée Azure, consultez maintenance et mises à jour pour les machines virtuelles dans Azure

Actuellement, une machine virtuelle ne peut être ajoutée qu’à un groupe à haute disponibilité au moment de la création. Le groupe à haute disponibilité auquel la machine virtuelle est ajoutée doit se trouver sous le même groupe de ressources que la ressource de groupe à haute disponibilité. Impossible d’ajouter une machine virtuelle existante à un groupe à haute disponibilité.

Cette propriété ne peut pas exister avec une référence de propriétés. virtualMachineScaleSet non null.

properties.billingProfile

Spécifie les détails relatifs à la facturation d’une machine virtuelle Azure spot.

Version d’API minimale : 2019-03-01.

properties.diagnosticsProfile

Spécifie l’état des paramètres de diagnostic de démarrage.

Version d’API minimale : 2015-06-15.

properties.evictionPolicy

Spécifie la stratégie d’éviction pour l’ordinateur virtuel Azure spot et le jeu de mise à l’échelle des points Azure.

Pour les machines virtuelles Azure spot, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2019-03-01.

Pour les jeux de mise à l’échelle des points Azure, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2017-10-30-preview.

properties.extensionsTimeBudget
  • string

Spécifie le temps imparti pour le démarrage de toutes les extensions. La durée doit être comprise entre 15 minutes et 120 minutes (inclusives) et doit être spécifiée au format ISO 8601. La valeur par défaut est de 90 minutes (PT1H30M).

Version d’API minimale : 2020-06-01

properties.hardwareProfile

Spécifie les paramètres matériels de la machine virtuelle.

properties.host

Spécifie des informations sur l’hôte dédié dans lequel réside l’ordinateur virtuel.

Version d’API minimale : 2018-10-01.

properties.hostGroup

Spécifie des informations sur le groupe hôte dédié dans lequel réside l’ordinateur virtuel.

Version d’API minimale : 2020-06-01.

Remarque : l’utilisateur ne peut pas spécifier à la fois les propriétés Host et hostGroup.

properties.instanceView

Vue de l’instance de machine virtuelle.

properties.licenseType
  • string

Spécifie que l’image ou le disque utilisé a été concédé sous licence localement.

les valeurs possibles pour le système d’exploitation Windows Server sont les suivantes :

Windows_Client

Windows_Server

Les valeurs possibles pour le système d’exploitation Linux Server sont les suivantes :

RHEL_BYOS (pour RHEL)

SLES_BYOS (pour SUSE)

pour plus d’informations, consultez Azure Hybrid Use Benefit pour Windows Server

Azure Hybrid Use Benefit pour le serveur Linux

Version d’API minimale : 2015-06-15

properties.networkProfile

Spécifie les interfaces réseau de la machine virtuelle.

properties.osProfile

Spécifie les paramètres de système d’exploitation utilisés lors de la création de la machine virtuelle. Certains paramètres ne peuvent pas être modifiés une fois que la machine virtuelle est approvisionnée.

properties.platformFaultDomain
  • integer

Spécifie le domaine d’erreur logique du groupe identique dans lequel la machine virtuelle sera créée. Par défaut, l’ordinateur virtuel est automatiquement affecté à un domaine d’erreur qui gère le mieux l’équilibre entre les domaines d’erreur disponibles.

  • Cela s’applique uniquement si la propriété « virtualMachineScaleSet » de cet ordinateur virtuel est définie.
  • Le groupe de machines virtuelles identiques référencé doit avoir « platformFaultDomainCount » > 1.
  • Cette propriété ne peut pas être mise à jour une fois que l’ordinateur virtuel est créé.
  • L’attribution de domaine d’erreur peut être affichée dans la vue d’instance de machine virtuelle.

    Version minimale d’API ‐ : 2020 ‐ 12 ‐ 01

  • properties.priority

    Spécifie la priorité de la machine virtuelle.

    Version d’API minimale : 2019-03-01

    properties.provisioningState
    • string

    État d’approvisionnement, qui apparaît uniquement dans la réponse.

    properties.proximityPlacementGroup

    Spécifie des informations sur le groupe de placement de proximité auquel la machine virtuelle doit être affectée.

    Version d’API minimale : 2018-04-01.

    properties.scheduledEventsProfile

    Spécifie les configurations liées aux événements planifiés.

    properties.securityProfile

    Spécifie les paramètres de profil relatifs à la sécurité pour la machine virtuelle.

    properties.storageProfile

    Spécifie les paramètres de stockage des disques de machine virtuelle.

    properties.userData
    • string

    UserData pour la machine virtuelle, qui doit être encodé en base 64. Le client ne doit pas transmettre de secrets ici.

    Version d’API minimale : 2021-03-01

    properties.virtualMachineScaleSet

    Spécifie des informations sur le groupe de machines virtuelles identiques auquel la machine virtuelle doit être affectée. Les machines virtuelles spécifiées dans le même groupe de machines virtuelles identiques sont allouées à différents nœuds afin d’optimiser la disponibilité. Actuellement, une machine virtuelle ne peut être ajoutée qu’à un groupe de machines virtuelles identiques au moment de la création. Une machine virtuelle existante ne peut pas être ajoutée à un groupe de machines virtuelles identiques.

    Cette propriété ne peut pas exister avec une référence de propriétés. lesquelles non null.

    Version minimale de l’API ‐ : 2019 ‐ 03 ‐ 01

    properties.vmId
    • string

    Spécifie l’ID unique de machine virtuelle, qui est un identificateur 128 bits qui est encodé et stocké dans toutes les machines virtuelles Azure IaaS, et qui peut être lu à l’aide des commandes BIOS de la plateforme.

    resources

    Ressources de l’extension enfant de la machine virtuelle.

    tags
    • object

    Balises de ressource

    type
    • string

    Type de ressource

    zones
    • string[]

    Zones de machines virtuelles.

    VirtualMachineAgentInstanceView

    Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur l’ordinateur virtuel.

    Name Type Description
    extensionHandlers

    Vue d’instance du gestionnaire d’extensions de machine virtuelle.

    statuses

    Informations sur l’état des ressources.

    vmAgentVersion
    • string

    Version complète de l’agent de machine virtuelle.

    VirtualMachineEvictionPolicyTypes

    Spécifie la stratégie d’éviction pour l’ordinateur virtuel Azure spot et le jeu de mise à l’échelle des points Azure.

    Pour les machines virtuelles Azure spot, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2019-03-01.

    Pour les jeux de mise à l’échelle des points Azure, « DEALLOCATE » et « DELETE » sont pris en charge et la version d’API minimale est 2017-10-30-preview.

    Name Type Description
    Deallocate
    • string
    Delete
    • string

    VirtualMachineExtension

    Décrit une extension de machine virtuelle.

    Name Type Description
    id
    • string

    ID de ressource

    location
    • string

    Emplacement de la ressource

    name
    • string

    Nom de la ressource

    properties.autoUpgradeMinorVersion
    • boolean

    Indique si l’extension doit utiliser une version mineure plus récente si celle-ci est disponible au moment du déploiement. Toutefois, une fois déployée, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même si cette propriété a la valeur true.

    properties.enableAutomaticUpgrade
    • boolean

    Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est disponible.

    properties.forceUpdateTag
    • string

    Comment la mise à jour du gestionnaire d’extensions doit être forcée, même si la configuration de l’extension n’a pas changé.

    properties.instanceView

    Vue d’instance de l’extension de machine virtuelle.

    properties.protectedSettings
    • object

    L’extension peut contenir soit protectedSettings, soit protectedSettingsFromKeyVault, soit aucun paramètre protégé.

    properties.provisioningState
    • string

    État d’approvisionnement, qui apparaît uniquement dans la réponse.

    properties.publisher
    • string

    Nom de l’éditeur du gestionnaire d’extensions.

    properties.settings
    • object

    Paramètres publics au format JSON pour l’extension.

    properties.type
    • string

    Spécifie le type de l’extension ; par exemple, « CustomScriptExtension ».

    properties.typeHandlerVersion
    • string

    Spécifie la version du gestionnaire de script.

    tags
    • object

    Balises de ressource

    type
    • string

    Type de ressource

    VirtualMachineExtensionHandlerInstanceView

    Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.

    Name Type Description
    status

    État du gestionnaire d’extensions.

    type
    • string

    Spécifie le type de l’extension ; par exemple, « CustomScriptExtension ».

    typeHandlerVersion
    • string

    Spécifie la version du gestionnaire de script.

    VirtualMachineExtensionInstanceView

    Vue d’instance d’une extension de machine virtuelle.

    Name Type Description
    name
    • string

    Nom de l’extension de machine virtuelle.

    statuses

    Informations sur l’état des ressources.

    substatuses

    Informations sur l’état des ressources.

    type
    • string

    Spécifie le type de l’extension ; par exemple, « CustomScriptExtension ».

    typeHandlerVersion
    • string

    Spécifie la version du gestionnaire de script.

    VirtualMachineHealthStatus

    État d’intégrité de la machine virtuelle.

    Name Type Description
    status

    Informations sur l’état d’intégrité de la machine virtuelle.

    VirtualMachineIdentity

    Identité de la machine virtuelle.

    Name Type Description
    principalId
    • string

    ID principal de l’identité de l’ordinateur virtuel. Cette propriété est fournie uniquement pour une identité attribuée par le système.

    tenantId
    • string

    ID de locataire associé à la machine virtuelle. Cette propriété est fournie uniquement pour une identité attribuée par le système.

    type

    Type d’identité utilisé pour la machine virtuelle. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.

    userAssignedIdentities

    Liste des identités d’utilisateur associées à la machine virtuelle. Les références de clés de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

    VirtualMachineInstanceView

    Vue d’instance d’une machine virtuelle.

    Name Type Description
    assignedHost
    • string

    ID de ressource de l’hôte dédié, sur lequel l’ordinateur virtuel est alloué via le placement automatique, lorsque l’ordinateur virtuel est associé à un groupe hôte dédié pour lequel le placement automatique est activé.

    Version d’API minimale : 2020-06-01.

    bootDiagnostics

    Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie et la capture d’écran de la console pour diagnostiquer l’état de la machine virtuelle.

    Vous pouvez facilement afficher la sortie du journal de la console.

    Azure vous permet également d’afficher une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

    computerName
    • string

    Nom de l’ordinateur affecté à l’ordinateur virtuel.

    disks

    Informations sur le disque de la machine virtuelle.

    extensions

    Informations sur les extensions.

    hyperVGeneration

    Spécifie le type HyperVGeneration associé à une ressource

    maintenanceRedeployStatus

    État de l’opération de maintenance sur la machine virtuelle.

    osName
    • string

    Le système d’exploitation s’exécutant sur la machine virtuelle.

    osVersion
    • string

    Version du système d’exploitation en cours d’exécution sur la machine virtuelle.

    patchStatus

    [Fonctionnalité en version préliminaire] État des opérations sur les correctifs de machine virtuelle.

    platformFaultDomain
    • integer

    Spécifie le domaine par défaut de la machine virtuelle.

    platformUpdateDomain
    • integer

    Spécifie le domaine de mise à jour de la machine virtuelle.

    rdpThumbPrint
    • string

    Empreinte numérique du certificat Bureau à distance.

    statuses

    Informations sur l’état des ressources.

    vmAgent

    Agent de machine virtuelle en cours d’exécution sur la machine virtuelle.

    vmHealth

    État d’intégrité de la machine virtuelle.

    VirtualMachineIpTag

    Contient la balise IP associée à l’adresse IP publique.

    Name Type Description
    ipTagType
    • string

    Type de balise IP. Exemple : FirstPartyUsage.

    tag
    • string

    Balise IP associée à l’adresse IP publique. exemple : SQL, Stockage etc.

    VirtualMachineListResult

    Liste des réponses d’opération de l’ordinateur virtuel.

    Name Type Description
    nextLink
    • string

    URI permettant d’extraire la page suivante de machines virtuelles. Appelez ListNext () avec cet URI pour extraire la page suivante de machines virtuelles.

    value

    Liste des machines virtuelles.

    VirtualMachineNetworkInterfaceConfiguration

    Décrit une configuration d’interface réseau de machine virtuelle.

    Name Type Description
    name
    • string

    Nom de la configuration de l’interface réseau.

    properties.deleteOption

    Spécifier le comportement de l’interface réseau lors de la suppression de la machine virtuelle

    properties.dnsSettings

    Paramètres DNS à appliquer sur les interfaces réseau.

    properties.dscpConfiguration
    properties.enableAcceleratedNetworking
    • boolean

    Spécifie si l’interface réseau est optimisée pour la mise en réseau accélérée.

    properties.enableFpga
    • boolean

    Spécifie si l’interface réseau est compatible avec la mise en réseau FPGA.

    properties.enableIPForwarding
    • boolean

    Indique si le transfert IP est activé sur cette carte réseau.

    properties.ipConfigurations

    Spécifie les configurations IP de l’interface réseau.

    properties.networkSecurityGroup

    Groupe de sécurité réseau.

    properties.primary
    • boolean

    Spécifie l’interface réseau principale au cas où l’ordinateur virtuel dispose d’une interface réseau supérieure à 1.

    VirtualMachineNetworkInterfaceDnsSettingsConfiguration

    Décrit les paramètres DNS d’une configuration de réseau d’ordinateurs virtuels.

    Name Type Description
    dnsServers
    • string[]

    Liste des adresses IP des serveurs DNS

    VirtualMachineNetworkInterfaceIPConfiguration

    Décrit la configuration IP d’un profil réseau d’ordinateur virtuel.

    Name Type Description
    name
    • string

    Nom de la configuration IP.

    properties.applicationGatewayBackendAddressPools

    Spécifie un tableau de références aux pools d’adresses principaux des passerelles d’application. Un ordinateur virtuel peut faire référence à des pools d’adresses principaux de plusieurs passerelles d’application. Plusieurs machines virtuelles ne peuvent pas utiliser la même passerelle Application Gateway.

    properties.applicationSecurityGroups

    Spécifie un tableau de références au groupe de sécurité d’application.

    properties.loadBalancerBackendAddressPools

    Spécifie un tableau de références aux pools d’adresses principaux des équilibreurs de charge. Un ordinateur virtuel peut faire référence à un pool d’adresses principal d’un équilibreur de charge public et interne. [Plusieurs machines virtuelles ne peuvent pas utiliser le même équilibrage de charge de référence SKU de base].

    properties.primary
    • boolean

    Spécifie l’interface réseau principale au cas où l’ordinateur virtuel dispose d’une interface réseau supérieure à 1.

    properties.privateIPAddressVersion

    Disponible à partir de Api-Version 2017-03-30, il indique si le configuration IP spécifique est IPv4 ou IPv6. La valeur par défaut est IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».

    properties.publicIPAddressConfiguration

    PublicIPAddressConfiguration.

    properties.subnet

    Spécifie l’identificateur du sous-réseau.

    VirtualMachinePatchStatus

    État des opérations sur les correctifs de machine virtuelle.

    Name Type Description
    availablePatchSummary

    Résumé des correctifs disponibles pour la dernière opération d’évaluation de la machine virtuelle.

    configurationStatuses

    État d’activation du patchMode spécifié.

    lastPatchInstallationSummary

    Résumé de l’installation de la dernière opération d’installation de la machine virtuelle.

    VirtualMachinePriorityTypes

    Spécifie la priorité de la machine virtuelle.

    Version d’API minimale : 2019-03-01

    Name Type Description
    Low
    • string
    Regular
    • string
    Spot
    • string

    VirtualMachinePublicIPAddressConfiguration

    Décrit la configuration PublicIPAddress d’une configuration IP de machines virtuelles

    Name Type Description
    name
    • string

    Nom de la configuration de l’adresse adresse IP publique.

    properties.deleteOption

    Spécifier ce qui arrive à l’adresse IP publique lors de la suppression de la machine virtuelle

    properties.dnsSettings

    Paramètres DNS à appliquer aux adresses adresse IP publique.

    properties.idleTimeoutInMinutes
    • integer

    Délai d’inactivité de l’adresse IP publique.

    properties.ipTags

    Liste des balises IP associées à l’adresse IP publique.

    properties.publicIPAddressVersion

    Disponible à partir de Api-Version 2019-07-01, il indique si le configuration IP spécifique est IPv4 ou IPv6. La valeur par défaut est IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».

    properties.publicIPAllocationMethod

    Spécifier le type d’allocation d’adresse IP publique

    properties.publicIPPrefix

    PublicIPPrefix à partir duquel les adresses adresse IP publique sont allouées.

    sku

    Décrit la référence SKU d’adresse IP publique

    VirtualMachinePublicIPAddressDnsSettingsConfiguration

    Décrit les paramètres DNS d’une configuration de réseau d’ordinateurs virtuels.

    Name Type Description
    domainNameLabel
    • string

    Préfixe d’étiquette du nom de domaine des ressources PublicIPAddress qui seront créées. L’étiquette de nom générée est la concaténation de l’étiquette de nom de domaine et de l’ID unique du profil de réseau d’ordinateurs virtuels.

    VirtualMachineSizeTypes

    Spécifie la taille de la machine virtuelle.

    Le type de données enum est actuellement déconseillé et sera supprimé du 23 décembre 2023.

    Méthode recommandée pour récupérer la liste des tailles disponibles à l’aide de ces API :

    Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité

    Répertorier toutes les tailles de machine virtuelle disponibles dans une région

    Répertorie toutes les tailles de machine virtuelle disponibles pour le redimensionnement. Pour plus d’informations sur les tailles de machines virtuelles, consultez tailles des machines virtuelles.

    Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.

    Name Type Description
    Basic_A0
    • string
    Basic_A1
    • string
    Basic_A2
    • string
    Basic_A3
    • string
    Basic_A4
    • string
    Standard_A0
    • string
    Standard_A1
    • string
    Standard_A10
    • string
    Standard_A11
    • string
    Standard_A1_v2
    • string
    Standard_A2
    • string
    Standard_A2_v2
    • string
    Standard_A2m_v2
    • string
    Standard_A3
    • string
    Standard_A4
    • string
    Standard_A4_v2
    • string
    Standard_A4m_v2
    • string
    Standard_A5
    • string
    Standard_A6
    • string
    Standard_A7
    • string
    Standard_A8
    • string
    Standard_A8_v2
    • string
    Standard_A8m_v2
    • string
    Standard_A9
    • string
    Standard_B1ms
    • string
    Standard_B1s
    • string
    Standard_B2ms
    • string
    Standard_B2s
    • string
    Standard_B4ms
    • string
    Standard_B8ms
    • string
    Standard_D1
    • string
    Standard_D11
    • string
    Standard_D11_v2
    • string
    Standard_D12
    • string
    Standard_D12_v2
    • string
    Standard_D13
    • string
    Standard_D13_v2
    • string
    Standard_D14
    • string
    Standard_D14_v2
    • string
    Standard_D15_v2
    • string
    Standard_D16_v3
    • string
    Standard_D16s_v3
    • string
    Standard_D1_v2
    • string
    Standard_D2
    • string
    Standard_D2_v2
    • string
    Standard_D2_v3
    • string
    Standard_D2s_v3
    • string
    Standard_D3
    • string
    Standard_D32_v3
    • string
    Standard_D32s_v3
    • string
    Standard_D3_v2
    • string
    Standard_D4
    • string
    Standard_D4_v2
    • string
    Standard_D4_v3
    • string
    Standard_D4s_v3
    • string
    Standard_D5_v2
    • string
    Standard_D64_v3
    • string
    Standard_D64s_v3
    • string
    Standard_D8_v3
    • string
    Standard_D8s_v3
    • string
    Standard_DS1
    • string
    Standard_DS11
    • string
    Standard_DS11_v2
    • string
    Standard_DS12
    • string
    Standard_DS12_v2
    • string
    Standard_DS13
    • string
    Standard_DS13-2_v2
    • string
    Standard_DS13-4_v2
    • string
    Standard_DS13_v2
    • string
    Standard_DS14
    • string
    Standard_DS14-4_v2
    • string
    Standard_DS14-8_v2
    • string
    Standard_DS14_v2
    • string
    Standard_DS15_v2
    • string
    Standard_DS1_v2
    • string
    Standard_DS2
    • string
    Standard_DS2_v2
    • string
    Standard_DS3
    • string
    Standard_DS3_v2
    • string
    Standard_DS4
    • string
    Standard_DS4_v2
    • string
    Standard_DS5_v2
    • string
    Standard_E16_v3
    • string
    Standard_E16s_v3
    • string
    Standard_E2_v3
    • string
    Standard_E2s_v3
    • string
    Standard_E32-16_v3
    • string
    Standard_E32-8s_v3
    • string
    Standard_E32_v3
    • string
    Standard_E32s_v3
    • string
    Standard_E4_v3
    • string
    Standard_E4s_v3
    • string
    Standard_E64-16s_v3
    • string
    Standard_E64-32s_v3
    • string
    Standard_E64_v3
    • string
    Standard_E64s_v3
    • string
    Standard_E8_v3
    • string
    Standard_E8s_v3
    • string
    Standard_F1
    • string
    Standard_F16
    • string
    Standard_F16s
    • string
    Standard_F16s_v2
    • string
    Standard_F1s
    • string
    Standard_F2
    • string
    Standard_F2s
    • string
    Standard_F2s_v2
    • string
    Standard_F32s_v2
    • string
    Standard_F4
    • string
    Standard_F4s
    • string
    Standard_F4s_v2
    • string
    Standard_F64s_v2
    • string
    Standard_F72s_v2
    • string
    Standard_F8
    • string
    Standard_F8s
    • string
    Standard_F8s_v2
    • string
    Standard_G1
    • string
    Standard_G2
    • string
    Standard_G3
    • string
    Standard_G4
    • string
    Standard_G5
    • string
    Standard_GS1
    • string
    Standard_GS2
    • string
    Standard_GS3
    • string
    Standard_GS4
    • string
    Standard_GS4-4
    • string
    Standard_GS4-8
    • string
    Standard_GS5
    • string
    Standard_GS5-16
    • string
    Standard_GS5-8
    • string
    Standard_H16
    • string
    Standard_H16m
    • string
    Standard_H16mr
    • string
    Standard_H16r
    • string
    Standard_H8
    • string
    Standard_H8m
    • string
    Standard_L16s
    • string
    Standard_L32s
    • string
    Standard_L4s
    • string
    Standard_L8s
    • string
    Standard_M128-32ms
    • string
    Standard_M128-64ms
    • string
    Standard_M128ms
    • string
    Standard_M128s
    • string
    Standard_M64-16ms
    • string
    Standard_M64-32ms
    • string
    Standard_M64ms
    • string
    Standard_M64s
    • string
    Standard_NC12
    • string
    Standard_NC12s_v2
    • string
    Standard_NC12s_v3
    • string
    Standard_NC24
    • string
    Standard_NC24r
    • string
    Standard_NC24rs_v2
    • string
    Standard_NC24rs_v3
    • string
    Standard_NC24s_v2
    • string
    Standard_NC24s_v3
    • string
    Standard_NC6
    • string
    Standard_NC6s_v2
    • string
    Standard_NC6s_v3
    • string
    Standard_ND12s
    • string
    Standard_ND24rs
    • string
    Standard_ND24s
    • string
    Standard_ND6s
    • string
    Standard_NV12
    • string
    Standard_NV24
    • string
    Standard_NV6
    • string

    WindowsConfiguration

    Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

    Name Type Description
    additionalUnattendContent

    Spécifie des informations supplémentaires au format XML encodées en base 64 pouvant être incluses dans le fichier Unattend.xml. Ce fichier est utilisé par le programme d'installation de Windows.

    enableAutomaticUpdates
    • boolean

    indique si Mises à jour automatiques est activé pour l’ordinateur virtuel Windows. La valeur par défaut est true.

    Pour les groupes de machines virtuelles identiques, cette propriété peut être mise à jour et les mises à jour prennent effet lors de la reconfiguration du système d’exploitation.

    patchSettings

    [Fonctionnalité en version préliminaire] Spécifie les paramètres liés à la mise à jour corrective invité de machine virtuelle sur Windows.

    provisionVMAgent
    • boolean

    Indique si l'agent de machine virtuelle doit être configuré sur la machine virtuelle.

    Quand cette propriété n’est pas spécifiée dans le corps de la demande, le comportement par défaut consiste à lui affecter la valeur true. Cela permet de s’assurer que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.

    timeZone
    • string

    Spécifie le fuseau horaire de l’ordinateur virtuel. par exemple, « Pacific Standard Time ».

    Les valeurs possibles peuvent être la valeur TimeZoneInfo.ID des fuseaux horaires retournés par TimeZoneInfo. GetSystemTimeZones.

    winRM

    spécifie les écouteurs Windows Remote Management. Cela active le Windows PowerShell distant.

    WindowsPatchAssessmentMode

    Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

    Les valeurs possibles sont les suivantes :

    ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

    AutomaticByPlatform : la plateforme déclenchera des évaluations périodiques des correctifs. La propriété provisionVMAgent doit avoir la valeur true.

    Name Type Description
    AutomaticByPlatform
    • string
    ImageDefault
    • string

    WindowsVMGuestPatchMode

    Spécifie le mode de mise à jour corrective invité de machine virtuelle à une machine virtuelle IaaS ou à des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode comme flexible.

    Les valeurs possibles sont les suivantes :

    Manuel : vous contrôlez l’application des correctifs sur une machine virtuelle. Pour ce faire, vous devez appliquer les correctifs manuellement à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées. la propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur false

    AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration. enableAutomaticUpdates doit avoir la valeur true.

    AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration. enableAutomaticUpdates doivent avoir la valeur true

    Name Type Description
    AutomaticByOS
    • string
    AutomaticByPlatform
    • string
    Manual
    • string

    WinRMConfiguration

    décrit Windows Remote Management configuration de la machine virtuelle

    Name Type Description
    listeners

    liste des écouteurs Windows Remote Management

    WinRMListener

    décrit le protocole et l’empreinte numérique de Windows Remote Management écouteur

    Name Type Description
    certificateUrl
    • string

    Il s’agit de l’URL d’un certificat qui a été chargé sur Key Vault en tant que secret. Pour ajouter un secret à la Key Vault, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être l’encodage Base64 de l’objet JSON suivant, qui est encodé au format UTF-8 :

    {
    « Data » : « <encodée en base64-Certificate> »,
    « dataType » : « pfx »,
    « Password » : «  »
    }
    Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l' extension de machine virtuelle Azure Key Vault pour Linux ou l' extension de machine virtuelle Azure Key Vault pour Windows.

    protocol

    Spécifie le protocole de l’écouteur WinRM.

    Les valeurs possibles sont les suivantes :
    protocoles

    https