Update-AzVM
構文
ResourceGroupNameParameterSetName (既定)
Update-AzVM
[-ResourceGroupName] <String>
-VM <PSVirtualMachine>
[-Tag <Hashtable>]
[-OsDiskWriteAccelerator <Boolean>]
[-UltraSSDEnabled <Boolean>]
[-MaxPrice <Double>]
[-EncryptionAtHost <Boolean>]
[-ProximityPlacementGroupId <String>]
[-VirtualMachineScaleSetId <String>]
[-HostId <String>]
[-CapacityReservationGroupId <String>]
[-AsJob]
[-NoWait]
[-UserData <String>]
[-HibernationEnabled]
[-vCPUCountAvailable <Int32>]
[-vCPUCountPerCore <Int32>]
[-SecurityType <String>]
[-EnableVtpm <Boolean>]
[-EnableSecureBoot <Boolean>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AlignRegionalDisksToVMZone <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExplicitIdentityParameterSet
Update-AzVM
[-ResourceGroupName] <String>
-VM <PSVirtualMachine>
-IdentityType <ResourceIdentityType>
[-Tag <Hashtable>]
[-IdentityId <String[]>]
[-OsDiskWriteAccelerator <Boolean>]
[-UltraSSDEnabled <Boolean>]
[-MaxPrice <Double>]
[-EncryptionAtHost <Boolean>]
[-ProximityPlacementGroupId <String>]
[-VirtualMachineScaleSetId <String>]
[-HostId <String>]
[-CapacityReservationGroupId <String>]
[-AsJob]
[-NoWait]
[-UserData <String>]
[-HibernationEnabled]
[-vCPUCountAvailable <Int32>]
[-vCPUCountPerCore <Int32>]
[-SecurityType <String>]
[-EnableVtpm <Boolean>]
[-EnableSecureBoot <Boolean>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AlignRegionalDisksToVMZone <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdParameterSetName
Update-AzVM
[-Id] <String>
-VM <PSVirtualMachine>
[-Tag <Hashtable>]
[-OsDiskWriteAccelerator <Boolean>]
[-UltraSSDEnabled <Boolean>]
[-MaxPrice <Double>]
[-EncryptionAtHost <Boolean>]
[-ProximityPlacementGroupId <String>]
[-VirtualMachineScaleSetId <String>]
[-HostId <String>]
[-CapacityReservationGroupId <String>]
[-AsJob]
[-NoWait]
[-UserData <String>]
[-HibernationEnabled]
[-vCPUCountAvailable <Int32>]
[-vCPUCountPerCore <Int32>]
[-SecurityType <String>]
[-EnableVtpm <Boolean>]
[-EnableSecureBoot <Boolean>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AlignRegionalDisksToVMZone <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Update-AzVM コマンドレットは、Azure 仮想マシンの状態を仮想マシン オブジェクトの状態に更新します。
例
例 1: 仮想マシンを更新する
Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine
このコマンドは、ResourceGroup11 の仮想マシン ($VirtualMachine) を更新します。
コマンドは、$VirtualMachine変数に格納されている仮想マシン オブジェクトを使用して更新します。
仮想マシン オブジェクトを取得するには、 Get-AzVM コマンドレットを使用します。
例 2: 仮想マシンを更新してハイパースレッディングを無効にします。
$resourceGroupName = 'Resource Group Name>'
$vmname = 'Virtual Machine Name';
$domainNameLabel = "d1" + $rgname;
$vCPUsCoreInitial = 2;
$vCPUsAvailableInitial = 4;
$vCPUsCore1 = 1;
$vCPUsAvailable1 = 1;
$vmSize = 'Standard_D4s_v4';
$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force;
$user = "user";
$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
$vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -DomainNameLabel $domainNameLabel -Size $vmSize -vCPUCountPerCore $vCPUsCoreInitial -vCPUCountAvailable $vCPUsAvailableInitial;
# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 2, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 4.
Update-AzVM -ResourceGroupName $rgname -VM $vm -vCPUCountAvailable $vCPUsAvailable1 -vCPUCountPerCore $vCPUsCore1;
# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 1, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 1.
# Hyperthreading is now disabled for this VM.
パラメーター
-AlignRegionalDisksToVMZone
リージョン ディスクを配置するか、VM ゾーンに移動するかを指定します。 これは、配置プロパティが設定されている VM にのみ適用されます。 この変更は元に戻すことはできません。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-AsJob
バックグラウンドでコマンドレットを実行し、進行状況を追跡するジョブを返します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-CapacityReservationGroupId
割り当てに使用される容量予約グループの ID。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
型: IAzureContextContainer
規定値: None
ワイルドカードのサポート: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-EnableSecureBoot
仮想マシンでセキュア ブートを有効にするかどうかを指定します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-EnableVtpm
仮想マシンで vTPM を有効にするかどうかを指定します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-EncryptionAtHost
EncryptionAtHost プロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。
これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。
パラメーターのプロパティ
型: Boolean
規定値: False
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-HibernationEnabled
VM の休止機能を有効または無効にするフラグ。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-HostId
ホストの ID
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-Id
仮想マシンのリソース ID を指定します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
IdParameterSetName
配置: 0
必須: True
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-IdentityId
仮想マシンに関連付けられているユーザー ID の一覧を指定します。
ユーザー ID 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identits/{identityName}' という形式の ARM リソース ID になります。
パラメーターのプロパティ
型: String [ ]
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
ExplicitIdentityParameterSet
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-IdentityType
仮想マシンに使用される ID の種類。 有効な値は、SystemAssigned、UserAssigned、SystemAssignedUserAssigned、および None です。
パラメーターのプロパティ
パラメーター セット
ExplicitIdentityParameterSet
配置: Named
必須: True
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-IfMatch
PUT およびその他の安全でないメソッドの条件付き要求を行うために使用されます。 サーバーは、リソースが一覧表示されている ETag 値のいずれかに一致する場合にのみ、要求されたリソースを返します。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-IfNoneMatch
GET メソッドと HEAD メソッドの条件付き要求を行うために使用されます。 サーバーは、リストされている ETag 値が現在のエンティティと一致しない場合にのみ、要求されたリソースを返します。 GET メソッドと HEAD メソッドの条件付き要求を行うために使用されます。 サーバーは、リストされている ETag 値が現在のエンティティと一致しない場合にのみ、要求されたリソースを返します。 新しいレコード セットの作成を許可するが、既存のレコード セットを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-MaxPrice
優先順位の低い VM/VMSS に対して支払う最大価格を指定します。 この価格は米ドルです。 この価格は、VM サイズの現在の優先順位の低い価格と比較されます。 また、価格は優先順位の低い VM/VMSS の作成/更新時に比較され、maxPrice が現在の低優先度価格より大きい場合にのみ操作が成功します。 現在の低優先度の価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は優先順位の低い VM/VMSS の削除にも使用されます。 指定できる値は、0 より大きい任意の 10 進値です。 例: 0.01538。 -1 は、価格上の理由から優先順位の低い VM/VMSS を削除しないことを示します。 また、ユーザーが提供していない場合、既定の最大価格は -1 されます。
パラメーターのプロパティ
型: Double
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-NoWait
操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-OsDiskWriteAccelerator
OS ディスクで WriteAccelerator を有効または無効にするかどうかを指定します。
パラメーターのプロパティ
型: Boolean
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-ProximityPlacementGroupId
この仮想マシンで使用する近接通信配置グループのリソース ID。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
ResourceGroupNameParameterSetName
配置: 0
必須: True
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
ExplicitIdentityParameterSet
配置: 0
必須: True
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-SecurityType
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 既定では、このプロパティが設定されていない限り、UefiSettings は有効になりません。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-Tag
一連の名前と値のペアでタグ付けできるリソースとリソース グループを指定します。
リソースにタグを追加すると、リソースグループ間でリソースをグループ化し、独自のビューを作成できます。
各リソースまたはリソース グループには、最大で 15 個のタグを含めることができます。
パラメーターのプロパティ
型: Hashtable
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-UltraSSDEnabled
VM 上にストレージ アカウントの種類がUltraSSD_LRSされた 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にするフラグ。
ストレージ アカウントの種類がUltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ、仮想マシンに追加できます。
パラメーターのプロパティ
型: Boolean
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-UserData
VM の UserData。base-64 でエンコードされます。 顧客はここでシークレットを渡すべきではありません。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-vCPUCountAvailable
VM で使用できる vCPU の数を指定します。 このプロパティが要求本文で指定されていない場合、既定の動作では、api 応答で公開されている VM サイズに対して使用可能な vCPU の値に設定 リージョン で使用可能なすべての仮想マシン サイズを一覧表示します。
パラメーターのプロパティ
型: Int32
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-vCPUCountPerCore
vCPU と物理コアの比率を指定します。 要求本文でこのプロパティが指定されていない場合、既定の動作は、api 応答で公開される VM サイズの vCPUPerCore の値に設定されます リージョン で使用可能なすべての仮想マシン サイズを一覧表示します。 このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。
パラメーターのプロパティ
型: Int32
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-VirtualMachineScaleSetId
仮想マシンを更新する必要がある仮想マシン ScaleSet の ID。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-VM
ローカル仮想マシン オブジェクトを指定します。
仮想マシン オブジェクトを取得するには、Get-AzVM コマンドレットを使用します。
この仮想マシン オブジェクトには、仮想マシンの更新された状態が含まれています。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: True
パイプラインからの値: True
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
型: SwitchParameter
規定値: False
ワイルドカードのサポート: False
DontShow: False
Aliases: ウィスコンシン
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParameters を参照してください。
出力