Share via


Set-AzureVMCustomScriptExtension

Azure 仮想マシンのカスタム スクリプト拡張機能の情報を設定します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。

構文

Set-AzureVMCustomScriptExtension
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-ContainerName] <String>
   [-FileName] <String[]>
   [[-StorageAccountName] <String>]
   [[-StorageEndpointSuffix] <String>]
   [[-StorageAccountKey] <String>]
   [[-Run] <String>]
   [[-Argument] <String>]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureVMCustomScriptExtension
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-Disable]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureVMCustomScriptExtension
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-Uninstall]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureVMCustomScriptExtension
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [[-FileUri] <String[]>]
   [-Run] <String>
   [[-Argument] <String>]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

説明

Set-AzureVMCustomScriptExtension コマンドレットは、Azure 仮想マシンのカスタム スクリプト拡張機能の情報を設定します。

例 1: 仮想マシンのカスタム スクリプト拡張機能の情報を設定する

PS C:\> $VM = Set-AzureVMCustomScriptExtension -VM $VM -ContainerName "Container01" -FileName "script1.ps1","script2.ps1" -Run "script1.ps1" -Argument "arg1 arg2";
PS C:\> New-AzureVM -Location "West US" -ServiceName $SVC -VM $VM;

このコマンドは、仮想マシンのカスタム スクリプト拡張機能の情報を設定します。

例 2: ファイル パスを使用して仮想マシンのカスタム スクリプト拡張機能の情報を設定する

PS C:\> Set-AzureVMCustomScriptExtension -VM $VM -FileUri "http://www.blob.core.contoso.net/bar/script1.ps1","http://www.blob.core.contoso.net/baz/script2.ps1" -Run "script1.ps1" -Argument "arg1 arg2";
PS C:\> Update-AzureVM -ServiceName $SVC -Name $Name -VM VM;

このコマンドは、複数のファイル URL を使用して、仮想マシンのカスタム スクリプト拡張機能の情報を設定します。

パラメーター

-Argument

このコマンドレットが仮想マシンで実行される引数を指定する文字列を指定します。

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

-ContainerName

ストレージ アカウント内のコンテナー名を指定します。

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

-Disable

このコマンドレットが拡張機能の状態を無効にすることを示します。

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

-FileName

指定したコンテナー内の BLOB ファイルの名前を含む文字列配列を指定します。

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

-FileUri

BLOB ファイルの URL を含む文字列配列を指定します。

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

-ForceUpdate

構成が更新されていない場合に、このコマンドレットによって拡張機能に構成が再適用されることを示します。

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

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

  • 続行
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

情報変数を指定します。

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

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

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

-ReferenceName

拡張機能の参照名を指定します。

このパラメーターは、拡張機能を参照するために使用できるユーザー定義の文字列です。 これは、拡張機能が仮想マシンに初めて追加されるときに指定されます。 以降の更新では、拡張機能の更新中に以前に使用した参照名を指定する必要があります。 拡張機能に割り当てられた ReferenceName は、Get-AzureVM コマンドレットを使用して返されます。

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

-Run

このコマンドレットが仮想マシン上の拡張機能によって実行されるコマンドを指定します。 "powershell.exe" のみがサポートされています。

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

-StorageAccountKey

ストレージ アカウント キーを指定します

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

-StorageAccountName

現在のサブスクリプションのストレージ アカウント名を指定します。

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

-StorageEndpointSuffix

ストレージ サービス エンドポイントを指定します。

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

-Uninstall

このコマンドレットが仮想マシンからカスタム スクリプト拡張機能をアンインストールすることを示します。

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

-Version

カスタム スクリプト拡張機能のバージョンを指定します。

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

-VM

永続的な仮想マシン オブジェクトを指定します。

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