Update-AzureRmVmss
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
バックグラウンドでコマンドレットを実行し、進行状況を追跡するジョブを返します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-AutomaticOSUpgrade
新しいバージョンのイメージが使用可能になったときに、OS のアップグレードをスケール セット インスタンスに自動的に適用するかどうかを設定します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BootDiagnosticsEnabled
仮想マシン スケール セットでブート 診断を有効にする必要があるかどうか。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BootDiagnosticsStorageUri
コンソールの出力とスクリーンショットを配置するために使用するストレージ アカウントの URI。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CustomData
カスタム データの base-64 でエンコードされた文字列を指定します。 これは、仮想マシン上のファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の最大長は 65535 バイトです。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisableAutoRollback
自動 OS アップグレード ポリシーの自動ロールバックを無効にする
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisablePasswordAuthentication
このコマンドレットが Linux OS のパスワード認証を無効にすることを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EnableAutomaticUpdate
VMSS 内の Windows 仮想マシンが自動更新に対して有効になっているかどうかを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IdentityId
仮想マシン スケール セットに関連付けられているユーザー ID の一覧を指定します。 ユーザー ID 参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identits/{identityName}" という形式の ARM リソース ID になります。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IdentityType
仮想マシン スケール セットに使用される ID の種類を指定します。 型 'SystemAssignedUserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシン スケール セットからすべての ID を削除します。 このパラメーターの有効値は、次のとおりです。
- SystemAssigned
- UserAssigned
- SystemAssignedUserAssigned
- なし
型: | Nullable<T>[ResourceIdentityType] |
指定可能な値: | SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageReferenceId
イメージ参照 ID を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageReferenceOffer
仮想マシン イメージ (VMImage) オファーの種類を指定します。 イメージ オファーを取得するには、Get-AzureRmVMImageOffer コマンドレットを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageReferencePublisher
VMImage のパブリッシャーの名前を指定します。 パブリッシャーを取得するには、Get-AzureRmVMImagePublisher コマンドレットを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageReferenceSku
VMImage SKU を指定します。 SKU を取得するには、Get-AzureRmVMImageSku コマンドレットを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageReferenceVersion
VMImage のバージョンを指定します。 最新バージョンを使用するには、特定のバージョンではなく最新の値を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ImageUri
ユーザー イメージの BLOB URI を指定します。 VMSS は、ユーザー イメージの同じコンテナーにオペレーティング システム ディスクを作成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LicenseType
ライセンスの種類を指定します。ライセンスの種類は、独自のライセンス シナリオを取り込むためです。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ManagedDiskStorageAccountType
マネージド ディスクのストレージ アカウントの種類を指定します。 このパラメーターの有効値は、次のとおりです。
- StandardLRS
- プレミアムLRS
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-MaxBatchInstancePercent
1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 値が指定されていない場合は、20 に設定されます。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-MaxUnhealthyInstancePercent
アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 値が指定されていない場合は、20 に設定されます。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-MaxUnhealthyUpgradedInstancePercent
異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング アップデートは中止されます。 値が指定されていない場合は、20 に設定されます。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OsDiskCaching
オペレーティング システム ディスクのキャッシュ モードを指定します。 このパラメーターの有効値は、次のとおりです。
- なし
- ReadOnly
- ReadWrite 既定値は ReadWrite です。 キャッシュ値を変更すると、コマンドレットによって仮想マシンが再起動されます。 この設定は、ディスクの整合性とパフォーマンスに影響します。
型: | CachingTypes |
指定可能な値: | None, ReadOnly, ReadWrite |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OsDiskWriteAccelerator
OS ディスクで WriteAccelerator を有効または無効にするかどうかを指定します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Overprovision
コマンドレットが VMSS をオーバープロビジョニングするかどうかを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PauseTimeBetweenBatches
すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PlanName
プラン名を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PlanProduct
プラン製品を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PlanPromotionCode
プランの昇格コードを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PlanPublisher
プランの発行元を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProvisionVMAgent
VMSS 内の Windows 仮想マシンで仮想マシン エージェントをプロビジョニングする必要があるかどうかを示します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
VMSS が属するリソース グループの名前を指定します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SinglePlacementGroup
1 つの配置グループを指定します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SkuCapacity
VMSS 内のインスタンスの数を指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SkuName
VMSS のすべてのインスタンスのサイズを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SkuTier
VMSS の層を指定します。 このパラメーターの有効値は、次のとおりです。
- Standard
- 基本
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TimeZone
Windows OS のタイム ゾーンを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UltraSSDEnabled
仮想マシン スケール セットにストレージ アカウントの種類がUltraSSD_LRS 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にするフラグ。 ストレージ アカウントの種類がUltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ VMSS に追加できます。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-UpgradePolicyMode
スケール セット内の仮想マシンへのアップグレード モードを指定しました。 このパラメーターの有効値は、次のとおりです。
- 自動
- 手動
- ローリング
型: | UpgradeMode |
指定可能な値: | Automatic, Manual, Rolling |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VhdContainer
VMSS のオペレーティング システム ディスクの格納に使用するコンテナー URL を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VirtualMachineScaleSet
ローカル VMSS オブジェクトを指定します。 VMSS オブジェクトを取得するには、Get-AzureRmVmss コマンドレットを使用します。 この仮想マシン オブジェクトには、VMSS の更新された状態が含まれています。
型: | PSVirtualMachineScaleSet |
配置: | 3 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-VMScaleSetName
このコマンドレットによって作成される VMSS の名前を指定します。
型: | String |
Aliases: | Name |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
パラメーター: VirtualMachineScaleSet (ByValue)