你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

VirtualMachineScaleSet interface

包:

@azure/arm-compute

介绍虚拟机规模集。

扩展

Resource

属性

additionalCapabilities	指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。 例如：虚拟机是否能够支持使用UltraSSD_LRS存储帐户类型附加托管数据磁盘。
automaticRepairsPolicy	自动修复策略。
constrainedMaximumCapacity	必须设置为 True 或省略的可选属性。
doNotRunExtensionsOnOverprovisionedVMs	启用过度预配后，扩展仅在最终保留的请求数目的 VM 上启动。 因此，此属性将确保扩展不会在额外的过度预配的 VM 上运行。
etag	Etag 是在 VMSS 的Create/更新/获取响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新注意：此属性不会被序列化。 它只能由服务器填充。
extendedLocation	虚拟机规模集的扩展位置。
hostGroup	指定有关虚拟机规模集驻留的专用主机组的信息。 最低 API 版本：2020-06-01。
identity	虚拟机规模集的标识（如果已配置）。
orchestrationMode	指定虚拟机规模集的业务流程模式。
overprovision	指定是否应过度预配虚拟机规模集。
plan	指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以供编程使用，然后才能从 API 使用市场映像。 在Azure 门户中，找到要使用的市场映像，然后单击“想要以编程方式部署”“入门”->。 输入任何所需信息，然后单击“ 保存”。
platformFaultDomainCount	每个放置组的容错域计数。
priorityMixPolicy	指定用于在同一 VMSS Flex 实例中混合现成 VM 和常规优先级 VM 的所需目标。
provisioningState	预配状态，仅显示在响应中。 注意：此属性不会被序列化。 它只能由服务器填充。
proximityPlacementGroup	指定虚拟机规模集应分配到的邻近放置组的相关信息。 最低 API 版本：2018-04-01。
resiliencyPolicy	复原策略
scaleInPolicy	指定在虚拟机规模集中缩放虚拟机时应用的策略。
scheduledEventsPolicy	ScheduledEventsPolicy。
singlePlacementGroup	如果为 true，则会将规模集限制为单个放置组，最大大小为 100 个虚拟机。 注意：如果 singlePlacementGroup 为 true，则可能会将其修改为 false。 但是，如果 singlePlacementGroup 为 false，则不可将其修改为 true。
sku	虚拟机规模集 SKU。
spotRestorePolicy	指定虚拟机规模集的现成还原属性。
timeCreated	指定创建虚拟机规模集资源的时间。 最低 API 版本：2021-11-01。 注意：此属性不会被序列化。 它只能由服务器填充。
uniqueId	指定唯一标识虚拟机规模集的 ID。 注意：此属性不会被序列化。 它只能由服务器填充。
upgradePolicy	升级策略。
virtualMachineProfile	虚拟机配置文件。
zoneBalance	在发生区域中断时，是否强制在 x 区域间严格均匀地进行虚拟机分发。 仅当规模集的 zone 属性包含多个区域时，才能设置 zoneBalance 属性。 如果没有指定区域或仅指定了一个区域，则不应设置 zoneBalance 属性。
zones	虚拟机规模集区域。 注意：只能在创建规模集时设置可用性区域

继承属性

id	资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源位置
name	资源名称 注意：此属性不会被序列化。 它只能由服务器填充。
tags	资源标记
type	资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

additionalCapabilities

指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。 例如：虚拟机是否能够支持使用UltraSSD_LRS存储帐户类型附加托管数据磁盘。

additionalCapabilities?: AdditionalCapabilities

属性值

AdditionalCapabilities

automaticRepairsPolicy

自动修复策略。

automaticRepairsPolicy?: AutomaticRepairsPolicy

属性值

AutomaticRepairsPolicy

constrainedMaximumCapacity

必须设置为 True 或省略的可选属性。

constrainedMaximumCapacity?: boolean

属性值

boolean

doNotRunExtensionsOnOverprovisionedVMs

启用过度预配后，扩展仅在最终保留的请求数目的 VM 上启动。 因此，此属性将确保扩展不会在额外的过度预配的 VM 上运行。

doNotRunExtensionsOnOverprovisionedVMs?: boolean

属性值

boolean

