VirtualMachineScaleSet interface
仮想マシン スケール セットについて説明します。
- Extends
プロパティ
additional |
仮想マシン スケール セットのVirtual Machinesで有効または無効にする追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。 |
automatic |
自動修復のポリシー。 |
constrained |
省略可能なプロパティ。True に設定するか、省略する必要があります。 |
do |
オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。 |
etag | Etag は、VMSS の Create/Update/Get 応答で返されるプロパティです。これにより、顧客はヘッダーで指定して、オプティミスティック更新を保証できます注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
extended |
仮想マシン スケール セットの拡張された場所。 |
host |
仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。 最小 api-version: 2020-06-01。 |
identity | 構成されている場合は、仮想マシン スケール セットの ID。 |
orchestration |
仮想マシン スケール セットのオーケストレーション モードを指定します。 |
overprovision | 仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。 |
plan | 仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。 |
platform |
各配置グループの障害ドメイン数。 |
priority |
同じ VMSS Flex インスタンス内でスポットと通常の優先度の VM を混在するために必要なターゲットを指定します。 |
provisioning |
プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
proximity |
仮想マシン スケール セットを割り当てる必要がある近接配置グループに関する情報を指定します。 最小 api-version: 2018-04-01。 |
resiliency |
回復性のポリシー |
scale |
仮想マシン スケール セットのVirtual Machinesでスケーリングするときに適用されるポリシーを指定します。 |
scheduled |
ScheduledEventsPolicy。 |
single |
true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更できます。 ただし、singlePlacementGroup が false の場合は、true に変更できません。 |
sku | 仮想マシン スケール セット SKU。 |
spot |
仮想マシン スケール セットのスポット リストア プロパティを指定します。 |
time |
仮想マシン スケール セット リソースが作成された時刻を指定します。 最小 api-version: 2021-11-01。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
unique |
仮想マシン スケール セットを一意に識別する ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
upgrade |
アップグレード ポリシー。 |
virtual |
仮想マシン プロファイル。 |
zone |
ゾーンの停止が発生した場合に備えて、仮想マシンの配布を厳密に X ゾーン間で強制するかどうか。 zoneBalance プロパティは、スケール セットの zones プロパティに複数のゾーンが含まれている場合にのみ設定できます。 ゾーンが指定されていない場合、またはゾーンが 1 つしか指定されていない場合は、zoneBalance プロパティを設定しないでください。 |
zones | 仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成する場合にのみ設定できます |
継承されたプロパティ
id | リソース ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
location | リソースの場所 |
name | リソース名注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
tags | リソース タグ |
type | リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
additionalCapabilities
仮想マシン スケール セットのVirtual Machinesで有効または無効にする追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。
additionalCapabilities?: AdditionalCapabilities
プロパティ値
automaticRepairsPolicy
constrainedMaximumCapacity
省略可能なプロパティ。True に設定するか、省略する必要があります。
constrainedMaximumCapacity?: boolean
プロパティ値
boolean
doNotRunExtensionsOnOverprovisionedVMs
オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。
doNotRunExtensionsOnOverprovisionedVMs?: boolean
プロパティ値
boolean
etag
Etag は、VMSS の Create/Update/Get 応答で返されるプロパティです。これにより、顧客はヘッダーで指定して、オプティミスティック更新を保証できます注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
etag?: string
プロパティ値
string
extendedLocation
hostGroup
仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。 最小 api-version: 2020-06-01。
hostGroup?: SubResource
プロパティ値
identity
構成されている場合は、仮想マシン スケール セットの ID。
identity?: VirtualMachineScaleSetIdentity
プロパティ値
orchestrationMode
仮想マシン スケール セットのオーケストレーション モードを指定します。
orchestrationMode?: string
プロパティ値
string
overprovision
仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。
overprovision?: boolean
プロパティ値
boolean
plan
仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。
plan?: Plan
プロパティ値
platformFaultDomainCount
各配置グループの障害ドメイン数。
platformFaultDomainCount?: number
プロパティ値
number
priorityMixPolicy
同じ VMSS Flex インスタンス内でスポットと通常の優先度の VM を混在するために必要なターゲットを指定します。
priorityMixPolicy?: PriorityMixPolicy
プロパティ値
provisioningState
プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
proximityPlacementGroup
仮想マシン スケール セットを割り当てる必要がある近接配置グループに関する情報を指定します。 最小 api-version: 2018-04-01。
proximityPlacementGroup?: SubResource
プロパティ値
resiliencyPolicy
scaleInPolicy
仮想マシン スケール セットのVirtual Machinesでスケーリングするときに適用されるポリシーを指定します。
scaleInPolicy?: ScaleInPolicy
プロパティ値
scheduledEventsPolicy
singlePlacementGroup
true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更できます。 ただし、singlePlacementGroup が false の場合は、true に変更できません。
singlePlacementGroup?: boolean
プロパティ値
boolean
sku
spotRestorePolicy
仮想マシン スケール セットのスポット リストア プロパティを指定します。
spotRestorePolicy?: SpotRestorePolicy
プロパティ値
timeCreated
仮想マシン スケール セット リソースが作成された時刻を指定します。 最小 api-version: 2021-11-01。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
timeCreated?: Date
プロパティ値
Date
uniqueId
仮想マシン スケール セットを一意に識別する ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
uniqueId?: string
プロパティ値
string
upgradePolicy
virtualMachineProfile
仮想マシン プロファイル。
virtualMachineProfile?: VirtualMachineScaleSetVMProfile
プロパティ値
zoneBalance
ゾーンの停止が発生した場合に備えて、仮想マシンの配布を厳密に X ゾーン間で強制するかどうか。 zoneBalance プロパティは、スケール セットの zones プロパティに複数のゾーンが含まれている場合にのみ設定できます。 ゾーンが指定されていない場合、またはゾーンが 1 つしか指定されていない場合は、zoneBalance プロパティを設定しないでください。
zoneBalance?: boolean
プロパティ値
boolean
zones
仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成する場合にのみ設定できます
zones?: string[]
プロパティ値
string[]
継承されたプロパティの詳細
id
location
name
tags
リソース タグ
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
Resource.tagsから継承