VirtualMachineScaleSet interface
描述虚拟机规模集。
属性
| additional |
指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。 例如：虚拟机是否能够支持使用 UltraSSD_LRS 存储帐户类型附加托管数据磁盘。 |
| automatic |
自动修复的策略。 |
| constrained |
必须设置为 True 或省略的可选属性。 |
| do |
启用过度预配后，仅在请求的 VM 数量上启动扩展，这些 VM 最终会保留。 因此，此属性将确保扩展不会在额外的过度预配的 VM 上运行。 |
| etag | Etag 是在 VMSS 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新注意：此属性不会序列化。 它只能由服务器填充。 |
| extended |
虚拟机规模集的扩展位置。 |
| high |
指定虚拟机规模集的高速互连放置。 |
| host |
指定虚拟机规模集所在的专用主机组的信息。 最低 API 版本：2020-06-01。 |
| identity | 虚拟机规模集的标识（如果已配置）。 |
| orchestration |
指定虚拟机规模集的业务流程模式。 |
| overprovision | 指定是否应过度预配虚拟机规模集。 |
| placement | “放置”部分指定虚拟机规模集硬件放置的用户定义约束。 置备 VMSS 后，无法更改此属性。 最低 api 版本：2025-04-01。 |
| plan | 指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。 在 Azure 门户中，找到要使用的市场映像，然后单击 想要以编程方式部署，开始使用 ->。 输入任何必需的信息，然后单击“保存 |
| platform |
每个放置组的容错域计数。 |
| priority |
指定用于在同一 VMSS Flex 实例中混合现成和常规优先级 VM 的所需目标。 |
| provisioning |
预配状态，仅出现在响应中。 注意：此属性不会序列化。 它只能由服务器填充。 |
| proximity |
指定应向其分配虚拟机规模集的邻近放置组的相关信息。 最低 api 版本：2018-04-01。 |
| resiliency |
复原策略 |
| scale |
指定在虚拟机规模集中的虚拟机中缩放时应用的策略。 |
| scheduled |
ScheduledEventsPolicy。 |
| single |
如果为 true，则规模集限制为单个放置组，最大大小为 100 个虚拟机。 注意：如果 singlePlacementGroup 为 true，则可能会将其修改为 false。 但是，如果 singlePlacementGroup 为 false，则可能不会将其修改为 true。 |
| sku | 虚拟机规模集 SKU。 |
| sku |
指定虚拟机规模集的 SKU 配置文件。 |
| spot |
指定虚拟机规模集的现成还原属性。 |
| time |
指定创建虚拟机规模集资源的时间。 最低 api 版本：2021-11-01。 注意：此属性不会序列化。 它只能由服务器填充。 |
| unique |
指定唯一标识虚拟机规模集的 ID。 注意：此属性不会序列化。 它只能由服务器填充。 |
| upgrade |
升级策略。 |
| virtual |
虚拟机配置文件。 |
| zonal |
指定虚拟机规模集计算与存储容错域计数之间的对齐模式。 |
| zone |
如果发生区域中断，是否强制甚至跨 x 区域进行虚拟机分发。 仅当规模集的区域属性包含多个区域时，才能设置 zoneBalance 属性。 如果没有区域或仅指定一个区域，则不应设置 zoneBalance 属性。 |
| zones | 可用性区域。 |
继承属性
| id | 资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。 |
| location | 资源所在的地理位置 |
| name | 资源说明的名称：此属性不会序列化。 它只能由服务器填充。 |
| system |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。 |
| tags | 资源标记。 |
| type | 资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。 |
属性详细信息
additionalCapabilities
指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。 例如：虚拟机是否能够支持使用 UltraSSD_LRS 存储帐户类型附加托管数据磁盘。
additionalCapabilities?: AdditionalCapabilities属性值
automaticRepairsPolicy
constrainedMaximumCapacity
必须设置为 True 或省略的可选属性。
constrainedMaximumCapacity?: boolean属性值
boolean
doNotRunExtensionsOnOverprovisionedVMs
启用过度预配后，仅在请求的 VM 数量上启动扩展，这些 VM 最终会保留。 因此，此属性将确保扩展不会在额外的过度预配的 VM 上运行。
doNotRunExtensionsOnOverprovisionedVMs?: boolean属性值
boolean
etag
Etag 是在 VMSS 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新注意：此属性不会序列化。 它只能由服务器填充。
etag?: string属性值
string
extendedLocation
highSpeedInterconnectPlacement
指定虚拟机规模集的高速互连放置。
highSpeedInterconnectPlacement?: string属性值
string
hostGroup
identity
orchestrationMode
指定虚拟机规模集的业务流程模式。
orchestrationMode?: string属性值
string
overprovision
指定是否应过度预配虚拟机规模集。
overprovision?: boolean属性值
boolean
placement
“放置”部分指定虚拟机规模集硬件放置的用户定义约束。 置备 VMSS 后，无法更改此属性。 最低 api 版本：2025-04-01。
placement?: Placement属性值
plan
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。 在 Azure 门户中，找到要使用的市场映像，然后单击 想要以编程方式部署，开始使用 ->。 输入任何必需的信息，然后单击“保存
plan?: Plan属性值
platformFaultDomainCount
每个放置组的容错域计数。
platformFaultDomainCount?: number属性值
number
priorityMixPolicy
指定用于在同一 VMSS Flex 实例中混合现成和常规优先级 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
skuProfile
spotRestorePolicy
timeCreated
指定创建虚拟机规模集资源的时间。 最低 api 版本：2021-11-01。 注意：此属性不会序列化。 它只能由服务器填充。
timeCreated?: Date属性值
Date
uniqueId
指定唯一标识虚拟机规模集的 ID。 注意：此属性不会序列化。 它只能由服务器填充。
uniqueId?: string属性值
string
upgradePolicy
virtualMachineProfile
虚拟机配置文件。
virtualMachineProfile?: VirtualMachineScaleSetVMProfile属性值
zonalPlatformFaultDomainAlignMode
指定虚拟机规模集计算与存储容错域计数之间的对齐模式。
zonalPlatformFaultDomainAlignMode?: string属性值
string
zoneBalance
如果发生区域中断，是否强制甚至跨 x 区域进行虚拟机分发。 仅当规模集的区域属性包含多个区域时，才能设置 zoneBalance 属性。 如果没有区域或仅指定一个区域，则不应设置 zoneBalance 属性。
zoneBalance?: boolean属性值
boolean
zones
可用性区域。
zones?: string[]属性值
string[]
继承属性详细信息
id
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。
id?: string属性值
string
location
name
systemData
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
systemData?: SystemData属性值
tags
资源标记。
tags?: {[propertyName: string]: string}属性值
{[propertyName: string]: string}
type
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。
type?: string属性值
string