etag

Etag 是在 VMSS 的Create/更新/获取响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新注意：此属性不会被序列化。 它只能由服务器填充。

etag?: string

属性值

string

extendedLocation

虚拟机规模集的扩展位置。

extendedLocation?: ExtendedLocation

属性值

ExtendedLocation

hostGroup

指定有关虚拟机规模集驻留的专用主机组的信息。 最低 API 版本：2020-06-01。

hostGroup?: SubResource

属性值

SubResource

identity

虚拟机规模集的标识（如果已配置）。

identity?: VirtualMachineScaleSetIdentity

属性值

VirtualMachineScaleSetIdentity

orchestrationMode

指定虚拟机规模集的业务流程模式。

orchestrationMode?: string

属性值

string

overprovision

指定是否应过度预配虚拟机规模集。

overprovision?: boolean

属性值

boolean

plan

指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以供编程使用，然后才能从 API 使用市场映像。 在Azure 门户中，找到要使用的市场映像，然后单击“想要以编程方式部署”“入门”->。 输入任何所需信息，然后单击“ 保存”。

plan?: Plan

属性值

Plan

platformFaultDomainCount

每个放置组的容错域计数。

platformFaultDomainCount?: number

属性值

number

priorityMixPolicy

指定用于在同一 VMSS Flex 实例中混合现成 VM 和常规优先级 VM 的所需目标。

priorityMixPolicy?: PriorityMixPolicy

属性值

PriorityMixPolicy

provisioningState

预配状态，仅显示在响应中。 注意：此属性不会被序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

proximityPlacementGroup

指定虚拟机规模集应分配到的邻近放置组的相关信息。 最低 API 版本：2018-04-01。

proximityPlacementGroup?: SubResource

属性值

SubResource

resiliencyPolicy

复原策略

resiliencyPolicy?: ResiliencyPolicy

属性值

ResiliencyPolicy

scaleInPolicy

指定在虚拟机规模集中缩放虚拟机时应用的策略。

scaleInPolicy?: ScaleInPolicy

属性值

ScaleInPolicy

scheduledEventsPolicy

ScheduledEventsPolicy。

scheduledEventsPolicy?: ScheduledEventsPolicy

属性值

ScheduledEventsPolicy

singlePlacementGroup

如果为 true，则会将规模集限制为单个放置组，最大大小为 100 个虚拟机。 注意：如果 singlePlacementGroup 为 true，则可能会将其修改为 false。 但是，如果 singlePlacementGroup 为 false，则不可将其修改为 true。

singlePlacementGroup?: boolean

属性值

boolean

sku

虚拟机规模集 SKU。

sku?: Sku

属性值

Sku

spotRestorePolicy

指定虚拟机规模集的现成还原属性。

spotRestorePolicy?: SpotRestorePolicy

属性值

SpotRestorePolicy

timeCreated

指定创建虚拟机规模集资源的时间。 最低 API 版本：2021-11-01。 注意：此属性不会被序列化。 它只能由服务器填充。

timeCreated?: Date

属性值

Date

uniqueId

指定唯一标识虚拟机规模集的 ID。 注意：此属性不会被序列化。 它只能由服务器填充。

uniqueId?: string

属性值

string

upgradePolicy

升级策略。

upgradePolicy?: UpgradePolicy

属性值

UpgradePolicy

virtualMachineProfile

虚拟机配置文件。

virtualMachineProfile?: VirtualMachineScaleSetVMProfile

属性值

VirtualMachineScaleSetVMProfile

zoneBalance

在发生区域中断时，是否强制在 x 区域间严格均匀地进行虚拟机分发。 仅当规模集的 zone 属性包含多个区域时，才能设置 zoneBalance 属性。 如果没有指定区域或仅指定了一个区域，则不应设置 zoneBalance 属性。

zoneBalance?: boolean

属性值

boolean

zones

虚拟机规模集区域。 注意：只能在创建规模集时设置可用性区域

zones?: string[]

属性值

string[]

继承属性详细信息

id

资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自Resource.id

location

资源位置

location: string

属性值

string

继承自Resource.location

name

资源名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自Resource.name

tags

资源标记

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自Resource.tags

type

资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自Resource.type