Virtual Machine Scale Set VM Extensions - Create Or Update
Opération de création ou de mise à jour de l’extension de machine virtuelle VMSS.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}?api-version=2026-04-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
instance
|
path | True |
string |
ID d’instance de la machine virtuelle. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
|
subscription
|
path | True |
string minLength: 1 |
ID de l’abonnement cible. |
|
vm
|
path | True |
string |
Nom de l’extension de machine virtuelle. |
|
vm
|
path | True |
string |
Nom du groupe de machines virtuelles identiques. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| location |
string |
Emplacement de l’extension. |
| properties.autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true. |
| properties.enableAutomaticUpgrade |
boolean |
Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible. |
| properties.forceUpdateTag |
string |
Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé. |
| properties.instanceView |
Vue d’instance d’extension de machine virtuelle. |
|
| properties.protectedSettings |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
|
| properties.protectedSettingsFromKeyVault |
Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés |
|
| properties.provisionAfterExtensions |
string[] |
Collection de noms d’extensions après lesquels cette extension doit être provisionnée. |
| properties.publisher |
string |
Nom du serveur de publication du gestionnaire d’extensions. |
| properties.settings |
Paramètres publics au format Json pour l’extension. |
|
| properties.suppressFailures |
boolean |
Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false. |
| properties.type |
string |
Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ». |
| properties.typeHandlerVersion |
string |
Spécifie la version Major.Minor du gestionnaire de script. Le client ne peut spécifier que la version Major.Minor d’une extension, la plateforme Azure proposera la dernière version Patch.Hotfix de la série Major.Minor. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Réussite de l’opération de mise à jour de la ressource « VirtualMachineScaleSetVMExtension » |
|
| 201 Created |
Ressource 'VirtualMachineScaleSetVMExtension' opération de création réussie En-têtes
|
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Flux OAuth2 d’Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| user_impersonation | Usurper l’identité de votre compte utilisateur |
Exemples
Create VirtualMachineScaleSet VM extension.
Exemple de requête
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension?api-version=2026-04-01
{
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"settings": {
"UserName": "xyz@microsoft.com"
}
}
}
Exemple de réponse
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
"id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"settings": {
"UserName": "xyz@microsoft.com"
}
}
}
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
"id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"settings": {
"UserName": "xyz@microsoft.com"
}
}
}
Définitions
| Nom | Description |
|---|---|
|
Api |
Erreur d’API. |
|
Api |
Base d’erreurs d’API. |
|
Cloud |
Réponse d’erreur du service de calcul. |
|
Inner |
Détails de l’erreur interne. |
|
Instance |
État de l’affichage de l’instance. |
|
Key |
Décrit une référence au secret Key Vault |
|
Status |
Code de niveau. |
|
Sub |
|
|
Virtual |
Vue d’instance d’une extension de machine virtuelle. |
|
Virtual |
Décrit une extension de machine virtuelle VMSS. |
ApiError
Erreur d’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur 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.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d’erreur. |
| message |
string |
Message d’erreur. |
| target |
string |
Cible de l’erreur particulière. |
CloudError
Réponse d’erreur du service de calcul.
| Nom | Type | Description |
|---|---|---|
| error |
Erreur d’API. |
InnerError
Détails de l’erreur interne.
| Nom | Type | Description |
|---|---|---|
| errordetail |
string |
Message d’erreur interne ou vidage d’exception. |
| exceptiontype |
string |
Type d'exception. |
InstanceViewStatus
État de l’affichage de l’instance.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d’état. |
| displayStatus |
string |
Étiquette localisable courte 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 (date-time) |
Heure de l’état. |
KeyVaultSecretReference
Décrit une référence au secret Key Vault
| Nom | Type | Description |
|---|---|---|
| secretUrl |
string |
URL référençant un secret dans un coffre de clés. |
| sourceVault |
URL relative du coffre de clés contenant le secret. |
StatusLevelTypes
Code de niveau.
| Valeur | Description |
|---|---|
| Info | |
| Warning | |
| Error |
SubResource
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource |
VirtualMachineExtensionInstanceView
Vue d’instance d’une extension de machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de l’extension de machine virtuelle. |
| statuses |
Informations d’état de la ressource. |
|
| substatuses |
Informations d’état de la ressource. |
|
| type |
string |
Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ». |
| typeHandlerVersion |
string |
Spécifie la version Major.Minor.Patch.Hotfix du gestionnaire de script. La plateforme Azure proposera la dernière version Patch.Hotfix de la série Major.Minor. |
VirtualMachineScaleSetVMExtension
Décrit une extension de machine virtuelle VMSS.
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource |
| location |
string |
Emplacement de l’extension. |
| name |
string |
Nom de la ressource |
| properties.autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true. |
| properties.enableAutomaticUpgrade |
boolean |
Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible. |
| properties.forceUpdateTag |
string |
Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé. |
| properties.instanceView |
Vue d’instance d’extension de machine virtuelle. |
|
| properties.protectedSettings |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
|
| properties.protectedSettingsFromKeyVault |
Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés |
|
| properties.provisionAfterExtensions |
string[] |
Collection de noms d’extensions après lesquels cette extension doit être provisionnée. |
| properties.provisioningState |
string |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
| properties.publisher |
string |
Nom du serveur de publication du gestionnaire d’extensions. |
| properties.settings |
Paramètres publics au format Json pour l’extension. |
|
| properties.suppressFailures |
boolean |
Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false. |
| properties.type |
string |
Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ». |
| properties.typeHandlerVersion |
string |
Spécifie la version Major.Minor du gestionnaire de script. Le client ne peut spécifier que la version Major.Minor d’une extension, la plateforme Azure proposera la dernière version Patch.Hotfix de la série Major.Minor. |
| type |
string |
Type de ressource |