Set-AzVMExtension

  • Référence
Module:
Az.Compute

Met à jour les propriétés d’extension ou ajoute une extension à une machine virtuelle.

Syntaxe

Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-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, voir 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

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:Nullable<T>[Boolean]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ExtensionType

Spécifie le type d’extension.

Type:String
Alias:Type
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Location

Spécifie l’emplacement de la machine virtuelle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom d’une extension.

Type:String
Alias:ExtensionName
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Publisher

Spécifie le nom du serveur de publication d’extension. L’éditeur fournit un nom lorsque l’éditeur inscrit une extension.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ResourceGroupName

Spécifie le nom du groupe de ressources de la machine virtuelle.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TypeHandlerVersion

Spécifie la version de l’extension à utiliser pour cette machine virtuelle.

Type:String
Alias:HandlerVersion, Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-VMName

Spécifie le nom d'un ordinateur virtuel. Cette applet de commande modifie les extensions de la machine virtuelle spécifiée par ce paramètre.

Type:String
Alias:ResourceName
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Hashtable

SwitchParameter

Sorties

PSAzureOperationResponse