Set-AzureVMAccessExtension
仮想マシンの VMAccess 拡張機能を設定します。
Note
このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用するレガシ Azure リソースを管理するためのものです。 ASM の廃止が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、「Azure Service Manager の廃止」を参照してください。
Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するための推奨される 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
このコマンドレットが拡張機能の状態を無効に設定することを示します。
| 型: | SwitchParameter |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ForceUpdate
構成が更新されていない場合に、このコマンドレットが拡張機能に構成を再適用することを示します。
| 型: | SwitchParameter |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。
このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- 阻止
- [中断]
| 型: | ActionPreference |
| Aliases: | infa |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationVariable
情報変数を指定します。
| 型: | String |
| Aliases: | iv |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Password
仮想マシンの資格情報をリセットするためのパスワードを指定します。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
| 型: | AzureSMProfile |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ReferenceName
アクセス拡張機能の参照名を指定します。
これは、拡張機能を参照するために使用されるユーザー定義文字列です。 これは、拡張機能が仮想マシンに初めて追加されるときに指定されます。 以降の更新では、拡張機能の更新時に以前に使用した参照名を指定する必要があります。 拡張機能に割り当てられた ReferenceName は、Get-AzureVM コマンドレットを使用して返されます。
| 型: | String |
| 配置: | 3 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Uninstall
このコマンドレットがアクセス拡張機能をアンインストールするかどうかを示します。
| 型: | SwitchParameter |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-UserName
このコマンドレットを使用して仮想マシンの資格情報をリセットするユーザー名を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Version
拡張機能のバージョンを指定します。
| 型: | String |
| 配置: | 4 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-VM
永続的な仮想マシン オブジェクトを指定します。
| 型: | IPersistentVM |
| Aliases: | InputObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |