Set-AzureVMAccessExtension
仮想マシンの VMAccess 拡張機能を設定します。
注意
このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。
構文
Set-AzureVMAccessExtension
[[-UserName] <String>]
[[-Password] <String>]
[[-ReferenceName] <String>]
[[-Version] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMAccessExtension
[-Disable]
[[-ReferenceName] <String>]
[[-Version] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMAccessExtension
[-Uninstall]
[[-ReferenceName] <String>]
[[-Version] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] 説明
Set-AzureVMAccessExtension コマンドレットは、仮想マシン VMAccess 拡張機能を仮想マシンに追加します。 VMAccess 拡張機能を使用して一時パスワードを設定できます。これは、マシンにログインした後すぐに変更する必要があります。
例
例 1: 指定した仮想マシンに適用される VMAccess 拡張機能を設定する
PS C:\> Set-AzureVMAccessExtension -VM $VM -UserName $User -Password $PWD;このコマンドは、指定した仮想マシンに適用される VMAccess 拡張機能を変数$VMに格納されるように設定します。
パラメーター
-Disable
このコマンドレットが拡張機能の状態を無効に設定することを示します。
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ForceUpdate
構成が更新されていない場合に、このコマンドレットが拡張機能に構成を再適用することを示します。
| Type: | SwitchParameter |
| Position: | 5 |
| 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 |
-Password
仮想マシンの資格情報をリセットするためのパスワードを指定します。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Uninstall
このコマンドレットがアクセス拡張機能をアンインストールするかどうかを示します。
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserName
このコマンドレットを使用して仮想マシンの資格情報をリセットするユーザー名を指定します。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
拡張機能のバージョンを指定します。
| Type: | String |
| Position: | 4 |
| 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 |