Set-AzVMCustomScriptExtension

模組:

Az.Compute Module

將自訂指令碼延伸模組新增至虛擬機器。

語法

ByNameWithContainerAndFileNamesParameterSet (預設值)

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

Set-AzVMCustomScriptExtension Cmdlet 會將自訂腳本虛擬機器延伸模組新增至虛擬機器。 此擴充功能可讓您在虛擬機器上執行自己的腳本。

範例

範例 1：新增自訂指令碼

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

此命令將自訂指令碼新增至名為 VirtualMachine07 的虛擬機器。 指令碼檔案 contososcript.exe。

範例 2

將自訂指令碼延伸模組新增至虛擬機器。 (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'

參數

-Argument

指定指令碼延伸傳遞至指令碼的引數。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	參見

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ContainerName

指定此 Cmdlet 儲存指令碼的 Azure 儲存體容器名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

參數屬性

類型:	IAzureContextContainer
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzContext, AzureRmContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DisableAutoUpgradeMinorVersion

Set-AzVMCustomScriptExtension Cmdlet 會將自訂腳本虛擬機器延伸模組新增至虛擬機器。 此擴充功能可讓您在虛擬機器上執行自己的腳本。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-FileName

指定指令碼檔案的名稱。 如果檔案儲存在 Azure Blob 儲存體中，則檔案名稱值會區分大小寫。 儲存在 Azure 檔案儲存體中的檔案名稱不區分大小寫。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-FileUri

指定指令碼檔的 URI。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithFileUriParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ForceRerun

表示此 Cmdlet 會強制在虛擬機器上重新執行相同的延伸模組設定，而不解除安裝並重新安裝延伸模組。 值可以是與目前值不同的任何字串。 如果未變更 forceUpdateTag，處理常式仍會套用公用或受保護設定的更新。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-InputObject

VM 延伸模組物件。

參數屬性

類型:	VirtualMachineCustomScriptExtensionContext
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByInputObjectWithContainerAndFileNamesParameterSet

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ByInputObjectWithFileUriParameterSet

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Location

指定虛擬機器的位置。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Name

指定自訂指令碼延伸的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	ExtensionName

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByNameWithFileUriParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-NoWait

在作業完成之前啟動作業並立即傳回。 為了確定操作是否已成功完成，請使用其他一些機制。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceGroupName

指定虛擬機器資源群組的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByNameWithFileUriParameterSet

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ResourceId

VM 延伸模組 ResourceID。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByResourceIdWithContainerAndFileNamesParameterSet

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByResourceIdWithFileUriParameterSet

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Run

指定要用於執行指令碼的命令。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	執行檔案, Command

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-SecureExecution

指出此 Cmdlet 可確保 Run 參數的值不會記錄在伺服器上，或使用 GET 延伸模組 API 傳回給使用者。 Run 的值可能包含要安全地傳遞至 Script 檔案的密碼或密碼。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-StorageAccountKey

指定 Azure 儲存體容器的金鑰。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-StorageAccountName

指定此 Cmdlet 儲存腳本的 Azure 儲存體帳戶名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-StorageEndpointSuffix

指定儲存端點尾碼。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-TypeHandlerVersion

指定要用於此虛擬機器的延伸模組版本。 若要取得版本，請執行 Get-AzVMExtensionImage Cmdlet，並將 PublisherName 參數的值設定為 Microsoft.Compute，並針對 Type 參數執行 CustomScriptExtension。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	處理常式版本, 版本

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VMName

指定虛擬機器的名稱。 此 Cmdlet 會針對此參數指定的虛擬機器新增自訂腳本延伸模組。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	資源名稱

參數集

ByNameWithContainerAndFileNamesParameterSet

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByNameWithFileUriParameterSet

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VMObject

VM 物件。

參數屬性

類型:	PSVirtualMachine
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByParentObjectWithContainerAndFileNamesParameterSet

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ByParentObjectWithFileUriParameterSet

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	威斯康辛

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

String

String

SwitchParameter

輸出

PSAzureOperationResponse

相關連結

• Get-AzVMCustomScriptExtension
• Remove-AzVMCustomScriptExtension