Set-AzureVMCustomScriptExtension
Azure 仮想マシンのカスタム スクリプト拡張機能の情報を設定します。
Note
このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。
Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される 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
このコマンドレットが仮想マシンで実行される引数を指定する文字列を指定します。
| 型: | String |
| 配置: | 8 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ContainerName
ストレージ アカウント内のコンテナー名を指定します。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Disable
このコマンドレットが拡張機能の状態を無効にすることを示します。
| 型: | SwitchParameter |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-FileName
指定したコンテナー内の BLOB ファイルの名前を含む文字列配列を指定します。
| 型: | String[] |
| 配置: | 3 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-FileUri
BLOB ファイルの URL を含む文字列配列を指定します。
| 型: | String[] |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ForceUpdate
構成が更新されていない場合に、このコマンドレットによって拡張機能に構成が再適用されることを示します。
| 型: | SwitchParameter |
| 配置: | 9 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。
このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- Stop
- [中断]
| 型: | ActionPreference |
| Aliases: | infa |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationVariable
情報変数を指定します。
| 型: | String |
| Aliases: | iv |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
| 型: | AzureSMProfile |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ReferenceName
拡張機能の参照名を指定します。
このパラメーターは、拡張機能を参照するために使用できるユーザー定義の文字列です。 これは、拡張機能が仮想マシンに初めて追加されるときに指定されます。 以降の更新では、拡張機能の更新中に以前に使用した参照名を指定する必要があります。 拡張機能に割り当てられた ReferenceName は、Get-AzureVM コマンドレットを使用して返されます。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Run
このコマンドレットが仮想マシン上の拡張機能によって実行されるコマンドを指定します。 "powershell.exe" のみがサポートされています。
| 型: | String |
| Aliases: | RunFile, Command |
| 配置: | 7 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-StorageAccountKey
ストレージ アカウント キーを指定します
| 型: | String |
| 配置: | 6 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-StorageAccountName
現在のサブスクリプションのストレージ アカウント名を指定します。
| 型: | String |
| 配置: | 4 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-StorageEndpointSuffix
ストレージ サービス エンドポイントを指定します。
| 型: | String |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Uninstall
このコマンドレットが仮想マシンからカスタム スクリプト拡張機能をアンインストールすることを示します。
| 型: | SwitchParameter |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Version
カスタム スクリプト拡張機能のバージョンを指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-VM
永続的な仮想マシン オブジェクトを指定します。
| 型: | IPersistentVM |
| Aliases: | InputObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |