Set-AzureRmVMCustomScriptExtension
Fügt einer virtuellen Maschine eine benutzerdefinierte Skripterweiterung hinzu.
Warnung
Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.
Obwohl das AzureRM-Modul möglicherweise weiterhin funktioniert, wird es nicht mehr gewartet, und es wird kein Support mehr angeboten. Die weitere Nutzung erfolgt daher nach Ermessen und Risiko des Benutzers. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.
Syntax
Set-AzureRmVMCustomScriptExtension
-ContainerName <String>
-FileName <String[]>
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzureRmVMCustomScriptExtension
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Beschreibung
Mit dem Cmdlet Set-AzureRmVMCustomScriptExtension wird einem virtuellen Computer eine benutzerdefinierte Skripterweiterung für virtuelle Computer hinzugefügt. Mit dieser Erweiterung können Sie eigene Skripts auf dem virtuellen Computer ausführen.
Beispiele
Beispiel 1: Hinzufügen eines benutzerdefinierten Skripts
PS C:\> Set-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"Mit diesem Befehl wird dem virtuellen Computer "VirtualMachine07" ein benutzerdefiniertes Skript hinzugefügt. Die Skriptdatei ist contososcript.exe.
Parameter
-Argument
Gibt Argumente an, die von der Skripterweiterung an das Skript übergeben werden.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Confirm
Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.
| Typ: | SwitchParameter |
| Aliase: | cf |
| Position: | Named |
| Standardwert: | False |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-ContainerName
Gibt den Namen des Azure-Speichercontainers an, in dem dieses Cmdlet das Skript speichert.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-DefaultProfile
Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.
| Typ: | IAzureContextContainer |
| Aliase: | AzureRmContext, AzureCredential |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-DisableAutoUpgradeMinorVersion
| Typ: | SwitchParameter |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-FileName
Gibt den Namen der Skriptdatei an. Wenn die Datei im Azure Blob Storage gespeichert ist, ist der Dateiname-Wert groß-/kleinschreibungsfrei. Dateinamen von Dateien, die in Azure File Storage gespeichert sind, sind nicht groß-kleinschreibungsfrei.
| Typ: | String[] |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-FileUri
Gibt den URI der Skriptdatei an.
| Typ: | String[] |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-ForceRerun
Gibt an, dass dieses Cmdlet eine erneute Ausführung derselben Erweiterungskonfiguration auf dem virtuellen Computer erzwingt, ohne die Erweiterung zu deinstallieren und neu zu installieren. Der Wert kann eine beliebige Zeichenfolge sein, die sich vom aktuellen Wert unterscheidet. Wenn forceUpdateTag nicht geändert wird, werden Updates für öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Location
Gibt den Speicherort des virtuellen Computers an.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Name
Gibt den Namen der benutzerdefinierten Skripterweiterung an.
| Typ: | String |
| Aliase: | ExtensionName |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-ResourceGroupName
Gibt den Namen der Ressourcengruppe des virtuellen Computers an.
| Typ: | String |
| Position: | 0 |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Run
Gibt den Zu verwendenden Befehl an, der Ihr Skript ausführt.
| Typ: | String |
| Aliase: | RunFile, Command |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-SecureExecution
Gibt an, dass dieses Cmdlet sicherstellt, dass der Wert des Run-Parameters nicht auf dem Server angemeldet oder mithilfe der GET-Erweiterungs-API an den Benutzer zurückgegeben wird. Der Wert von "Run" enthält möglicherweise geheime Schlüssel oder Kennwörter, die sicher an die Skriptdatei übergeben werden sollen.
| Typ: | SwitchParameter |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-StorageAccountKey
Gibt den Schlüssel für den Azure-Speichercontainer an.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-StorageAccountName
Gibt den Namen des Azure-Speicherkontos an, in dem dieses Cmdlet das Skript speichert.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-StorageEndpointSuffix
Gibt das Suffix des Speicherendpunkts an.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-TypeHandlerVersion
Gibt die Version der Erweiterung an, die für diesen virtuellen Computer verwendet werden soll. Führen Sie zum Abrufen der Version das Cmdlet "Get-AzureRmVMExtensionImage" mit dem Wert "Microsoft.Compute" für den Parameter "PublisherName " und "VMAccessAgent" für den Parameter "Type " aus.
| Typ: | String |
| Aliase: | HandlerVersion, Version |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-VMName
Gibt den Namen eines virtuellen Computers an. Dieses Cmdlet fügt die benutzerdefinierte Skripterweiterung für den virtuellen Computer hinzu, den dieser Parameter angibt.
| Typ: | String |
| Aliase: | ResourceName |
| Position: | 1 |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-WhatIf
Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
| Typ: | SwitchParameter |
| Aliase: | wi |
| Position: | Named |
| Standardwert: | False |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
Eingaben
String[]