你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
VirtualMachine interface
描述虚拟机。
- 扩展
属性
| additional |
指定在虚拟机上启用或禁用的其他功能。 |
| application |
指定应提供给 VM/VMSS 的库应用程序。 |
| availability |
指定应将虚拟机分配到的可用性集的相关信息。 在同一可用性集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 有关可用性集的详细信息，请参阅 可用性集概述。 有关 Azure 计划内维护的详细信息，请参阅 Azure 中虚拟机的维护和更新。 目前，只能在创建时将 VM 添加到可用性集。 要向其添加 VM 的可用性集应与可用性集资源位于同一资源组下。 无法将现有 VM 添加到可用性集。 此属性不能与非 null properties.virtualMachineScaleSet 引用一起存在。 |
| billing |
指定 Azure 现成虚拟机的计费相关详细信息。 最低 API 版本：2019-03-01。 |
| capacity |
指定有关用于分配虚拟机的容量预留的信息。 最低 API 版本：2021-04-01。 |
| diagnostics |
指定启动诊断设置状态。 最低 API 版本：2015-06-15。 |
| etag | Etag 是在 VM 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新。 注意：此属性不会序列化。 它只能由服务器填充。 |
| eviction |
指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。 对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。 对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。 |
| extended |
虚拟机的扩展位置。 |
| extensions |
指定分配所有扩展开始的时间。 持续时间应介于 15 分钟到 120 分钟（含）之间，应采用 ISO 8601 格式指定。 默认值为 90 分钟（PT1H30M）。 最低 API 版本：2020-06-01。 |
| hardware |
指定虚拟机的硬件设置。 |
| host | 指定虚拟机所在的专用主机的相关信息。 最低 API 版本：2018-10-01。 |
| host |
指定有关虚拟机所在的专用主机组的信息。 注意： 用户不能同时指定主机和 hostGroup 属性。 最低 API 版本：2020-06-01。 |
| identity | 虚拟机的标识（如果已配置）。 |
| instance |
虚拟机实例视图。 注意：此属性不会序列化。 它只能由服务器填充。 |
| license |
指定正在使用的映像或磁盘在本地获得许可。 |
| managed |
如果 VM 是 VMSS 的一部分，则 ManagedBy 设置为虚拟机规模集（VMSS）弹性 ARM 资源 ID。 此属性由平台用于内部资源组删除优化。 注意：此属性不会序列化。 它只能由服务器填充。 |
| network |
指定虚拟机的网络接口。 |
| os |
指定创建虚拟机时使用的操作系统设置。 预配 VM 后，无法更改某些设置。 |
| plan | 指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。 在 Azure 门户中，找到要使用的市场映像，然后单击 想要以编程方式部署，开始使用 ->。 输入任何必需的信息，然后单击“保存 。 |
| platform |
指定要在其中创建虚拟机的规模集逻辑容错域。 默认情况下，虚拟机将自动分配给容错域，该容错域最适合跨可用容错域保持平衡。 仅当设置了此虚拟机的“virtualMachineScaleSet”属性时，这才适用。 引用的虚拟机规模集必须具有大于 1 的“platformFaultDomainCount”。 创建虚拟机后，无法更新此属性。 可以在虚拟机实例视图中查看容错域分配。 最低 api 版本：2020-12？01。 |
| priority | 指定虚拟机的优先级。 最低 API 版本：2019-03-01 |
| provisioning |
预配状态，仅出现在响应中。 注意：此属性不会序列化。 它只能由服务器填充。 |
| proximity |
指定应将虚拟机分配到的邻近放置组的相关信息。 最低 api 版本：2018-04-01。 |
| resources | 虚拟机子扩展资源。 注意：此属性不会序列化。 它只能由服务器填充。 |
| scheduled |
指定虚拟机的重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关配置。 |
| scheduled |
指定与计划事件相关的配置。 |
| security |
指定虚拟机的安全相关配置文件设置。 |
| storage |
指定虚拟机磁盘的存储设置。 |
| time |
指定创建虚拟机资源的时间。 最低 api 版本：2021-11-01。 注意：此属性不会序列化。 它只能由服务器填充。 |
| user |
VM 的 UserData（必须进行 base-64 编码）。 客户不应在此处传递任何机密。 最低 API 版本：2021-03-01。 |
| virtual |
指定应向其分配虚拟机规模集的信息。 在同一虚拟机规模集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 目前，只能在创建时将 VM 添加到虚拟机规模集。 无法将现有 VM 添加到虚拟机规模集。 此属性不能与非 null properties.availabilitySet 引用一起存在。 最低 api 版本：2019-03？01。 |
| vm |
指定 VM 唯一 ID，该 ID 是一个 128 位标识符，该标识符已编码并存储在所有 Azure IaaS VM SMBIOS 中，并且可以使用平台 BIOS 命令进行读取。 注意：此属性不会序列化。 它只能由服务器填充。 |
| zones | 虚拟机区域。 |
继承属性
| id | 资源 ID 注意：此属性不会序列化。 它只能由服务器填充。 |
| location | 资源位置 |
| name | 资源名称注意：此属性不会序列化。 它只能由服务器填充。 |
| tags | 资源标记 |
| type | 资源类型注意：此属性不会序列化。 它只能由服务器填充。 |
属性详细信息
additionalCapabilities
applicationProfile
availabilitySet
指定应将虚拟机分配到的可用性集的相关信息。 在同一可用性集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 有关可用性集的详细信息，请参阅 可用性集概述。 有关 Azure 计划内维护的详细信息，请参阅 Azure 中虚拟机的维护和更新。 目前，只能在创建时将 VM 添加到可用性集。 要向其添加 VM 的可用性集应与可用性集资源位于同一资源组下。 无法将现有 VM 添加到可用性集。 此属性不能与非 null properties.virtualMachineScaleSet 引用一起存在。
availabilitySet?: SubResource属性值
billingProfile
capacityReservation
指定有关用于分配虚拟机的容量预留的信息。 最低 API 版本：2021-04-01。
capacityReservation?: CapacityReservationProfile属性值
diagnosticsProfile
etag
Etag 是在 VM 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新。 注意：此属性不会序列化。 它只能由服务器填充。
etag?: string属性值
string
evictionPolicy
指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。 对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。 对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。
evictionPolicy?: string属性值
string
extendedLocation
extensionsTimeBudget
指定分配所有扩展开始的时间。 持续时间应介于 15 分钟到 120 分钟（含）之间，应采用 ISO 8601 格式指定。 默认值为 90 分钟（PT1H30M）。 最低 API 版本：2020-06-01。
extensionsTimeBudget?: string属性值
string
hardwareProfile
host
hostGroup
指定有关虚拟机所在的专用主机组的信息。 注意： 用户不能同时指定主机和 hostGroup 属性。 最低 API 版本：2020-06-01。
hostGroup?: SubResource属性值
identity
instanceView
虚拟机实例视图。 注意：此属性不会序列化。 它只能由服务器填充。
instanceView?: VirtualMachineInstanceView属性值
licenseType
指定正在使用的映像或磁盘在本地获得许可。
Windows Server 操作系统的可能值为：
Windows_Client
Windows_Server
Linux Server 操作系统的可能值为：
RHEL_BYOS（适用于 RHEL）
SLES_BYOS（对于 SUSE）
有关详细信息，请参阅 Windows Server 的 Azure 混合使用权益
Linux Server 的 Azure 混合使用权益
最低 API 版本：2015-06-15
licenseType?: string属性值
string
managedBy
如果 VM 是 VMSS 的一部分，则 ManagedBy 设置为虚拟机规模集（VMSS）弹性 ARM 资源 ID。 此属性由平台用于内部资源组删除优化。 注意：此属性不会序列化。 它只能由服务器填充。
managedBy?: string属性值
string
networkProfile
osProfile
plan
指定有关用于创建虚拟机的市场映像的信息。 此元素仅用于市场映像。 必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。 在 Azure 门户中，找到要使用的市场映像，然后单击 想要以编程方式部署，开始使用 ->。 输入任何必需的信息，然后单击“保存 。
plan?: Plan属性值
platformFaultDomain
指定要在其中创建虚拟机的规模集逻辑容错域。 默认情况下，虚拟机将自动分配给容错域，该容错域最适合跨可用容错域保持平衡。 仅当设置了此虚拟机的“virtualMachineScaleSet”属性时，这才适用。 引用的虚拟机规模集必须具有大于 1 的“platformFaultDomainCount”。 创建虚拟机后，无法更新此属性。 可以在虚拟机实例视图中查看容错域分配。 最低 api 版本：2020-12？01。
platformFaultDomain?: number属性值
number
priority
指定虚拟机的优先级。 最低 API 版本：2019-03-01
priority?: string属性值
string
provisioningState
预配状态，仅出现在响应中。 注意：此属性不会序列化。 它只能由服务器填充。
provisioningState?: string属性值
string
proximityPlacementGroup
resources
虚拟机子扩展资源。 注意：此属性不会序列化。 它只能由服务器填充。
resources?: VirtualMachineExtension[]属性值
scheduledEventsPolicy
指定虚拟机的重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关配置。
scheduledEventsPolicy?: ScheduledEventsPolicy属性值
scheduledEventsProfile
securityProfile
storageProfile
timeCreated
指定创建虚拟机资源的时间。 最低 api 版本：2021-11-01。 注意：此属性不会序列化。 它只能由服务器填充。
timeCreated?: Date属性值
Date
userData
VM 的 UserData（必须进行 base-64 编码）。 客户不应在此处传递任何机密。 最低 API 版本：2021-03-01。
userData?: string属性值
string
virtualMachineScaleSet
指定应向其分配虚拟机规模集的信息。 在同一虚拟机规模集中指定的虚拟机分配给不同的节点，以最大程度地提高可用性。 目前，只能在创建时将 VM 添加到虚拟机规模集。 无法将现有 VM 添加到虚拟机规模集。 此属性不能与非 null properties.availabilitySet 引用一起存在。 最低 api 版本：2019-03？01。
virtualMachineScaleSet?: SubResource属性值
vmId
指定 VM 唯一 ID，该 ID 是一个 128 位标识符，该标识符已编码并存储在所有 Azure IaaS VM SMBIOS 中，并且可以使用平台 BIOS 命令进行读取。 注意：此属性不会序列化。 它只能由服务器填充。
vmId?: string属性值
string
zones
虚拟机区域。
zones?: string[]属性值
string[]