Set-AzureRmVMOSDisk
仮想マシンにオペレーティング システム ディスクのプロパティを設定します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmVMOSDisk
[-VM] <PSVirtualMachine>
[[-Name] <String>]
[[-VhdUri] <String>]
[[-Caching] <CachingTypes>]
[[-SourceImageUri] <String>]
[[-CreateOption] <String>]
[-DiskSizeInGB <Int32>]
[-ManagedDiskId <String>]
[-StorageAccountType <String>]
[-WriteAccelerator]
[-DiffDiskSetting <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOSDisk
[-VM] <PSVirtualMachine>
[[-Name] <String>]
[[-VhdUri] <String>]
[[-Caching] <CachingTypes>]
[[-SourceImageUri] <String>]
[[-CreateOption] <String>]
[-Windows]
[-DiskSizeInGB <Int32>]
[-ManagedDiskId <String>]
[-StorageAccountType <String>]
[-WriteAccelerator]
[-DiffDiskSetting <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOSDisk
[-VM] <PSVirtualMachine>
[[-Name] <String>]
[[-VhdUri] <String>]
[[-Caching] <CachingTypes>]
[[-SourceImageUri] <String>]
[[-CreateOption] <String>]
[-Windows]
[-DiskEncryptionKeyUrl] <String>
[-DiskEncryptionKeyVaultId] <String>
[[-KeyEncryptionKeyUrl] <String>]
[[-KeyEncryptionKeyVaultId] <String>]
[-DiskSizeInGB <Int32>]
[-ManagedDiskId <String>]
[-StorageAccountType <String>]
[-WriteAccelerator]
[-DiffDiskSetting <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOSDisk
[-VM] <PSVirtualMachine>
[[-Name] <String>]
[[-VhdUri] <String>]
[[-Caching] <CachingTypes>]
[[-SourceImageUri] <String>]
[[-CreateOption] <String>]
[-Linux]
[-DiskSizeInGB <Int32>]
[-ManagedDiskId <String>]
[-StorageAccountType <String>]
[-WriteAccelerator]
[-DiffDiskSetting <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmVMOSDisk
[-VM] <PSVirtualMachine>
[[-Name] <String>]
[[-VhdUri] <String>]
[[-Caching] <CachingTypes>]
[[-SourceImageUri] <String>]
[[-CreateOption] <String>]
[-Linux]
[-DiskEncryptionKeyUrl] <String>
[-DiskEncryptionKeyVaultId] <String>
[[-KeyEncryptionKeyUrl] <String>]
[[-KeyEncryptionKeyVaultId] <String>]
[-DiskSizeInGB <Int32>]
[-ManagedDiskId <String>]
[-StorageAccountType <String>]
[-WriteAccelerator]
[-DiffDiskSetting <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmVMOSDisk コマンドレットは、仮想マシン上のオペレーティング システム ディスクのプロパティを設定します。
例
例 1: プラットフォーム イメージから仮想マシンのプロパティを設定する
PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13"
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id
PS C:\> Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite
PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential)
PS C:\> $VirtualMachine = Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName "Canonical" -Offer "UbuntuServer" -Skus "15.10" -Version "latest" -Caching ReadWrite
PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption FromImage
PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11"最初のコマンドは、ResourceGroup11 という名前のリソース グループ内の AvailabilitablitySet13 という名前の可用性セットを取得し、そのオブジェクトを $AvailabilitySet 変数に格納します。 2 番目のコマンドは、仮想マシン オブジェクトを作成し、$VirtualMachine変数に格納します。 このコマンドは、仮想マシンに名前とサイズを割り当てます。 仮想マシンは、$AvailabilitySetに格納されている可用性セットに属しています。 最後のコマンドは、$VirtualMachineの仮想マシンのプロパティを設定します。
例 2: 一般化されたユーザー イメージから仮想マシンのプロパティを設定する
PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13"
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1"
PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential)
PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -SourceImageUri "https://mystorageaccount.blob.core.windows.net/vhds/myOSImage.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption fromImage -Linux
PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11"最初のコマンドは、ResourceGroup11 という名前のリソース グループ内の AvailabilitablitySet13 という名前の可用性セットを取得し、そのオブジェクトを$AvailabilitySet変数に格納します。 2 番目のコマンドは、仮想マシン オブジェクトを作成し、$VirtualMachine変数に格納します。 このコマンドは、仮想マシンに名前とサイズを割り当てます。 仮想マシンは、$AvailabilitySetに格納されている可用性セットに属しています。 最後のコマンドは、$VirtualMachineの仮想マシンのプロパティを設定します。
例 3: 特殊化されたユーザー イメージから仮想マシンのプロパティを設定する
PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13"
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1"
PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption Attach -Linux
PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11"最初のコマンドは、ResourceGroup11 という名前のリソース グループ内の AvailabilitablitySet13 という名前の可用性セットを取得し、そのオブジェクトを$AvailabilitySet変数に格納します。 2 番目のコマンドは、仮想マシン オブジェクトを作成し、$VirtualMachine変数に格納します。 このコマンドは、仮想マシンに名前とサイズを割り当てます。 仮想マシンは、$AvailabilitySetに格納されている可用性セットに属しています。 最後のコマンドは、$VirtualMachineの仮想マシンのプロパティを設定します。
例 4: 仮想マシンのオペレーティング システム ディスクでディスク暗号化設定を設定する
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1"
PS C:> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -Windows -CreateOption "Attach" -DiskEncryptionKeyUrl "https://mytestvault.vault.azure.net/secrets/Test1/514ceb769c984379a7e0230bddaaaaaa" -DiskEncryptionKeyVaultId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mytestvault"
PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName " ResourceGroup11"次の使用例は、仮想マシンのオペレーティング システム ディスクにディスク暗号化設定を設定します。
パラメーター
-Caching
オペレーティング システム ディスクのキャッシュ モードを指定します。 有効な値は次の通りです。
- ReadOnly
- ReadWrite 既定値は ReadWrite です。 キャッシュ値を変更すると、仮想マシンが再起動します。 この設定は、ディスクのパフォーマンスに影響します。
| Type: | Nullable<T>[CachingTypes] |
| Accepted values: | None, ReadOnly, ReadWrite |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CreateOption
このコマンドレットで、プラットフォームイメージまたはユーザーイメージから仮想マシンにディスクを作成するか、既存のディスクを接続するかを指定します。 有効な値は次の通りです。
- 添付。 特殊化されたディスクから仮想マシンを作成するには、このオプションを指定します。 このオプションを指定する場合は、SourceImageUri パラメーターを指定しないでください。 代わりに、Set-AzureRmVMSourceImage コマンドレットを使用します。 また、Windows または Linux のパラメーターを使用して、VHD 上のオペレーティング システムの種類を Azure プラットフォームに伝える必要があります。 VhdUri パラメーターは、接続するディスクの場所を Azure プラットフォームに伝えるのに十分です。
- FromImage。 プラットフォーム イメージまたは一般化されたユーザー イメージから仮想マシンを作成するには、このオプションを指定します。 一般化されたユーザー イメージの場合は、Set-AzureRmVMSourceImage コマンドレットを使用する代わりに、SourceImageUri パラメーターと Windows または Linux パラメーターを指定して、オペレーティング システム ディスク VHD の場所と種類を Azure プラットフォームに伝える必要もあります。 プラットフォーム イメージの場合は、VhdUri パラメーターで十分です。
- 空白。
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiffDiskSetting
オペレーティング システム ディスクの差分ディスク設定を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DiskEncryptionKeyUrl
ディスク暗号化キーの場所を指定します。
| Type: | String |
| Position: | 7 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskEncryptionKeyVaultId
ディスク暗号化キーを含む Key Vault のリソース ID を指定します。
| Type: | String |
| Position: | 8 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskSizeInGB
オペレーティング システム ディスクのサイズを GB 単位で指定します。
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyEncryptionKeyUrl
キー暗号化キーの場所を指定します。
| Type: | String |
| Position: | 9 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyEncryptionKeyVaultId
キー暗号化キーを含む Key Vault のリソース ID を指定します。
| Type: | String |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Linux
ユーザー イメージ上のオペレーティング システムが Linux であることを示します。 ユーザー イメージ ベースの仮想マシンのデプロイにこのパラメーターを指定します。
| Type: | SwitchParameter |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ManagedDiskId
マネージド ディスクの ID を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
オペレーティング システム ディスクの名前を指定します。
| Type: | String |
| Aliases: | OSDiskName, DiskName |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceImageUri
ユーザー イメージ シナリオの VHD の URI を指定します。
| Type: | String |
| Aliases: | SourceImage |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageAccountType
マネージド ディスクのストレージ アカウントの種類を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VhdUri
仮想ハード ディスク (VHD) の Uniform Resource Identifier (URI) を指定します。 イメージ ベースの仮想マシンの場合、このパラメーターは、プラットフォーム イメージまたはユーザー イメージが指定されたときに作成する VHD ファイルを指定します。 これは、イメージ バイナリ ラージ オブジェクト (BLOB) をコピーして仮想マシンを起動する場所です。 ディスク ベースの仮想マシンのブート シナリオの場合、このパラメーターは、仮想マシンが起動に直接使用する VHD ファイルを指定します。
| Type: | String |
| Aliases: | OSDiskVhdUri, DiskVhdUri |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
オペレーティング システム ディスクのプロパティを設定するローカル仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、Get-AzureRmVM コマンドレットを使用します。
| Type: | PSVirtualMachine |
| Aliases: | VMProfile |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Windows
ユーザー イメージ上のオペレーティング システムが Windows であることを示します。
| Type: | SwitchParameter |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteAccelerator
OS ディスクで WriteAccelerator を有効または無効にするかどうかを指定します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
パラメーター: VM (ByValue)