フィードバック

Update-AzVmss

  • リファレンス
モジュール:
Az.Compute

VMSS の状態を更新します。

構文

Update-AzVmss
      [-ResourceGroupName] <String>
      [-VMScaleSetName] <String>
      [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
      [-AutomaticOSUpgrade <Boolean>]
      [-AutomaticRepairGracePeriod <String>]
      [-BootDiagnosticsEnabled <Boolean>]
      [-BootDiagnosticsStorageUri <String>]
      [-CustomData <String>]
      [-DisableAutoRollback <Boolean>]
      [-DisablePasswordAuthentication <Boolean>]
      [-EnableAutomaticRepair <Boolean>]
      [-EnableAutomaticUpdate <Boolean>]
      [-ImageReferenceId <String>]
      [-ImageReferenceOffer <String>]
      [-ImageReferencePublisher <String>]
      [-ImageReferenceSku <String>]
      [-ImageReferenceVersion <String>]
      [-ImageUri <String>]
      [-LicenseType <String>]
      [-ManagedDiskStorageAccountType <String>]
      [-MaxBatchInstancePercent <Int32>]
      [-MaxPrice <Double>]
      [-MaxUnhealthyInstancePercent <Int32>]
      [-MaxUnhealthyUpgradedInstancePercent <Int32>]
      [-OsDiskCaching <CachingTypes>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-Overprovision <Boolean>]
      [-ScaleInPolicyForceDeletion <Boolean>]
      [-PauseTimeBetweenBatches <String>]
      [-PlanName <String>]
      [-PlanProduct <String>]
      [-PlanPromotionCode <String>]
      [-PlanPublisher <String>]
      [-ProvisionVMAgent <Boolean>]
      [-ProximityPlacementGroupId <String>]
      [-ScaleInPolicy <String[]>]
      [-SinglePlacementGroup <Boolean>]
      [-SkipExtensionsOnOverprovisionedVMs <Boolean>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-SkuTier <String>]
      [-Tag <Hashtable>]
      [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
      [-TerminateScheduledEvents <Boolean>]
      [-TimeZone <String>]
      [-UltraSSDEnabled <Boolean>]
      [-UpgradePolicyMode <UpgradeMode>]
      [-CapacityReservationGroupId <String>]
      [-VhdContainer <String[]>]
      [-AsJob]
      [-EncryptionAtHost <Boolean>]
      [-UserData <String>]
      [-AutomaticRepairAction <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzVmss
      [-ResourceGroupName] <String>
      [-VMScaleSetName] <String>
      [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
      [-AutomaticOSUpgrade <Boolean>]
      [-AutomaticRepairGracePeriod <String>]
      [-BootDiagnosticsEnabled <Boolean>]
      [-BootDiagnosticsStorageUri <String>]
      [-CustomData <String>]
      [-DisableAutoRollback <Boolean>]
      [-DisablePasswordAuthentication <Boolean>]
      [-EnableAutomaticRepair <Boolean>]
      [-EnableAutomaticUpdate <Boolean>]
      [-IdentityId <String[]>]
      -IdentityType <ResourceIdentityType>
      [-ImageReferenceId <String>]
      [-ImageReferenceOffer <String>]
      [-ImageReferencePublisher <String>]
      [-ImageReferenceSku <String>]
      [-ImageReferenceVersion <String>]
      [-ImageUri <String>]
      [-LicenseType <String>]
      [-ManagedDiskStorageAccountType <String>]
      [-MaxBatchInstancePercent <Int32>]
      [-MaxPrice <Double>]
      [-MaxUnhealthyInstancePercent <Int32>]
      [-MaxUnhealthyUpgradedInstancePercent <Int32>]
      [-OsDiskCaching <CachingTypes>]
      [-OsDiskWriteAccelerator <Boolean>]
      [-Overprovision <Boolean>]
      [-ScaleInPolicyForceDeletion <Boolean>]
      [-PauseTimeBetweenBatches <String>]
      [-PlanName <String>]
      [-PlanProduct <String>]
      [-PlanPromotionCode <String>]
      [-PlanPublisher <String>]
      [-ProvisionVMAgent <Boolean>]
      [-ProximityPlacementGroupId <String>]
      [-ScaleInPolicy <String[]>]
      [-SinglePlacementGroup <Boolean>]
      [-SkipExtensionsOnOverprovisionedVMs <Boolean>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-SkuTier <String>]
      [-Tag <Hashtable>]
      [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
      [-TerminateScheduledEvents <Boolean>]
      [-TimeZone <String>]
      [-UltraSSDEnabled <Boolean>]
      [-UpgradePolicyMode <UpgradeMode>]
      [-CapacityReservationGroupId <String>]
      [-VhdContainer <String[]>]
      [-AsJob]
      [-EncryptionAtHost <Boolean>]
      [-UserData <String>]
      [-AutomaticRepairAction <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

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

例

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

Update-AzVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS

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

例 2

VMSS の状態を更新します。 (自動生成)

Update-AzVmss -ResourceGroupName 'Group001' -VMScaleSetName 'VMSS001' -VirtualMachineScaleSet <PSVirtualMachineScaleSet> -IdentityType SystemAssigned

パラメーター

-AsJob

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

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

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

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

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。 既定値は replace です。

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

VM 上の状態変更が原因で自動修復が中断される時間。 猶予期間は、状態の変更が完了した後に開始されます。 これは、早期または偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される最小猶予期間は 30 分 (PT30M) で、これも既定値です。 許可される猶予期間の上限は 90 分 (PT90M) です。

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

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

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

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

Type:String
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
-CustomData

カスタム データの Base 64 エンコード文字列を指定します。 これは、仮想マシン上のファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。
VM に cloud-init を使用する場合は、「 cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。

Type:String
Position:Named
Default value:None
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
-DisableAutoRollback

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

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

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

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

仮想マシン スケール セットの自動修復を有効または無効にします。

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

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

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

このパラメーターは、要求のユーザーが仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。

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

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

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

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

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

VMImage の発行元の名前を指定します。 発行元を取得するには、Get-AzVMImagePublisher コマンドレットを使用します。

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

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

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

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

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

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

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

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

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

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

  • StandardLRS
  • PremiumLRS
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MaxBatchInstancePercent

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

Type:Int32
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:False
Accept wildcard characters:False
-MaxUnhealthyInstancePercent

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

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

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

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

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

  • なし
  • ReadOnly
  • ReadWrite 既定値は ReadWrite です。 キャッシュ値を変更すると、コマンドレットによって仮想マシンが再起動されます。 この設定は、ディスクの一貫性とパフォーマンスに影響します。
Type:CachingTypes
Accepted values:None, ReadOnly, ReadWrite
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
-Overprovision

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

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

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

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

プラン名を指定します。

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

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

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

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

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

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

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

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

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

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

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

仮想マシン スケール セットのスケーリング時に従う規則。 使用可能な値は、'Default'、'OldestVM'、および 'NewestVM' です。 仮想マシン スケール セットがスケールインされると、スケール セットがゾーン スケール セットの場合、最初にゾーン間でバランスが取られます。 その後、可能な限り障害ドメイン間でバランスが取られます。 各障害ドメイン内では、削除用に選択された仮想マシンが、スケール インから保護されていない最新のマシンになります。 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最も古い仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、まずスケール セットはゾーン間でバランスが取られます。 各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。 仮想マシン スケール セットがスケールインされている場合は、スケール インから保護されていない最新の仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、まずスケール セットはゾーン間でバランスが取られます。 各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

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

ScaleIn Policy を使用する場合の強制削除の適用。

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

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

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

追加のオーバープロビジョニングされた VM で拡張機能が実行されないように指定します。

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

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

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

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

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

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

  • Standard
  • Basic
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tag

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

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

削除される仮想マシンの構成可能な時間 (分単位) は、イベントが自動承認 (タイムアウト) される前に、スケジュールされた終了イベントを承認する必要があります。

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

スケジュール終了イベントが有効か無効かを指定します。

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

Windows OS のタイム ゾーンを指定します (例: "Pacific Standard Time")。
指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイム ゾーンからの値 TimeZoneInfo.Id できます。

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

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

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

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

  • 自動
  • マニュアル
  • ローリング
Type:UpgradeMode
Accepted values:Automatic, Manual, Rolling
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserData

Vmss の UserData。これは base-64 でエンコードされます。 顧客はここにシークレットを渡すべきではありません。

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

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

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

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

Type:PSVirtualMachineScaleSet
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-VMScaleSetName

このコマンドレットで作成する VMSS の名前を指定します。

Type:String
Aliases:Name
Position:1
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

PSVirtualMachineScaleSet

Boolean

出力

PSVirtualMachineScaleSet