New-AzureRmVmssConfig
VMSS 構成オブジェクトを作成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmVmssConfig
[[-Overprovision] <Boolean>]
[[-Location] <String>]
[[-Tag] <Hashtable>]
[[-SkuName] <String>]
[[-SkuTier] <String>]
[[-SkuCapacity] <Int32>]
[[-UpgradePolicyMode] <UpgradeMode>]
[[-OsProfile] <VirtualMachineScaleSetOSProfile>]
[[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
[[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
[[-Extension] <VirtualMachineScaleSetExtension[]>]
[-SinglePlacementGroup <Boolean>]
[-ZoneBalance]
[-PlatformFaultDomainCount <Int32>]
[-Zone <String[]>]
[-PlanName <String>]
[-PlanPublisher <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-RollingUpgradePolicy <RollingUpgradePolicy>]
[-AutoOSUpgrade]
[-DisableAutoRollback <Boolean>]
[-EnableUltraSSD]
[-HealthProbeId <String>]
[-BootDiagnostic <BootDiagnostics>]
[-LicenseType <String>]
[-Priority <String>]
[-EvictionPolicy <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmVmssConfig
[[-Overprovision] <Boolean>]
[[-Location] <String>]
[[-Tag] <Hashtable>]
[[-SkuName] <String>]
[[-SkuTier] <String>]
[[-SkuCapacity] <Int32>]
[[-UpgradePolicyMode] <UpgradeMode>]
[[-OsProfile] <VirtualMachineScaleSetOSProfile>]
[[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
[[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
[[-Extension] <VirtualMachineScaleSetExtension[]>]
[-SinglePlacementGroup <Boolean>]
[-ZoneBalance]
[-PlatformFaultDomainCount <Int32>]
[-Zone <String[]>]
[-PlanName <String>]
[-PlanPublisher <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-RollingUpgradePolicy <RollingUpgradePolicy>]
[-AutoOSUpgrade]
[-DisableAutoRollback <Boolean>]
[-EnableUltraSSD]
[-HealthProbeId <String>]
[-BootDiagnostic <BootDiagnostics>]
[-LicenseType <String>]
[-Priority <String>]
[-EvictionPolicy <String>]
-IdentityType <ResourceIdentityType>
[-IdentityId <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmVmssConfig
[[-Overprovision] <Boolean>]
[[-Location] <String>]
[[-Tag] <Hashtable>]
[[-SkuName] <String>]
[[-SkuTier] <String>]
[[-SkuCapacity] <Int32>]
[[-UpgradePolicyMode] <UpgradeMode>]
[[-OsProfile] <VirtualMachineScaleSetOSProfile>]
[[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
[[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
[[-Extension] <VirtualMachineScaleSetExtension[]>]
[-SinglePlacementGroup <Boolean>]
[-ZoneBalance]
[-PlatformFaultDomainCount <Int32>]
[-Zone <String[]>]
[-PlanName <String>]
[-PlanPublisher <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-RollingUpgradePolicy <RollingUpgradePolicy>]
[-AutoOSUpgrade]
[-DisableAutoRollback <Boolean>]
[-EnableUltraSSD]
[-HealthProbeId <String>]
[-BootDiagnostic <BootDiagnostics>]
[-LicenseType <String>]
[-Priority <String>]
[-EvictionPolicy <String>]
[-AssignIdentity]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
New-AzureRmVmssConfig コマンドレットは、構成可能なローカル仮想マネージャー スケール セット (VMSS) オブジェクトを作成します。 VMSS オブジェクトを構成するには、他のコマンドレットが必要です。 これらのコマンドレットは次のとおりです。
- Set-AzureRmVmssOsProfile
- Set-AzureRmVmssStorageProfile
- Add-AzureRmVmssNetworkInterfaceConfiguration
- Add-AzureRmVmssExtension
例
例 1: VMSS 構成オブジェクトを作成する
PS C:\> $VMSS = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg `
| Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg `
| Set-AzureRmVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword `
| Set-AzureRmVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" `
-ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version `
-ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer `
| Add-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting `
| Remove-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName;
New-AzureRmVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS;この例では、VMSS 構成オブジェクトを作成します。 最初のコマンドでは、 New-AzureRmVmssConfig コマンドレットを使用して VMSS 構成オブジェクトを作成し、結果を $VMSS という名前の変数に格納します。 2 番目のコマンドでは、 New-AzureRmVmss コマンドレットを使用して、最初のコマンドで作成された VMSS 構成オブジェクトを使用する VMSS を作成します。
パラメーター
-AssignIdentity
仮想マシン スケール セットのシステム割り当て ID を指定します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AutoOSUpgrade
新しいバージョンのイメージが使用可能になったときに、OS のアップグレードをスケール セット インスタンスに自動的に適用するかどうかを設定します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BootDiagnostic
仮想マシン スケール セットのブート 診断 プロファイルを指定します。
| Type: | BootDiagnostics |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| 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 |
-EnableUltraSSD
仮想マシン スケール セットにストレージ アカウントの種類UltraSSD_LRS 1 つ以上のマネージド データ ディスクを持つ機能を有効にします。 ストレージ アカウントの種類がUltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ VMSS に追加できます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EvictionPolicy
スケール セット内の仮想マシンの削除ポリシーを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Extension
VMSS の拡張情報オブジェクトを指定します。 Add-AzureRmVmssExtension コマンドレットを使用して、このオブジェクトを追加できます。
| Type: | VirtualMachineScaleSetExtension[] |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LicenseType
ライセンスの種類を指定します。ライセンスの種類は、独自のライセンス シナリオを取り込むためです。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
VMSS が作成される Azure の場所を指定します。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkInterfaceConfiguration
VMSS 構成のネットワーク プロパティを含むネットワーク プロファイル オブジェクトを指定します。 Add-AzureRmVmssNetworkInterfaceConfiguration コマンドレットを使用して、このオブジェクトを追加できます。
| Type: | VirtualMachineScaleSetNetworkConfiguration[] |
| Position: | 9 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OsProfile
VMSS 構成のオペレーティング システム プロパティを含むオペレーティング システム プロファイル オブジェクトを指定します。 Set-AzureRmVmssOsProfile コマンドレットを使用して、このオブジェクトを設定できます。
| Type: | VirtualMachineScaleSetOSProfile |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Overprovision
コマンドレットが VMSS をオーバープロビジョニングするかどうかを示します。
| Type: | Nullable<T>[Boolean] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PlanName
プラン名を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PlanProduct
プラン製品を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PlanPromotionCode
プランの昇格コードを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PlanPublisher
プランの発行元を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PlatformFaultDomainCount
Fault Doメイン は、各配置グループの数です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Priority
スケール セット内の仮想マシンの優先順位を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RollingUpgradePolicy
ローリング アップグレード ポリシーを指定します。
| Type: | RollingUpgradePolicy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SinglePlacementGroup
1 つの配置グループを指定します。
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkuCapacity
VMSS 内のインスタンスの数を指定します。
| Type: | Int32 |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkuName
VMSS のすべてのインスタンスのサイズを指定します。
| Type: | String |
| Aliases: | AccountType |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkuTier
VMSS の層を指定します。 このパラメーターの有効値は、次のとおりです。
- Standard
- 基本
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageProfile
VMSS 構成のディスク プロパティを含むストレージ プロファイル オブジェクトを指定します。 Set-AzureRmVmssStorageProfile コマンドレットを使用して、このオブジェクトを設定できます。
| Type: | VirtualMachineScaleSetStorageProfile |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
| Type: | Hashtable |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UpgradePolicyMode
スケール セット内の仮想マシンへのアップグレード モードを指定しました。 このパラメーターの有効値は、次のとおりです。
- 自動
- 手動
| Type: | Nullable<T>[UpgradeMode] |
| Accepted values: | Automatic, Manual, Rolling |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Zone
仮想マシン スケール セットのゾーン一覧を指定します。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ZoneBalance
ゾーンの停止が発生した場合に、仮想マシンの分散を x ゾーン間で厳密に行うかどうか。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nullable<T>[[Microsoft.Azure.Management.Compute.Models.UpgradeMode, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
VirtualMachineScaleSetOSProfile
VirtualMachineScaleSetStorageProfile
VirtualMachineScaleSetNetworkConfiguration[]
VirtualMachineScaleSetExtension[]
String[]
Nullable<T>[[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]