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=2024-03-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources. |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
vm
|
path | True |
string |
Nom de l’extension de machine virtuelle. |
vm
|
path | True |
string |
Nom de la machine virtuelle sur laquelle l’extension doit être créée ou mise à jour. |
api-version
|
query | True |
string |
Version de l’API cliente. |
Corps de la demande
Nom | Type | Description |
---|---|---|
location |
string |
Emplacement de la ressource |
properties.autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur 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 le gestionnaire d’extensions doit être forcé à mettre à jour même si la configuration de l’extension n’a pas changé. |
properties.instanceView |
L’extension de machine virtuelle instance vue. |
|
properties.protectedSettings |
object |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
properties.protectedSettingsFromKeyVault |
Les extensions ont protégé les paramètres qui sont transmis 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 |
object |
Paramètres publics au format Json pour l’extension. |
properties.suppressFailures |
boolean |
Indique si les échecs liés à l’extension seront supprimés (les échecs opérationnels tels que le fait de ne pas se connecter à la machine virtuelle ne seront pas supprimés, quelle que soit 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 script. |
tags |
object |
Balises de ressource |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
201 Created |
Date de création |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
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=2024-03-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’erreurs de l’API. |
Cloud |
Réponse d’erreur du service de calcul. |
Inner |
Détails internes de l’erreur. |
Instance |
Vue d’instance status. |
Key |
Décrit une référence à Key Vault Secret |
Status |
Code de niveau. |
Sub |
|
Virtual |
Décrit une extension de machine virtuelle. |
Virtual |
Vue instance d’une extension de machine virtuelle. |
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 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. |
InnerError
Détails internes de l’erreur.
Nom | Type | Description |
---|---|---|
errordetail |
string |
Message d’erreur interne ou vidage d’exception. |
exceptiontype |
string |
Type d'exception. |
InstanceViewStatus
Vue d’instance status.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'état. |
displayStatus |
string |
Étiquette courte localisable pour le status. |
level |
Code de niveau. |
|
message |
string |
Message de status détaillé, y compris pour les alertes et les messages d’erreur. |
time |
string |
Heure du status. |
KeyVaultSecretReference
Décrit une référence à Key Vault Secret
Nom | Type | Description |
---|---|---|
secretUrl |
string |
URL référençant un secret dans un Key Vault. |
sourceVault |
URL relative du Key Vault contenant le secret. |
StatusLevelTypes
Code de niveau.
Nom | Type | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource |
VirtualMachineExtension
Décrit une extension de machine virtuelle.
Nom | 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 une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur 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 le gestionnaire d’extensions doit être forcé à mettre à jour même si la configuration de l’extension n’a pas changé. |
properties.instanceView |
L’extension de machine virtuelle instance vue. |
|
properties.protectedSettings |
object |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
properties.protectedSettingsFromKeyVault |
Les extensions ont protégé les paramètres qui sont transmis 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 |
object |
Paramètres publics au format Json pour l’extension. |
properties.suppressFailures |
boolean |
Indique si les échecs liés à l’extension seront supprimés (les échecs opérationnels tels que le fait de ne pas se connecter à la machine virtuelle ne seront pas supprimés, quelle que soit 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 script. |
tags |
object |
Balises de ressource |
type |
string |
Type de ressource |
VirtualMachineExtensionInstanceView
Vue instance d’une extension de machine virtuelle.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de l’extension de machine virtuelle. |
statuses |
La ressource status informations. |
|
substatuses |
La ressource status informations. |
|
type |
string |
Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ». |
typeHandlerVersion |
string |
Spécifie la version du gestionnaire de script. |