Dela via

Set-AzureRmVMExtension

  • Referens
Modul:
AzureRM.Compute

Uppdateringar tilläggsegenskaper eller lägger till ett tillägg till en virtuell dator.

Varning

AzureRM PowerShell-modulen är officiellt inaktuell från och med den 29 februari 2024. Användare rekommenderas att migrera från AzureRM till Az PowerShell-modulen för att säkerställa fortsatt support och uppdateringar.

Även om AzureRM-modulen fortfarande kan fungera, underhålls den inte längre eller stöds, vilket gör att användaren kan välja och riskera fortsatt användning. Se våra migreringsresurser för vägledning om övergången till Az-modulen.

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

Cmdleten Set-AzureRmVMExtension uppdaterar egenskaper för befintliga tillägg för virtuella datorer eller lägger till ett tillägg till en virtuell dator.

Exempel

Exempel 1: Ändra inställningar med hjälp av hash-tabeller

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;

De första två kommandona använder Windows PowerShell-standardsyntax för att skapa hash-tabeller och lagrar sedan dessa hash-tabeller i variablerna $Inställningar och $Protected Inställningar. Om du vill ha mer information skriver du Get-Help about_Hash_Tables. Det andra kommandot innehåller två värden som tidigare skapats och lagrats i variabler. Det sista kommandot ändrar ett tillägg för den virtuella datorn med namnet VirtualMachine22 i ResourceGroup11 enligt innehållet i $Inställningar och $Protected Inställningar. Kommandot anger annan nödvändig information som innehåller utgivaren och tilläggstypen.

Exempel 2: Ändra inställningar med hjälp av strängar

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 ;

De första två kommandona skapar strängar som innehåller inställningar och lagrar dem sedan i variablerna $Inställningar String och $Protected Inställningar String. Det sista kommandot ändrar ett tillägg för den virtuella datorn med namnet VirtualMachine22 i ResourceGroup11 enligt innehållet i $Inställningar String och $Protected Inställningar String. Kommandot anger annan nödvändig information som innehåller utgivaren och tilläggstypen.

Parametrar

-AsJob

Kör cmdlet i bakgrunden

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DisableAutoUpgradeMinorVersion

Anger att den här cmdleten hindrar Azure-gästagenten från att automatiskt uppdatera tilläggen till en nyare delversion. Som standard gör den här cmdleten det möjligt för gästagenten att uppdatera tilläggen.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ExtensionType

Anger tilläggstypen.

Typ:String
Alias:Type
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ForceRerun

Anger att denna cmdlet tvingar fram en omkörning av samma tilläggskonfiguration på den virtuella datorn utan att avinstallera och installera om tillägget. Värdet kan vara valfri sträng som skiljer sig från det aktuella värdet. Om forceUpdateTag inte ändras tillämpas uppdateringar av offentliga eller skyddade inställningar fortfarande av hanteraren.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Location

Anger platsen för den virtuella datorn.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Anger namnet på ett tillägg.

Typ:String
Alias:ExtensionName
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ProtectedSettings

Anger privat konfiguration för tillägget, som en hash-tabell. Den här cmdleten krypterar den privata konfigurationen.

Typ:Hashtable
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ProtectedSettingString

Anger privat konfiguration för tillägget som en sträng. Den här cmdleten krypterar den privata konfigurationen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Publisher

Anger namnet på tilläggsutgivaren. Utgivaren ger ett namn när utgivaren registrerar ett tillägg.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceGroupName

Anger namnet på resursgruppen för den virtuella datorn.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Settings

Anger offentlig konfiguration för tillägget, som en hash-tabell. Den här cmdleten krypterar inte offentlig konfiguration.

Typ:Hashtable
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SettingString

Anger offentlig konfiguration för tillägget som en sträng. Den här cmdleten krypterar inte offentlig konfiguration.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-TypeHandlerVersion

Anger vilken version av tillägget som ska användas för den här virtuella datorn.

Typ:String
Alias:HandlerVersion, Version
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-VMName

Anger namnet på en virtuell dator. Den här cmdleten ändrar tillägg för den virtuella dator som den här parametern anger.

Typ:String
Alias:ResourceName
Position:1
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

String

Hashtable

SwitchParameter

Utdata

PSAzureOperationResponse