Set-AzVMExtension
Met à jour les propriétés d’extension ou ajoute une extension à une machine virtuelle.
Syntaxe
Settings (Par défaut)
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-Settings <Hashtable>]
[-ProtectedSettings <Hashtable>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SettingString
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-SettingString <String>]
[-ProtectedSettingString <String>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Set-AzVMExtension met à jour les propriétés des extensions de machine virtuelle existantes ou ajoute une extension à une machine virtuelle.
Exemples
Exemple 1 : Modifier les paramètres à l’aide de tables de hachage
$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;
Les deux premières commandes utilisent la syntaxe Windows PowerShell standard pour créer des tables de hachage, puis stockent ces tables de hachage dans les variables $Settings et $ProtectedSettings.
Pour plus d’informations, tapez Get-Help about_Hash_Tables.
La deuxième commande inclut deux valeurs précédemment créées et stockées dans des variables.
La commande finale modifie une extension de la machine virtuelle nommée VirtualMachine22 dans ResourceGroup11 en fonction du contenu de $Settings et de $ProtectedSettings.
La commande spécifie d’autres informations requises qui incluent l’éditeur et le type d’extension.
Exemple 2 : Modifier les paramètres à l’aide de chaînes
$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;
Les deux premières commandes créent des chaînes qui contiennent des paramètres, puis les stockent dans les variables $SettingsString et $ProtectedSettingsString.
La commande finale modifie une extension de la machine virtuelle nommée VirtualMachine22 dans ResourceGroup11 en fonction du contenu de $SettingsString et de $ProtectedSettingsString.
La commande spécifie d’autres informations requises qui incluent l’éditeur et le type d’extension.
Paramètres
-AsJob
Exécuter l’applet de commande en arrière-plan
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: cf
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DisableAutoUpgradeMinorVersion
Indique que cette applet de commande empêche l’agent invité Azure de mettre automatiquement à jour les extensions vers une version mineure plus récente.
Par défaut, cette applet de commande permet à l’agent invité de mettre à jour les extensions.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-EnableAutomaticUpgrade
Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible.
Propriétés du paramètre
Type: Nullable<T> [ Boolean ]
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ExtensionType
Spécifie le type d’extension.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: Type
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-ForceRerun
Indique que cette applet de commande force une réexécution de la même configuration d’extension sur la machine virtuelle sans désinstaller et réinstaller l’extension.
La valeur peut être n’importe quelle chaîne différente de la valeur actuelle.
Si forceUpdateTag n’est pas modifié, les mises à jour apportées aux paramètres publics ou protégés sont toujours appliquées par le gestionnaire.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Location
Spécifie l’emplacement de la machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Name
Spécifie le nom d’une extension.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: ExtensionName
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-NoWait
Démarre l’opération et retourne immédiatement, avant la fin de l’opération. Pour déterminer si l’opération a bien été effectuée, utilisez un autre mécanisme.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ProtectedSettings
Spécifie la configuration privée de l’extension, en tant que table de hachage.
Cette applet de commande chiffre la configuration privée.
Propriétés du paramètre
Type: Hashtable
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
Settings
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-ProtectedSettingString
Spécifie la configuration privée de l’extension, sous forme de chaîne.
Cette applet de commande chiffre la configuration privée.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
SettingString
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Publisher
Spécifie le nom du serveur de publication d’extension.
L’éditeur fournit un nom lorsque l’éditeur inscrit une extension.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-ResourceGroupName
Spécifie le nom du groupe de ressources de la machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Settings
Spécifie la configuration publique de l’extension, en tant que table de hachage.
Cette applet de commande ne chiffre pas la configuration publique.
Propriétés du paramètre
Type: Hashtable
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
Settings
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-SettingString
Spécifie la configuration publique de l’extension, sous forme de chaîne.
Cette applet de commande ne chiffre pas la configuration publique.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
SettingString
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-TypeHandlerVersion
Spécifie la version de l’extension à utiliser pour cette machine virtuelle.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: HandlerVersion, Version
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-VMName
Spécifie le nom d’une machine virtuelle.
Cette applet de commande modifie les extensions de la machine virtuelle spécifiée par ce paramètre.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: ResourceName
Jeux de paramètres
(All)
Position: 1 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: Wi
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Sorties
