Dela via


Set-AzVMCustomScriptExtension

Lägger till ett anpassat skripttillägg till en virtuell dator.

Syntax

ByNameWithContainerAndFileNamesParameterSet (Standard)

Set-AzVMCustomScriptExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    -ContainerName <String>
    -FileName <String[]>
    [-Name <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>]

ByNameWithFileUriParameterSet

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>]

ByParentObjectWithContainerAndFileNamesParameterSet

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>]

ByParentObjectWithFileUriParameterSet

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>]

ByResourceIdWithContainerAndFileNamesParameterSet

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>]

ByResourceIdWithFileUriParameterSet

Set-AzVMCustomScriptExtension
    -ResourceId <String>
    [-FileUri <String[]>]
    [-Run <String>]
    [-Argument <String>]
    [-SecureExecution]
    [-TypeHandlerVersion <String>]
    [-Location <String>]
    [-DisableAutoUpgradeMinorVersion]
    [-ForceRerun <String>]
    [-NoWait]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByInputObjectWithContainerAndFileNamesParameterSet

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>]

ByInputObjectWithFileUriParameterSet

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

Cmdleten Set-AzVMCustomScriptExtension lägger till ett anpassat tillägg för virtuella skript till en virtuell dator. Med det här tillägget kan du köra egna skript på den virtuella datorn.

Exempel

Exempel 1: Lägg till ett anpassat skript

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

Det här kommandot lägger till ett anpassat skript till den virtuella datorn med namnet VirtualMachine07. Skriptfilen är contososcript.exe.

Exempel 2

Lägger till ett anpassat skripttillägg till en virtuell dator. (autogenerated)

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'

Parametrar

-Argument

Anger argument som skripttillägget skickar till skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Confirm

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ContainerName

Anger namnet på Azure Storage-containern där den här cmdleten lagrar skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-DefaultProfile

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

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DisableAutoUpgradeMinorVersion

Cmdleten Set-AzVMCustomScriptExtension lägger till ett anpassat tillägg för virtuella skript till en virtuell dator. Med det här tillägget kan du köra egna skript på den virtuella datorn.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-FileName

Anger namnet på skriptfilen. Om filen lagras i Azure Blob Storage är filnamnsvärdet skiftlägeskänsligt. Filnamn för filer som lagras i Azure File Storage är inte skiftlägeskänsliga.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-FileUri

Anger URI:n för skriptfilen.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithFileUriParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-InputObject

Objekt för VM-tillägg.

Parameteregenskaper

Typ:VirtualMachineCustomScriptExtensionContext
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByInputObjectWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByInputObjectWithFileUriParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Location

Anger platsen för den virtuella datorn.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Name

Anger namnet på det anpassade skripttillägget.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:ExtensionName

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByNameWithFileUriParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-NoWait

Startar åtgärden och returnerar omedelbart innan åtgärden har slutförts. Använd någon annan mekanism för att avgöra om åtgärden har slutförts.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByNameWithFileUriParameterSet
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-ResourceId

Resurs-ID för VM-tillägg.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByResourceIdWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByResourceIdWithFileUriParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Run

Anger det kommando som ska användas för att köra skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:RunFile, Befallning

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-SecureExecution

Anger att den här cmdleten ser till att värdet för körparametern inte loggas på servern eller returneras till användaren med hjälp av GET-tilläggs-API:et. Värdet för Kör kan innehålla hemligheter eller lösenord som ska skickas till skriptfilen på ett säkert sätt.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-StorageAccountKey

Anger nyckeln för Azure Storage-containern.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-StorageAccountName

Anger namnet på det Azure Storage-konto där den här cmdleten lagrar skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-StorageEndpointSuffix

Anger suffixet för lagringsslutpunkten.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TypeHandlerVersion

Anger vilken version av tillägget som ska användas för den här virtuella datorn. Hämta versionen genom att köra cmdleten Get-AzVMExtensionImage med värdet Microsoft.Compute för parametern PublisherName och CustomScriptExtension för parametern Type .

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:HandlerVersion, Utgåva

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-VMName

Anger namnet på en virtuell dator. Den här cmdleten lägger till det anpassade skripttillägget för den virtuella datorn som den här parametern anger.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Resursnamn

Parameteruppsättningar

ByNameWithContainerAndFileNamesParameterSet
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByNameWithFileUriParameterSet
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-VMObject

VM-objekt.

Parameteregenskaper

Typ:PSVirtualMachine
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByParentObjectWithContainerAndFileNamesParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByParentObjectWithFileUriParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

String

SwitchParameter

Utdata

PSAzureOperationResponse