Virtual Machine Extensions - Create Or Update
Opération de création ou de mise à jour de l’extension.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2025-04-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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 de la machine virtuelle. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| location | True |
string |
Emplacement géographique où réside 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.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 du gestionnaire de scripts. |
|
| tags |
object |
Balises de ressource. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Réussite de l’opération de mise à jour de la ressource 'VirtualMachineExtension' |
|
| 201 Created |
Ressource 'VirtualMachineExtension' : opération de création réussie En-têtes
|
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
|
Virtual |
|
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Exemple de requête
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2025-04-01
{
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
Exemple de réponse
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
location: https://foo.com/operationstatus
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen
Exemple de requête
Exemple de réponse
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
location: https://foo.com/operationstatus
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
Définitions
| Nom | Description |
|---|---|
|
Api |
Erreur d’API. |
|
Api |
Base d’erreur de l’API. |
|
Cloud |
Réponse d’erreur du service de calcul. |
|
created |
Type d’identité qui a créé la ressource. |
|
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 |
|
|
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
|
Virtual |
Décrit une extension de machine virtuelle. |
|
Virtual |
Vue d’instance d’une extension de machine virtuelle. |
ApiError
Erreur d’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d’erreur. |
| details |
Les détails de l’erreur Api |
|
| innererror |
L’erreur interne de l’API |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible de l’erreur particulière. |
ApiErrorBase
Base d’erreur de l’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. |
createdByType
Type d’identité qui a créé la ressource.
| Valeur | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
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 |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
| Nom | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
Horodatage de la création de ressources (UTC). |
| createdBy |
string |
Identité qui a créé la ressource. |
| createdByType |
Type d’identité qui a créé la ressource. |
|
| lastModifiedAt |
string (date-time) |
Horodatage de la dernière modification de ressource (UTC) |
| lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
| lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
VirtualMachineExtension
Décrit une extension de machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
Emplacement géographique où réside la ressource |
| 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 du gestionnaire de scripts. |
| systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
| tags |
object |
Balises de ressource. |
| type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
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 du gestionnaire de scripts. |