Update-AzVM

Azure 仮想マシンの状態を更新します。

注意

これは、以前のバージョンのドキュメントです。 最新の情報については 、最新バージョン を参照してください。

構文

Update-AzVM
      [-ResourceGroupName] <String>
      -VM <PSVirtualMachine>
      [-Tag <Hashtable>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-UltraSSDEnabled <Boolean>]
      [-MaxPrice <Double>]
      [-EncryptionAtHost <Boolean>]
      [-ProximityPlacementGroupId <String>]
      [-HostId <String>]
      [-CapacityReservationGroupId <String>]
      [-AsJob]
      [-NoWait]
      [-UserData <String>]
      [-HibernationEnabled]
      [-vCPUCountAvailable <Int32>]
      [-vCPUCountPerCore <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzVM
      [-ResourceGroupName] <String>
      -VM <PSVirtualMachine>
      [-Tag <Hashtable>]
      -IdentityType <ResourceIdentityType>
      [-IdentityId <String[]>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-UltraSSDEnabled <Boolean>]
      [-MaxPrice <Double>]
      [-EncryptionAtHost <Boolean>]
      [-ProximityPlacementGroupId <String>]
      [-HostId <String>]
      [-CapacityReservationGroupId <String>]
      [-AsJob]
      [-NoWait]
      [-UserData <String>]
      [-HibernationEnabled]
      [-vCPUCountAvailable <Int32>]
      [-vCPUCountPerCore <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzVM
      [-Id] <String>
      -VM <PSVirtualMachine>
      [-Tag <Hashtable>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-UltraSSDEnabled <Boolean>]
      [-MaxPrice <Double>]
      [-EncryptionAtHost <Boolean>]
      [-ProximityPlacementGroupId <String>]
      [-HostId <String>]
      [-CapacityReservationGroupId <String>]
      [-AsJob]
      [-NoWait]
      [-UserData <String>]
      [-HibernationEnabled]
      [-vCPUCountAvailable <Int32>]
      [-vCPUCountPerCore <Int32>]
      [-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 = 'Password' | ConvertTo-SecureString -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.

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行し、ジョブを返して進行状況を追跡します。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-CapacityReservationGroupId

割り当てに使用される容量予約グループの ID。

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionAtHost

EncryptionAtHost プロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。

Type:Boolean
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-HibernationEnabled

VM の休止状態機能を有効または無効にするフラグ。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-HostId

ホストの ID

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Id

仮想マシンのリソース ID を指定します。

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-IdentityId

仮想マシンに関連付けられているユーザー ID の一覧を指定します。 ユーザー ID 参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identits/{identityName}" という形式の ARM リソース ID になります。

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

仮想マシンに使用される ID の種類。 有効な値は、SystemAssigned、UserAssigned、SystemAssignedUserAssigned、None です。

Type:Nullable<T>[ResourceIdentityType]
Accepted values:SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-MaxPrice

優先順位の低い VM/VMSS に対して支払う最大価格を指定します。 この価格は米ドルで表示されます。 この価格は、VM サイズの現在の優先順位の低い価格と比較されます。 また、価格は優先順位の低い VM/VMSS の作成/更新時に比較され、maxPrice が現在の低優先度価格より大きい場合にのみ操作は成功します。 現在の低優先度の価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は低優先度 VM/VMSS の削除にも使用されます。 指定できる値は、0 より大きい任意の 10 進値です。 例: 0.01538。 -1 は、価格上の理由から優先順位の低い VM/VMSS を削除しないことを示します。 また、ユーザーが提供していない場合、既定の最大価格は -1 です。

Type:Double
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-NoWait

操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-OsDiskWriteAccelerator

OS ディスクで WriteAccelerator を有効または無効にするかどうかを指定します。

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ProximityPlacementGroupId

この仮想マシンで使用する近接通信配置グループのリソース ID。

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

仮想マシンのリソース グループの名前を指定します。

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Tag

一連の名前と値のペアでタグ付けできるリソースとリソース グループを指定します。 リソースにタグを追加すると、異なるリソース グループのリソースをグループ化したり、独自のビューを作成したりできます。 各リソースまたはリソース グループには、最大で 15 個のタグを含めることができます。

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-UltraSSDEnabled

VM にストレージ アカウントの種類がUltraSSD_LRSされた 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にするフラグ。 ストレージ アカウントの種類がUltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ仮想マシンに追加できます。

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-UserData

VM の UserData。base-64 でエンコードされます。 お客様は、ここにシークレットを渡さないでください。

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-vCPUCountAvailable

VM で使用できる vCPU の数を指定します。 このプロパティが要求本文で指定されていない場合、既定の動作では、 リージョン内の使用可能なすべての仮想マシン サイズを一覧表示する API 応答で公開される VM サイズに対して使用可能な vCPU の値に設定します。

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-vCPUCountPerCore

vCPU と物理コアの比率を指定します。 このプロパティが要求本文で指定されていない場合、既定の動作は、 リージョン内で使用可能なすべての仮想マシン サイズを一覧表示する API 応答で公開される VM サイズの vCPUUsPerCore の値に設定されます。 このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-VM

ローカル仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、Get-AzVM コマンドレットを使用します。 この仮想マシン オブジェクトには、仮想マシンの更新された状態が含まれています。

Type:PSVirtualMachine
Aliases:VMProfile
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

PSVirtualMachine

Boolean

出力

PSAzureOperationResponse