Update-AzureRmVmss

リファレンス

モジュール:: AzureRM.Compute

VMSS の状態を更新します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Update-AzureRmVmss
      [-ResourceGroupName] <String>
      [-VMScaleSetName] <String>
      [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
      [-ImageReferenceSku <String>]
      [-ManagedDiskStorageAccountType <String>]
      [-PlanPublisher <String>]
      [-ProvisionVMAgent <Boolean>]
      [-BootDiagnosticsEnabled <Boolean>]
      [-Overprovision <Boolean>]
      [-MaxBatchInstancePercent <Int32>]
      [-TimeZone <String>]
      [-BootDiagnosticsStorageUri <String>]
      [-AutomaticOSUpgrade <Boolean>]
      [-DisableAutoRollback <Boolean>]
      [-SinglePlacementGroup <Boolean>]
      [-CustomData <String>]
      [-UpgradePolicyMode <UpgradeMode>]
      [-ImageReferenceId <String>]
      [-DisablePasswordAuthentication <Boolean>]
      [-Tag <Hashtable>]
      [-PlanName <String>]
      [-MaxUnhealthyUpgradedInstancePercent <Int32>]
      [-ImageReferencePublisher <String>]
      [-PlanProduct <String>]
      [-VhdContainer <String[]>]
      [-ImageUri <String>]
      [-SkuTier <String>]
      [-EnableAutomaticUpdate <Boolean>]
      [-LicenseType <String>]
      [-SkuName <String>]
      [-PlanPromotionCode <String>]
      [-MaxUnhealthyInstancePercent <Int32>]
      [-SkuCapacity <Int32>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-ImageReferenceOffer <String>]
      [-PauseTimeBetweenBatches <String>]
      [-OsDiskCaching <CachingTypes>]
      [-ImageReferenceVersion <String>]
      [-UltraSSDEnabled <Boolean>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureRmVmss
      [-ResourceGroupName] <String>
      [-VMScaleSetName] <String>
      [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
      [-ImageReferenceSku <String>]
      [-IdentityId <String[]>]
      [-ManagedDiskStorageAccountType <String>]
      [-PlanPublisher <String>]
      [-ProvisionVMAgent <Boolean>]
      [-BootDiagnosticsEnabled <Boolean>]
      [-Overprovision <Boolean>]
      [-MaxBatchInstancePercent <Int32>]
      [-TimeZone <String>]
      [-BootDiagnosticsStorageUri <String>]
      [-AutomaticOSUpgrade <Boolean>]
      [-DisableAutoRollback <Boolean>]
      [-SinglePlacementGroup <Boolean>]
      [-CustomData <String>]
      [-UpgradePolicyMode <UpgradeMode>]
      [-ImageReferenceId <String>]
      [-DisablePasswordAuthentication <Boolean>]
      [-Tag <Hashtable>]
      [-PlanName <String>]
      [-MaxUnhealthyUpgradedInstancePercent <Int32>]
      [-ImageReferencePublisher <String>]
      [-PlanProduct <String>]
      [-VhdContainer <String[]>]
      [-ImageUri <String>]
      [-SkuTier <String>]
      [-EnableAutomaticUpdate <Boolean>]
      [-LicenseType <String>]
      -IdentityType <ResourceIdentityType>
      [-SkuName <String>]
      [-PlanPromotionCode <String>]
      [-MaxUnhealthyInstancePercent <Int32>]
      [-SkuCapacity <Int32>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-ImageReferenceOffer <String>]
      [-PauseTimeBetweenBatches <String>]
      [-OsDiskCaching <CachingTypes>]
      [-ImageReferenceVersion <String>]
      [-UltraSSDEnabled <Boolean>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-AzureRmVmss コマンドレットは、仮想マシンスケールセット (VMSS) の状態をローカル VMSS オブジェクトの状態に更新します。

例

例 1: VMSS の状態をローカル VMSS オブジェクトの状態に更新します。

PS C:\> Update-AzureRmVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS

このコマンドは、Group001 という名前のリソースグループに属する VMSS001 という名前の VMSS の状態を、ローカル VMSS オブジェクトの状態 ($LocalVMSS) に更新します。

パラメーター

-AsJob

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

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

-AutomaticOSUpgrade

新しいバージョンのイメージが使用可能になったときに、OS のアップグレードをスケールセットインスタンスに自動的に適用するかどうかを設定します。

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

-BootDiagnosticsEnabled

仮想マシンスケールセットでブート診断を有効にする必要があるかどうか。

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

-BootDiagnosticsStorageUri

コンソールの出力とスクリーンショットを配置するために使用するストレージアカウントの URI。

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

-Confirm

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

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

-CustomData

カスタムデータの base-64 でエンコードされた文字列を指定します。これは、仮想マシン上のファイルとして保存されるバイナリ配列にデコードされます。バイナリ配列の最大長は 65535 バイトです。

Type:	String
Position:	Named
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

-DisableAutoRollback

自動 OS アップグレードポリシーの自動ロールバックを無効にする

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

-DisablePasswordAuthentication

このコマンドレットが Linux OS のパスワード認証を無効にすることを示します。

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

-EnableAutomaticUpdate

VMSS 内の Windows 仮想マシンが自動更新に対して有効になっているかどうかを示します。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

仮想マシンスケールセットに使用される ID の種類を指定します。型 'SystemAssignedUserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンスケールセットからすべての ID を削除します。このパラメーターの有効値は、次のとおりです。

SystemAssigned
UserAssigned
SystemAssignedUserAssigned
なし

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

-ImageReferenceId

イメージ参照 ID を指定します。

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

-ImageReferenceOffer

仮想マシンイメージ (VMImage) オファーの種類を指定します。イメージオファーを取得するには、Get-AzureRmVMImageOffer コマンドレットを使用します。

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

-ImageReferencePublisher

VMImage のパブリッシャーの名前を指定します。パブリッシャーを取得するには、Get-AzureRmVMImagePublisher コマンドレットを使用します。

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

-ImageReferenceSku

VMImage SKU を指定します。 SKU を取得するには、Get-AzureRmVMImageSku コマンドレットを使用します。

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

-ImageReferenceVersion

VMImage のバージョンを指定します。最新バージョンを使用するには、特定のバージョンではなく最新の値を指定します。

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

-ImageUri

ユーザーイメージの BLOB URI を指定します。 VMSS は、ユーザーイメージの同じコンテナーにオペレーティングシステムディスクを作成します。

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

-LicenseType

ライセンスの種類を指定します。ライセンスの種類は、独自のライセンスシナリオを取り込むためです。

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

-ManagedDiskStorageAccountType

マネージドディスクのストレージアカウントの種類を指定します。このパラメーターの有効値は、次のとおりです。

StandardLRS
プレミアムLRS

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

-MaxBatchInstancePercent

1 回のバッチでのローリングアップグレードによって同時にアップグレードされる仮想マシンインスタンスの合計数に対する最大割合。これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。値が指定されていない場合は、20 に設定されます。

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

-MaxUnhealthyInstancePercent

アップグレードの結果として、またはローリングアップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケールセット内の仮想マシンインスタンスの合計数に対する最大割合。この制約は、バッチを開始する前にチェックされます。値が指定されていない場合は、20 に設定されます。

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

-MaxUnhealthyUpgradedInstancePercent

異常な状態にあると検出できるアップグレードされた仮想マシンインスタンスの最大割合。このチェックは、各バッチがアップグレードされた後に発生します。この割合を超えた場合、ローリングアップデートは中止されます。値が指定されていない場合は、20 に設定されます。

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

-OsDiskCaching

オペレーティングシステムディスクのキャッシュモードを指定します。このパラメーターの有効値は、次のとおりです。

なし
ReadOnly
ReadWrite 既定値は ReadWrite です。キャッシュ値を変更すると、コマンドレットによって仮想マシンが再起動されます。この設定は、ディスクの整合性とパフォーマンスに影響します。

Type:	CachingTypes
Accepted values:	None, ReadOnly, ReadWrite
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OsDiskWriteAccelerator

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

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

-Overprovision

コマンドレットが VMSS をオーバープロビジョニングするかどうかを示します。

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

-PauseTimeBetweenBatches

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。期間は ISO 8601 形式で指定する必要があります。既定値は 0 秒 (PT0S) です。

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

-PlanName

プラン名を指定します。

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

-PlanProduct

プラン製品を指定します。

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

-PlanPromotionCode

プランの昇格コードを指定します。

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

-PlanPublisher

プランの発行元を指定します。

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

-ProvisionVMAgent

VMSS 内の Windows 仮想マシンで仮想マシンエージェントをプロビジョニングする必要があるかどうかを示します。

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

-ResourceGroupName

VMSS が属するリソースグループの名前を指定します。

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

-SinglePlacementGroup

1 つの配置グループを指定します。

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

-SkuCapacity

VMSS 内のインスタンスの数を指定します。

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

-SkuName

VMSS のすべてのインスタンスのサイズを指定します。

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

-SkuTier

VMSS の層を指定します。このパラメーターの有効値は、次のとおりです。

Standard
基本

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

-Tag

ハッシュテーブルの形式のキーと値のペア。例: @{key0="value0";key1=$null;key2="value2"}

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

-TimeZone

Windows OS のタイムゾーンを指定します。

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

-UltraSSDEnabled

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

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

-UpgradePolicyMode

スケールセット内の仮想マシンへのアップグレードモードを指定しました。このパラメーターの有効値は、次のとおりです。

自動
手動
ローリング

Type:	UpgradeMode
Accepted values:	Automatic, Manual, Rolling
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VhdContainer

VMSS のオペレーティングシステムディスクの格納に使用するコンテナー URL を指定します。

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

-VirtualMachineScaleSet

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

Type:	PSVirtualMachineScaleSet
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VMScaleSetName

このコマンドレットによって作成される VMSS の名前を指定します。

Type:	String
Aliases:	Name
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

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

入力

String

PSVirtualMachineScaleSet

パラメーター: VirtualMachineScaleSet (ByValue)

出力