Set-AzureRmVMOperatingSystem
仮想マシンに使用するオペレーティング システムのプロパティを設定します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmVMOperatingSystem
[-VM] <PSVirtualMachine>
[-Windows]
[-ComputerName] <String>
[-Credential] <PSCredential>
[[-CustomData] <String>]
[-ProvisionVMAgent]
[-EnableAutoUpdate]
[[-TimeZone] <String>]
[-WinRMHttp]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOperatingSystem
[-VM] <PSVirtualMachine>
[-Windows]
[-ComputerName] <String>
[-Credential] <PSCredential>
[[-CustomData] <String>]
[-ProvisionVMAgent]
[-EnableAutoUpdate]
[[-TimeZone] <String>]
[-WinRMHttp]
[-WinRMHttps]
[-WinRMCertificateUrl] <Uri>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOperatingSystem
[-VM] <PSVirtualMachine>
[-Windows]
[-ComputerName] <String>
[-Credential] <PSCredential>
[[-CustomData] <String>]
[-DisableVMAgent]
[-EnableAutoUpdate]
[[-TimeZone] <String>]
[-WinRMHttp]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOperatingSystem
[-VM] <PSVirtualMachine>
[-Windows]
[-ComputerName] <String>
[-Credential] <PSCredential>
[[-CustomData] <String>]
[-DisableVMAgent]
[-EnableAutoUpdate]
[[-TimeZone] <String>]
[-WinRMHttp]
[-WinRMHttps]
[-WinRMCertificateUrl] <Uri>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOperatingSystem
[-VM] <PSVirtualMachine>
[-Linux]
[-ComputerName] <String>
[-Credential] <PSCredential>
[[-CustomData] <String>]
[-DisablePasswordAuthentication]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmVMOperatingSystem コマンドレットは、仮想マシンのオペレーティング システムプロパティを設定します。 ログオン資格情報、コンピューター名、オペレーティング システムの種類を指定できます。
例
例 1: 新しい仮想マシンのオペレーティング システムプロパティを設定する
PS C:\> $SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force
PS C:\> $Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword);
PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03"
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id
PS C:\> $ComputerName = "ContosoVM122"
PS C:\> $WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion"
PS C:\> $TimeZone = "Pacific Standard Time"
PS C:\> $CustomData = "echo 'Hello World'"
PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $$VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone最初のコマンドは、パスワードをセキュリティで保護された文字列に変換し、$SecurePassword変数に格納します。
詳細を表示するには「Get-Help ConvertTo-SecureString」を入力します。
2 番目のコマンドは、ユーザー FullerP の資格情報と、$SecurePasswordに格納されているパスワードを作成し、その資格情報を $Credential 変数に格納します。
詳細を表示するには「Get-Help New-Object」を入力します。
3 番目のコマンドは、ResourceGroup11 という名前のリソース グループ内の AvailabilitablitySet03 という名前の可用性セットを取得し、そのオブジェクトを$AvailabilitySet変数に格納します。
4 番目のコマンドは、仮想マシン オブジェクトを作成し、$VirtualMachine変数に格納します。
このコマンドは、仮想マシンに名前とサイズを割り当てます。
仮想マシンは、$AvailabilitySetに格納されている可用性セットに属しています。
次の 4 つのコマンドは、次のコマンドで使用する変数に値を割り当てます。
これらの文字列は Set-AzureRmVMOperatingSystem コマンドで直接指定できるため、この方法は読みやすくするためにのみ使用されます。
ただし、スクリプトではこのようなアプローチを使用する場合があります。
最後のコマンドは、$VirtualMachineに格納されている仮想マシンのオペレーティング システムプロパティを設定します。
このコマンドは、$Credentialに格納されている資格情報を使用します。
このコマンドでは、一部のパラメーターに対して前のコマンドで割り当てられた変数を使用します。
パラメーター
-ComputerName
コンピュータの名前を指定します。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Credential
仮想マシンのユーザー名とパスワードを PSCredential オブジェクトとして指定します。
資格情報を取得するには、Get-Credential コマンドレットを使用します。
詳細を表示するには「Get-Help Get-Credential」を入力します。
| 型: | PSCredential |
| 配置: | 3 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-CustomData
カスタム データの base-64 でエンコードされた文字列を指定します。 これは、仮想マシン上のファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の最大長は 65535 バイトです。
| 型: | String |
| 配置: | 4 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisablePasswordAuthentication
このコマンドレットがパスワード認証を無効にすることを示します。
| 型: | SwitchParameter |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DisableVMAgent
VM エージェントのプロビジョニングを無効にします。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-EnableAutoUpdate
このコマンドレットで自動更新が有効であることを示します。
| 型: | SwitchParameter |
| 配置: | 6 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Linux
オペレーティング システムの種類が Linux であることを示します。
| 型: | SwitchParameter |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ProvisionVMAgent
設定で仮想マシン エージェントを仮想マシンにインストールする必要があることを示します。
| 型: | SwitchParameter |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TimeZone
仮想マシンのタイム ゾーンを指定します。
| 型: | String |
| 配置: | 7 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-VM
オペレーティング システムのプロパティを設定するローカル仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、Get-AzureRmVM コマンドレットを使用します。 New-AzureRmVMConfig コマンドレットを使用して仮想マシン オブジェクトを作成します。
| 型: | PSVirtualMachine |
| Aliases: | VMProfile |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Windows
オペレーティング システムの種類が Windows であることを示します。
| 型: | SwitchParameter |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WinRMCertificateUrl
WinRM 証明書の URI を指定します。 これは Key Vault に格納する必要があります。
| 型: | Uri |
| 配置: | 10 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WinRMHttp
このオペレーティング システムが HTTP WinRM を使用することを示します。
| 型: | SwitchParameter |
| 配置: | 8 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WinRMHttps
このオペレーティング システムが HTTPS WinRM を使用することを示します。
| 型: | SwitchParameter |
| 配置: | 9 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |