VirtualMachineScaleSet interface
描述虛擬機擴展集。
- Extends
屬性
additional |
指定在虛擬機擴展集的虛擬機上啟用或停用的其他功能。 例如:虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。 |
automatic |
自動修復的原則。 |
constrained |
必須設定為 True 或省略的選擇性屬性。 |
do |
啟用 Overprovision 時,只會在最後保留的要求 VM 數目上啟動擴充功能。 因此,這個屬性可確保延伸模組不會在額外的過度布建 VM 上執行。 |
etag | Etag 是在 VMSS 的 Create/Update/Get 回應中傳回的屬性,因此客戶可以在標頭中提供它,以確保開放式更新注意:此屬性不會串行化。 它只能由伺服器填入。 |
extended |
虛擬機擴展集的擴充位置。 |
host |
指定虛擬機擴展集所在專用主機群組的相關信息。 API 版本下限:2020-06-01。 |
identity | 如果已設定,則為虛擬機擴展集的身分識別。 |
orchestration |
指定虛擬機擴展集的協調流程模式。 |
overprovision | 指定虛擬機擴展集是否應該過度布建。 |
plan | 指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站中,尋找您想要使用的市集映像,然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊,然後按下 [儲存] |
platform |
每個放置群組的容錯網域計數。 |
priority |
指定在相同 VMSS Flex 實例內混合 Spot 和一般優先順序 VM 所需的目標。 |
provisioning |
只出現在回應中的布建狀態。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
proximity |
指定應該指派虛擬機擴展集之鄰近放置群組的相關信息。 API 版本下限:2018-04-01。 |
resiliency |
復原原則 |
scale |
指定在虛擬機擴展集中調整虛擬機時所套用的原則。 |
scheduled |
ScheduledEventsPolicy。 |
single |
若為 true,這會將擴展集限制為單一放置群組,大小上限為 100 部虛擬機。 注意:如果 singlePlacementGroup 為 true,它可能會修改為 false。 不過,如果 singlePlacementGroup 為 false,它可能不會修改為 true。 |
sku | 虛擬機擴展集 SKU。 |
spot |
指定虛擬機擴展集的Spot Restore 屬性。 |
time |
指定建立虛擬機擴展集資源的時間。 API 版本下限:2021-11-01。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
unique |
指定可唯一識別虛擬機擴展集的標識碼。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
upgrade |
升級原則。 |
virtual |
虛擬機器配置檔。 |
zone |
如果發生區域中斷,是否要強制甚至虛擬機散發跨 x 區域。 只有在擴展集的區域屬性包含多個區域時,才能設定 zoneBalance 屬性。 如果沒有區域或只有一個指定區域,則不應該設定 zoneBalance 屬性。 |
zones | 虛擬機擴展集區域。 注意:只有在建立擴展集時,才能設定可用性區域 |
繼承的屬性
id | 資源標識碼注意:此屬性不會串行化。 它只能由伺服器填入。 |
location | 資源位置 |
name | 資源名稱注意:此屬性將不會串行化。 它只能由伺服器填入。 |
tags | 資源標籤 |
type | 資源類型注意:此屬性不會串行化。 它只能由伺服器填入。 |
屬性詳細資料
additionalCapabilities
指定在虛擬機擴展集的虛擬機上啟用或停用的其他功能。 例如:虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。
additionalCapabilities?: AdditionalCapabilities
屬性值
automaticRepairsPolicy
constrainedMaximumCapacity
必須設定為 True 或省略的選擇性屬性。
constrainedMaximumCapacity?: boolean
屬性值
boolean
doNotRunExtensionsOnOverprovisionedVMs
啟用 Overprovision 時,只會在最後保留的要求 VM 數目上啟動擴充功能。 因此,這個屬性可確保延伸模組不會在額外的過度布建 VM 上執行。
doNotRunExtensionsOnOverprovisionedVMs?: boolean
屬性值
boolean
etag
Etag 是在 VMSS 的 Create/Update/Get 回應中傳回的屬性,因此客戶可以在標頭中提供它,以確保開放式更新注意:此屬性不會串行化。 它只能由伺服器填入。
etag?: string
屬性值
string
extendedLocation
hostGroup
identity
orchestrationMode
指定虛擬機擴展集的協調流程模式。
orchestrationMode?: string
屬性值
string
overprovision
指定虛擬機擴展集是否應該過度布建。
overprovision?: boolean
屬性值
boolean
plan
指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用,才能從 API 使用市集映射。 在 Azure 入口網站中,尋找您想要使用的市集映像,然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊,然後按下 [儲存]
plan?: Plan
屬性值
platformFaultDomainCount
每個放置群組的容錯網域計數。
platformFaultDomainCount?: number
屬性值
number
priorityMixPolicy
指定在相同 VMSS Flex 實例內混合 Spot 和一般優先順序 VM 所需的目標。
priorityMixPolicy?: PriorityMixPolicy
屬性值
provisioningState
只出現在回應中的布建狀態。 注意:這個屬性不會串行化。 它只能由伺服器填入。
provisioningState?: string
屬性值
string
proximityPlacementGroup
指定應該指派虛擬機擴展集之鄰近放置群組的相關信息。 API 版本下限:2018-04-01。
proximityPlacementGroup?: SubResource
屬性值
resiliencyPolicy
scaleInPolicy
scheduledEventsPolicy
singlePlacementGroup
若為 true,這會將擴展集限制為單一放置群組,大小上限為 100 部虛擬機。 注意:如果 singlePlacementGroup 為 true,它可能會修改為 false。 不過,如果 singlePlacementGroup 為 false,它可能不會修改為 true。
singlePlacementGroup?: boolean
屬性值
boolean
sku
spotRestorePolicy
timeCreated
指定建立虛擬機擴展集資源的時間。 API 版本下限:2021-11-01。 注意:這個屬性不會串行化。 它只能由伺服器填入。
timeCreated?: Date
屬性值
Date
uniqueId
指定可唯一識別虛擬機擴展集的標識碼。 注意:這個屬性不會串行化。 它只能由伺服器填入。
uniqueId?: string
屬性值
string
upgradePolicy
virtualMachineProfile
虛擬機器配置檔。
virtualMachineProfile?: VirtualMachineScaleSetVMProfile
屬性值
zoneBalance
如果發生區域中斷,是否要強制甚至虛擬機散發跨 x 區域。 只有在擴展集的區域屬性包含多個區域時,才能設定 zoneBalance 屬性。 如果沒有區域或只有一個指定區域,則不應該設定 zoneBalance 屬性。
zoneBalance?: boolean
屬性值
boolean
zones
虛擬機擴展集區域。 注意:只有在建立擴展集時,才能設定可用性區域
zones?: string[]
屬性值
string[]