フィードバック

New-AzVmssConfig

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

VMSS 構成オブジェクトを作成します。

構文

New-AzVmssConfig
   [[-Overprovision] <Boolean>]
   [[-Location] <String>]
   [-EdgeZone <String>]
   [[-Tag] <Hashtable>]
   [[-SkuName] <String>]
   [[-SkuTier] <String>]
   [[-SkuCapacity] <Int32>]
   [[-UpgradePolicyMode] <UpgradeMode>]
   [[-OsProfile] <VirtualMachineScaleSetOSProfile>]
   [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
   [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
   [[-Extension] <PSVirtualMachineScaleSetExtension[]>]
   [-SkipExtensionsOnOverprovisionedVMs]
   [-SinglePlacementGroup <Boolean>]
   [-ZoneBalance]
   [-PlatformFaultDomainCount <Int32>]
   [-Zone <String[]>]
   [-PlanName <String>]
   [-PlanPublisher <String>]
   [-PlanProduct <String>]
   [-PlanPromotionCode <String>]
   [-RollingUpgradePolicy <RollingUpgradePolicy>]
   [-EnableAutomaticRepair]
   [-AutomaticRepairGracePeriod <String>]
   [-AutoOSUpgrade]
   [-DisableAutoRollback <Boolean>]
   [-EnableUltraSSD]
   [-HealthProbeId <String>]
   [-BootDiagnostic <BootDiagnostics>]
   [-LicenseType <String>]
   [-Priority <String>]
   [-EnableSpotRestore]
   [-SpotRestoreTimeout <String>]
   [-EvictionPolicy <String>]
   [-MaxPrice <Double>]
   [-TerminateScheduledEvents]
   [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
   [-ProximityPlacementGroupId <String>]
   [-ScaleInPolicy <String[]>]
   [-EncryptionAtHost]
   [-OrchestrationMode <String>]
   [-CapacityReservationGroupId <String>]
   [-UserData <String>]
   [-AutomaticRepairAction <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVmssConfig
   [[-Overprovision] <Boolean>]
   [[-Location] <String>]
   [-EdgeZone <String>]
   [[-Tag] <Hashtable>]
   [[-SkuName] <String>]
   [[-SkuTier] <String>]
   [[-SkuCapacity] <Int32>]
   [[-UpgradePolicyMode] <UpgradeMode>]
   [[-OsProfile] <VirtualMachineScaleSetOSProfile>]
   [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
   [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
   [[-Extension] <PSVirtualMachineScaleSetExtension[]>]
   [-SkipExtensionsOnOverprovisionedVMs]
   [-SinglePlacementGroup <Boolean>]
   [-ZoneBalance]
   [-PlatformFaultDomainCount <Int32>]
   [-Zone <String[]>]
   [-PlanName <String>]
   [-PlanPublisher <String>]
   [-PlanProduct <String>]
   [-PlanPromotionCode <String>]
   [-RollingUpgradePolicy <RollingUpgradePolicy>]
   [-EnableAutomaticRepair]
   [-AutomaticRepairGracePeriod <String>]
   [-AutoOSUpgrade]
   [-DisableAutoRollback <Boolean>]
   [-EnableUltraSSD]
   [-HealthProbeId <String>]
   [-BootDiagnostic <BootDiagnostics>]
   [-LicenseType <String>]
   [-Priority <String>]
   [-EnableSpotRestore]
   [-SpotRestoreTimeout <String>]
   [-EvictionPolicy <String>]
   [-MaxPrice <Double>]
   [-TerminateScheduledEvents]
   [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
   [-ProximityPlacementGroupId <String>]
   [-ScaleInPolicy <String[]>]
   -IdentityType <ResourceIdentityType>
   [-IdentityId <String[]>]
   [-EncryptionAtHost]
   [-OrchestrationMode <String>]
   [-CapacityReservationGroupId <String>]
   [-UserData <String>]
   [-AutomaticRepairAction <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

New-AzVmssConfig コマンドレットは、構成可能なローカル仮想マネージャー スケール セット (VMSS) オブジェクトを作成します。 VMSS オブジェクトを構成するには、他のコマンドレットが必要です。 これらのコマンドレットは次のとおりです。

  • Set-AzVmssOsProfile
  • Set-AzVmssStorageProfile
  • Add-AzVmssNetworkInterfaceConfiguration
  • Add-AzVmssExtension

例

例 1: VMSS 構成オブジェクトを作成する

$VMSS = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg `
            | Add-AzVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg `
            | Set-AzVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword `
            | Set-AzVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" `
            -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version `
            -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer `
            | Add-AzVmssAdditionalUnattendContent -ComponentName  $AUCComponentName -Content  $AUCContent -PassName  $AUCPassName -SettingName  $AUCSetting;

New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS;

この例では、VMSS 構成オブジェクトを作成します。 最初のコマンドでは、 New-AzVmssConfig コマンドレットを使用して VMSS 構成オブジェクトを作成し、結果を $VMSS という名前の変数に格納します。 2 番目のコマンドでは、 New-AzVmss コマンドレットを使用して、最初のコマンドで作成された VMSS 構成オブジェクトを使用する VMSS を作成します。

例 2

VMSS 構成オブジェクトを作成します。 (自動生成)

New-AzVmssConfig -Location <String> -Overprovision $false -SkuCapacity 2 -SkuName 'Standard_A0' -Tag @{key0="value0";key1=$null;key2="value2"} -UpgradePolicyMode Automatic;

例 3

VMSS 構成オブジェクトを作成します。 (自動生成)

New-AzVmssConfig -Location <String> -SkuCapacity 2 -SkuName 'Standard_A0' -UpgradePolicyMode Automatic -IdentityType SystemAssigned;

パラメーター

-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:True
Accept wildcard characters:False
-AutoOSUpgrade

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

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

仮想マシン スケール セットのブート診断プロファイルを指定します。

Type:BootDiagnostics
Position:Named
Default value:None
Accept pipeline input:True
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: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
-EdgeZone

エッジ ゾーン名を設定します。 設定すると、クエリはメインリージョンではなく、指定されたエッジゾーンにルーティングされます。

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

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

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

容量の可用性と価格の制約に基づいて、削除された VMSS SPOT インスタンスを日和見的に復元しようとするスポット復元機能を有効にします。

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

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

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

このパラメーターにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 既定値: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。

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

スケール セット内の仮想マシンの削除ポリシーを指定します。

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

VMSS の拡張機能情報オブジェクトを指定します。 Add-AzVmssExtension コマンドレットを使用して、このオブジェクトを追加できます。

Type:PSVirtualMachineScaleSetExtension[]
Position:10
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-HealthProbeId

仮想マシン スケール セット内のインスタンスの正常性を判断するために使用されるロード バランサー プローブの ID を指定します。 HealthProbeId は'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式です。

Type:String
Position:Named
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:True
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:True
Accept wildcard characters:False
-LicenseType

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

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

VMSS が作成される Azure の場所を指定します。

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

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

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

VMSS 構成のネットワーク プロパティを含むネットワーク プロファイル オブジェクトを指定します。 Add-AzVmssNetworkInterfaceConfiguration コマンドレットを使用して、このオブジェクトを追加できます。

Type:VirtualMachineScaleSetNetworkConfiguration[]
Position:9
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。 使用可能な値: Uniform、Flexible

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

VMSS 構成のオペレーティング システム プロパティを含むオペレーティング システム プロファイル オブジェクトを指定します。 Set-AzVmssOsProfile コマンドレットを使用して、このオブジェクトを設定できます。

Type:VirtualMachineScaleSetOSProfile
Position:7
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Overprovision

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

Type:Nullable<T>[Boolean]
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-PlanName

プラン名を指定します。

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

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

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

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

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

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

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

各配置グループの障害ドメイン数。

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

スケール セット内の仮想マシンの優先順位。 サポートされている値は、'Regular'、'Spot'、'Low' のみです。 "Regular" は通常の仮想マシン用です。 "スポット" はスポット仮想マシン用です。 'Low' はスポット仮想マシン用でもありますが、'Spot' に置き換えられます。 'Low' の代わりに 'Spot' を使用してください。

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

このスケール セットで使用する近接配置グループのリソース ID。

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

ローリング アップグレード ポリシーを指定します。

Type:RollingUpgradePolicy
Position:Named
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:True
Accept wildcard characters:False
-SinglePlacementGroup

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

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SkipExtensionsOnOverprovisionedVMs

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

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

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

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

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

Type:String
Aliases:AccountType
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SkuTier

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

  • Standard
  • Basic
Type:String
Position:4
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SpotRestoreTimeout

プラットフォームが VMSS SPOT インスタンスの復元を試みない、ISO 8601 時間として表されるタイムアウト値を指定します

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

VMSS 構成のディスク プロパティを含むストレージ プロファイル オブジェクトを指定します。 Set-AzVmssStorageProfile コマンドレットを使用して、このオブジェクトを設定できます。

Type:VirtualMachineScaleSetStorageProfile
Position:8
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Tag

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

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

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

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

スケジュールされたイベントの終了を有効にする

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

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

  • 自動
  • マニュアル
Type:Nullable<T>[UpgradeMode]
Accepted values:Automatic, Manual, Rolling
Position:6
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
-WhatIf

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

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

仮想マシン スケール セットのゾーン リストを指定します。

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

ゾーンの障害が発生した場合に仮想マシンの配布を X ゾーン間で厳密に行うかどうか。

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

入力

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String

Hashtable

Int32

Nullable<T>[[Microsoft.Azure.Management.Compute.Models.UpgradeMode, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

VirtualMachineScaleSetOSProfile

VirtualMachineScaleSetStorageProfile

VirtualMachineScaleSetNetworkConfiguration[]

VirtualMachineScaleSetExtension[]

String[]

RollingUpgradePolicy

SwitchParameter

BootDiagnostics

Nullable<T>[[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

出力

PSVirtualMachineScaleSet