Sdílet prostřednictvím

Set-AzVMCustomScriptExtension

Modul:
Az.Compute Module

Přidá do virtuálního počítače rozšíření vlastních skriptů.

Syntax

ByNameWithContainerAndFileNamesParameterSet (Výchozí) 

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

Rutina Set-AzVMCustomScriptExtension přidá do virtuálního počítače rozšíření virtuálního počítače vlastní skript. Toto rozšíření umožňuje spouštět na virtuálním počítači vlastní skripty.

Příklady

Příklad 1: Přidání vlastního skriptu

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

Tento příkaz přidá vlastní skript do virtuálního počítače s názvem VirtualMachine07. Soubor skriptu je contososcript.exe.

Příklad 2

Přidá do virtuálního počítače rozšíření vlastních skriptů. (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'

Parametry

-Argument

Určuje argumenty, které rozšíření skriptu předá skriptu.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Confirm

Před spuštěním cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ContainerName

Určuje název kontejneru úložiště Azure, do kterého tato rutina ukládá skript.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Vlastnosti parametru

Typ:IAzureContextContainer
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-DisableAutoUpgradeMinorVersion

Rutina Set-AzVMCustomScriptExtension přidá do virtuálního počítače rozšíření virtuálního počítače vlastní skript. Toto rozšíření umožňuje spouštět na virtuálním počítači vlastní skripty.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-FileName

Určuje název souboru skriptu. Pokud je soubor uložený ve službě Azure Blob Storage, v názvu souboru se rozlišují malá a velká písmena. Názvy souborů uložených ve službě Azure File Storage nerozlišují malá a velká písmena.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-FileUri

Určuje identifikátor URI souboru skriptu.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithFileUriParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-ForceRerun

Označuje, že tato rutina vynutí opětovné spuštění stejné konfigurace rozšíření na virtuálním počítači bez odinstalace a přeinstalace rozšíření. Hodnota může být libovolný řetězec, který se liší od aktuální hodnoty. Pokud se forceUpdateTag nezmění, aktualizace veřejných nebo chráněných nastavení se stále použijí obslužnou rutinou.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-InputObject

Objekt rozšíření virtuálního počítače

Vlastnosti parametru

Typ:VirtualMachineCustomScriptExtensionContext
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByInputObjectWithContainerAndFileNamesParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False
ByInputObjectWithFileUriParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Location

Určuje umístění virtuálního počítače.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Name

Určuje název rozšíření vlastních skriptů.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Název rozšíření

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
ByNameWithFileUriParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-NoWait

Spustí operaci a vrátí se okamžitě před dokončením operace. Pokud chcete zjistit, jestli se operace úspěšně dokončila, použijte jiný mechanismus.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ResourceGroupName

Určuje název skupiny prostředků virtuálního počítače.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
ByNameWithFileUriParameterSet
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-ResourceId

RESOURCEID rozšíření virtuálního počítače.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByResourceIdWithContainerAndFileNamesParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
ByResourceIdWithFileUriParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Run

Určuje příkaz, který se má použít, který spustí váš skript.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Spustit soubor, Command

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-SecureExecution

Označuje, že tato rutina zajišťuje, že hodnota parametru Run není přihlášena na serveru nebo vrácena uživateli pomocí rozhraní API rozšíření GET. Hodnota Spustit může obsahovat tajné kódy nebo hesla, která se mají bezpečně předat do souboru skriptu.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-StorageAccountKey

Určuje klíč kontejneru úložiště Azure.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-StorageAccountName

Určuje název účtu úložiště Azure, do kterého tato rutina ukládá skript.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-StorageEndpointSuffix

Určuje příponu koncového bodu úložiště.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-TypeHandlerVersion

Určuje verzi rozšíření, která se má použít pro tento virtuální počítač. Pokud chcete získat verzi, spusťte rutinu Get-AzVMExtensionImage s hodnotou Microsoft.Compute pro parametr PublisherName a CustomScriptExtension pro parametr Type .

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:HandlerVersion, Version

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-VMName

Určuje název virtuálního počítače. Tato rutina přidá rozšíření vlastních skriptů pro virtuální počítač, který tento parametr určuje.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Název zdroje

Sady parametrů

ByNameWithContainerAndFileNamesParameterSet
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
ByNameWithFileUriParameterSet
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-VMObject

Objekt virtuálního počítače.

Vlastnosti parametru

Typ:PSVirtualMachine
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByParentObjectWithContainerAndFileNamesParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False
ByParentObjectWithFileUriParameterSet
Position:Named
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

String

String

SwitchParameter

Výstupy

PSAzureOperationResponse