Set-AzureRmVMExtension

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

Avertissement

Le module AzureRM PowerShell a été officiellement déconseillé depuis le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Bien que le module AzureRM puisse toujours fonctionner, il n’est plus conservé ou pris en charge, plaçant toute utilisation continue à la discrétion et au risque de l’utilisateur. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntax

Set-AzureRmVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzureRmVMExtension 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

PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -Type "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 $Paramètres et $Protected Paramètres. 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 $Paramètres et de $Protected Paramètres. 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

PS C:\> $SettingsString = '{"fileUris":[],"commandToExecute":""}';
PS C:\> $ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -Type "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 $Paramètres String et $Protected Paramètres String. La commande finale modifie une extension de la machine virtuelle nommée VirtualMachine22 dans ResourceGroup11 en fonction du contenu de $Paramètres String et $Protected Paramètres String. 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
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExtensionType

Spécifie le type d’extension.

Type:String
Aliases:Type
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

Spécifie l’emplacement de la machine virtuelle.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Spécifie le nom d’une extension.

Type:String
Aliases:ExtensionName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TypeHandlerVersion

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

Type:String
Aliases:HandlerVersion, Version
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

Hashtable

SwitchParameter

Sorties

PSAzureOperationResponse