Set-AzVMCustomScriptExtension

Hiermee voegt u een aangepaste scriptextensie toe aan een virtuele machine.

Syntax

Set-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -Name <String>
   -VMObject <PSVirtualMachine>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -Name <String>
   -VMObject <PSVirtualMachine>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -ResourceId <String>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -ResourceId <String>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -InputObject <VirtualMachineCustomScriptExtensionContext>
   -ContainerName <String>
   -FileName <String[]>
   [-StorageAccountName <String>]
   [-StorageEndpointSuffix <String>]
   [-StorageAccountKey <String>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMCustomScriptExtension
   -InputObject <VirtualMachineCustomScriptExtensionContext>
   [-FileUri <String[]>]
   [-Run <String>]
   [-Argument <String>]
   [-SecureExecution]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

De cmdlet Set-AzVMCustomScriptExtension voegt een aangepaste script-extensie voor virtuele machines toe aan een virtuele machine. Met deze extensie kunt u uw eigen scripts uitvoeren op de virtuele machine.

Voorbeelden

Voorbeeld 1: Een aangepast script toevoegen

Set-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"

Met deze opdracht wordt een aangepast script toegevoegd aan de virtuele machine met de naam VirtualMachine07. Het scriptbestand is contososcript.exe.

Voorbeeld 2

Hiermee voegt u een aangepaste scriptextensie toe aan een virtuele machine. (automatisch gegenereerd)

Set-AzVMCustomScriptExtension -Argument <String> -ContainerName 'Scripts' -DefaultProfile <IAzureContextContainer> -FileName 'ContosoScript.exe' -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -Run 'myScript.ps1' -SecureExecution -StorageAccountKey <String> -StorageAccountName 'Contoso' -TypeHandlerVersion '1.1' -VMName 'VirtualMachine07'

Parameters

-Argument

Hiermee geeft u argumenten op die de scriptextensie doorgeeft aan het script.

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

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-ContainerName

Hiermee geeft u de naam op van de Azure Storage-container waarin deze cmdlet het script opslaat.

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

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

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

-FileName

Hiermee geeft u de naam van het scriptbestand. Als het bestand is opgeslagen in Azure Blob Storage, is de waarde van de bestandsnaam hoofdlettergevoelig. Bestandsnamen van bestanden die zijn opgeslagen in Azure File Storage, zijn niet hoofdlettergevoelig.

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

-FileUri

Hiermee geeft u de URI van het scriptbestand.

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

-ForceRerun

Geeft aan dat met deze cmdlet dezelfde extensieconfiguratie op de virtuele machine opnieuw wordt uitgevoerd zonder de extensie te verwijderen en opnieuw te installeren. De waarde kan elke tekenreeks zijn die verschilt van de huidige waarde. Als forceUpdateTag niet wordt gewijzigd, worden updates voor openbare of beveiligde instellingen nog steeds toegepast door de handler.

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

-InputObject

VM-extensieobject.

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

-Location

Hiermee geeft u de locatie van de virtuele machine.

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

-Name

Hiermee geeft u de naam van de aangepaste scriptextensie.

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

-NoWait

Start de bewerking en retourneert onmiddellijk voordat de bewerking is voltooid. Gebruik een ander mechanisme om te bepalen of de bewerking is voltooid.

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

-ResourceGroupName

Hiermee geeft u de naam van de resourcegroep van de virtuele machine.

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

-ResourceId

ResourceID van VM-extensie.

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

-Run

Hiermee geeft u de opdracht die moet worden gebruikt om uw script uit te voeren.

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

-SecureExecution

Geeft aan dat deze cmdlet ervoor zorgt dat de waarde van de parameter Uitvoeren niet is aangemeld op de server of wordt geretourneerd aan de gebruiker met behulp van de GET-extensie-API. De waarde van Uitvoeren kan geheimen of wachtwoorden bevatten die veilig aan het scriptbestand moeten worden doorgegeven.

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

-StorageAccountKey

Hiermee geeft u de sleutel voor de Azure-opslagcontainer op.

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

-StorageAccountName

Hiermee geeft u de naam van het Azure-opslagaccount waarin deze cmdlet het script opslaat.

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

-StorageEndpointSuffix

Hiermee geeft u het achtervoegsel van het opslageindpunt op.

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

-TypeHandlerVersion

Hiermee geeft u de versie van de extensie te gebruiken voor deze virtuele machine. Als u de versie wilt verkrijgen, voert u de cmdlet Get-AzVMExtensionImage uit met de waarde Microsoft.Compute voor de parameter PublisherName en CustomScriptExtension voor de parameter Type .

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

-VMName

Hiermee geeft u de naam van een virtuele machine. Met deze cmdlet wordt de aangepaste scriptextensie toegevoegd voor de virtuele machine die met deze parameter wordt opgegeven.

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMObject

VM-object.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

String

String[]

SwitchParameter

Uitvoerwaarden

PSAzureOperationResponse