Set-AzVMCustomScriptExtension

リファレンス

モジュール:: Az.Compute

仮想マシンにカスタムスクリプト拡張機能を追加します。

構文

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

説明

Set-AzVMCustomScriptExtension コマンドレットは、仮想マシンにカスタムスクリプト仮想マシン拡張機能を追加します。この拡張機能を使用すると、仮想マシンで独自のスクリプトを実行できます。

例

例 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

仮想マシンにカスタムスクリプト拡張機能を追加します。 (自動生成)

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

スクリプト拡張機能がスクリプトに渡す引数を指定します。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-ContainerName

このコマンドレットがスクリプトを格納する Azure ストレージコンテナーの名前を指定します。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

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

-DisableAutoUpgradeMinorVersion

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

-FileName

スクリプトファイルの名前を指定します。ファイルが Azure Blob Storage に格納されている場合、ファイル名の値では大文字と小文字が区別されます。 Azure File Storage に格納されているファイルのファイル名では、大文字と小文字は区別されません。

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

-FileUri

スクリプトファイルの URI を指定します。

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

-ForceRerun

このコマンドレットは、拡張機能をアンインストールして再インストールすることなく、仮想マシンで同じ拡張機能構成を強制的に再実行することを示します。値には、現在の値とは異なる任意の文字列を指定できます。 forceUpdateTag が変更されていない場合でも、パブリックまたは保護された設定の更新はハンドラーによって適用されます。

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

-InputObject

VM 拡張機能オブジェクト。

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

-Location

仮想マシンの場所を指定します。

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

-Name

カスタムスクリプト拡張機能の名前を指定します。

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

-NoWait

操作を開始し、操作が完了する直前に戻ります。操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。

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

-ResourceGroupName

仮想マシンのリソースグループの名前を指定します。

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

-ResourceId

VM 拡張機能 ResourceID。

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

-Run

スクリプトを実行するために使用するコマンドを指定します。

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

-SecureExecution

このコマンドレットは、 Run パラメーターの値がサーバーにログオンしていないか、GET 拡張機能 API を使用してユーザーに返されないことを確認することを示します。 Run の値には、スクリプトファイルに安全に渡されるシークレットまたはパスワードが含まれている場合があります。

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

-StorageAccountKey

Azure ストレージコンテナーのキーを指定します。

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

-StorageAccountName

このコマンドレットがスクリプトを格納する Azure ストレージアカウントの名前を指定します。

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

-StorageEndpointSuffix

ストレージエンドポイントサフィックスを指定します。

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

-TypeHandlerVersion

この仮想マシンに使用する拡張機能のバージョンを指定します。バージョンを取得するには、 PublisherName パラメーターに Microsoft.Compute、 Type パラメーターに CustomScriptExtension の値を指定して、Get-AzVMExtensionImage コマンドレットを実行します。

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

-VMName

仮想マシンの名前を指定します。このコマンドレットは、このパラメーターで指定する仮想マシンのカスタムスクリプト拡張機能を追加します。

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

-VMObject

VM オブジェクト。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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

入力

String

String[]

SwitchParameter

出力

PSAzureOperationResponse

Set-AzVMCustomScriptExtension

構文

説明

例

例 1: カスタム スクリプトを追加する

例 2

パラメーター

入力

出力

関連リンク

フィードバック

例 1: カスタムスクリプトを追加する