你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
VirtualMachine 类
描述虚拟机。
变量仅由服务器填充,发送请求时将被忽略。
必须填充所有必需的参数才能发送到 Azure。
- 继承
-
azure.mgmt.compute.v2021_04_01.models._models_py3.ResourceVirtualMachine
构造函数
VirtualMachine(*, location: str, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineIdentity | None = None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation | None = None, hardware_profile: _models.HardwareProfile | None = None, storage_profile: _models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, os_profile: _models.OSProfile | None = None, network_profile: _models.NetworkProfile | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource | None = None, virtual_machine_scale_set: _models.SubResource | None = None, proximity_placement_group: _models.SubResource | None = None, priority: str | _models.VirtualMachinePriorityTypes | None = None, eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes | None = None, billing_profile: _models.BillingProfile | None = None, host: _models.SubResource | None = None, host_group: _models.SubResource | None = None, license_type: str | None = None, extensions_time_budget: str | None = None, platform_fault_domain: int | None = None, scheduled_events_profile: _models.ScheduledEventsProfile | None = None, user_data: str | None = None, capacity_reservation: _models.CapacityReservationProfile | None = None, **kwargs: Any)
Keyword-Only Parameters
- location
- str
资源位置。 必需。
- plan
- Plan
指定用于创建虚拟机的市场映像的相关信息。 此元素仅用于市场映像。 必须先启用该映像以供编程使用,然后才能从 API 使用市场映像。 在Azure 门户,找到要使用的市场映像,然后单击“想要以编程方式部署”“入门”->。 输入任何所需信息,然后单击“ 保存”。
- identity
- VirtualMachineIdentity
虚拟机的标识(如果已配置)。
- extended_location
- ExtendedLocation
虚拟机的扩展位置。
- hardware_profile
- HardwareProfile
指定虚拟机的硬件设置。
- storage_profile
- StorageProfile
指定虚拟机磁盘的存储设置。
- additional_capabilities
- AdditionalCapabilities
指定在虚拟机上启用或禁用的其他功能。
- os_profile
- OSProfile
指定创建虚拟机时使用的操作系统设置。 预配 VM 后,某些设置无法更改。
- network_profile
- NetworkProfile
指定虚拟机的网络接口。
- security_profile
- SecurityProfile
指定虚拟机的安全相关配置文件设置。
- diagnostics_profile
- DiagnosticsProfile
指定启动诊断设置状态。
<br>
:code:>><<<br>
最低 api-version:2015-06-15。
- availability_set
- SubResource
指定虚拟机应分配到的可用性集的相关信息。 将在同一可用性集中指定的虚拟机分配给不同节点,以便尽量提高可用性。 有关可用性集的详细信息,请参阅 可用性集概述。
<br>``<br>
有关 Azure 计划内维护的详细信息,请参阅 Azure <br>``<br>
中虚拟机的维护和更新 目前,只能在创建时将 VM 添加到可用性集。 要向其添加 VM 的可用性集应位于与可用性集资源相同的资源组下。 无法将现有 VM 添加到可用性集。
<br>
:code:>><<<br>
此属性不能与非 null properties.virtualMachineScaleSet 引用一起存在。
- virtual_machine_scale_set
- SubResource
指定虚拟机应分配到的虚拟机规模集的相关信息。 同一虚拟机规模集中指定的虚拟机将分配到不同的节点,以最大程度地提高可用性。 目前,VM 只能在创建时添加到虚拟机规模集。 无法将现有 VM 添加到虚拟机规模集。 <br>``<br>
此属性不能与非 null properties.availabilitySet 引用一起存在。 :code:<br>
:code:>><<<br>
Minimum api-version: 2019?03?01。
- proximity_placement_group
- SubResource
指定虚拟机应分配到的邻近放置组的相关信息。 <br>
:code:>><<<br>
Minimum api-version: 2018-04-01。
- priority
- str 或 VirtualMachinePriorityTypes
指定虚拟机的优先级。
<br>
:code:>><<<br>
Minimum api-version: 2019-03-01。 已知值为:“Regular”、“Low”和“Spot”。
- eviction_policy
- str 或 VirtualMachineEvictionPolicyTypes
指定 Azure 现成虚拟机和 Azure 现成规模集的逐出策略。 <br>``<br>
对于 Azure 现成虚拟机,支持“Deallocate”和“Delete”,最低 api 版本为 2019-03-01。
:code:<br>
:code:>><<<br>
对于 Azure 现成规模集,支持“Deallocate”和“Delete”,最低 api 版本为 2017-10-30-preview。 已知值为:“Deallocate”和“Delete”。
- billing_profile
- BillingProfile
指定 Azure 现成虚拟机的计费相关详细信息。 <br>
:code:>><<<br>
Minimum api-version: 2019-03-01。
- host
- SubResource
指定有关虚拟机所在的专用主机的信息。 <br>
:code:>><<<br>
最低 api-version:2018-10-01。
- host_group
- SubResource
指定有关虚拟机所在的专用主机组的信息。 <br>``<br>
最低 API 版本:2020-06-01。
:code:<br>
:code:>><<<br>
注意:用户不能同时指定 host 和 hostGroup 属性。
- license_type
- str
指定正在使用的映像或磁盘在本地获得许可。 <br>``<br>
Windows Server 操作系统的可能值为: <br>``<br>
Windows_Client <br>``<br>
Windows_Server <br>``<br>
Linux Server 操作系统的可能值为:<br>``<br>
适用于 SUSE) 的 RHEL) <br>``<br>
SLES_BYOS (的 RHEL_BYOS (<br>``<br>
有关详细信息,请参阅适用于 Linux Server 的 Azure混合使用权益(适用于 Linux Server<br>``<br>
<br>``<br>
的 Azure 混合使用权益最低 api-version:2015-06-15)。
- extensions_time_budget
- str
指定为所有扩展分配的启动时间。 持续时间应介于 15 分钟到 120 分钟之间, (包括) ,并且应以 ISO 8601 格式指定。 PT1H30M) (默认值为 90 分钟。 <br>``<br>
最低 API 版本:2020-06-01。
- platform_fault_domain
- int
指定要在其中创建虚拟机的规模集逻辑容错域。 默认情况下,虚拟机将自动分配给容错域,该容错域最好地在可用容错域之间保持平衡。:code:<li>
仅当已设置此虚拟机的“virtualMachineScaleSet”属性时,这才适用。:code:<li>
引用的虚拟机规模集必须具有“platformFaultDomainCount” > 1。:code:<li>
此属性在创建虚拟机后无法更新。:code:<li>
容错域分配可以在虚拟机实例视图中查看。:code:<br>
:code:>><<<br>
最小 api-version: 2020‐12‐01.
- scheduled_events_profile
- ScheduledEventsProfile
指定与计划事件相关的配置。
- user_data
- str
VM 的 UserData,必须采用 base-64 编码。 客户不应在此处传递任何机密。 <br>
:code:>><<<br>
最低 api-version:2021-03-01。
- capacity_reservation
- CapacityReservationProfile
指定有关用于分配虚拟机的容量预留的信息。 <br>
:code:>><<<br>
最低 api-version:2021-04-01。
变量
- id
- str
资源 ID。
- name
- str
资源名称。
- type
- str
资源类型。
- location
- str
资源位置。 必需。
- plan
- Plan
指定用于创建虚拟机的市场映像的相关信息。 此元素仅用于市场映像。 必须先启用该映像以供编程使用,然后才能从 API 使用市场映像。 在Azure 门户,找到要使用的市场映像,然后单击“想要以编程方式部署”“入门”->。 输入任何所需信息,然后单击“ 保存”。
- resources
- list[VirtualMachineExtension]
虚拟机子扩展资源。
- identity
- VirtualMachineIdentity
虚拟机的标识(如果已配置)。
- extended_location
- ExtendedLocation
虚拟机的扩展位置。
- hardware_profile
- HardwareProfile
指定虚拟机的硬件设置。
- storage_profile
- StorageProfile
指定虚拟机磁盘的存储设置。
- additional_capabilities
- AdditionalCapabilities
指定在虚拟机上启用或禁用的其他功能。
- os_profile
- OSProfile
指定创建虚拟机时使用的操作系统设置。 预配 VM 后,某些设置无法更改。
- network_profile
- NetworkProfile
指定虚拟机的网络接口。
- security_profile
- SecurityProfile
指定虚拟机的安全相关配置文件设置。
- diagnostics_profile
- DiagnosticsProfile
指定启动诊断设置状态。
<br>
:code:>><<<br>
最低 api-version:2015-06-15。
- availability_set
- SubResource
指定虚拟机应分配到的可用性集的相关信息。 将在同一可用性集中指定的虚拟机分配给不同节点,以便尽量提高可用性。 有关可用性集的详细信息,请参阅 可用性集概述。
<br>``<br>
有关 Azure 计划内维护的详细信息,请参阅 Azure <br>``<br>
中虚拟机的维护和更新 目前,只能在创建时将 VM 添加到可用性集。 要添加 VM 的可用性集应与可用性集资源位于同一资源组下。 无法将现有 VM 添加到可用性集。
<br>
:code:>><<<br>
此属性不能与非 null properties.virtualMachineScaleSet 引用一起存在。
- virtual_machine_scale_set
- SubResource
指定虚拟机应分配到的虚拟机规模集的相关信息。 在同一虚拟机规模集中指定的虚拟机将分配到不同的节点,以最大程度地提高可用性。 目前,只能在创建时将 VM 添加到虚拟机规模集。 无法将现有 VM 添加到虚拟机规模集。 <br>``<br>
此属性不能与非 null properties.availabilitySet 引用一起存在。 :code:<br>
:code:>><<<br>
Minimum api-version: 2019?03?01。
- proximity_placement_group
- SubResource
指定虚拟机应分配到的邻近放置组的相关信息。 <br>
:code:>><<<br>
Minimum api-version:2018-04-01。
- priority
- str 或 VirtualMachinePriorityTypes
指定虚拟机的优先级。 <br>
:code:>><<<br>
Minimum api-version:2019-03-01。 已知值为:“Regular”、“Low”和“Spot”。
- eviction_policy
- str 或 VirtualMachineEvictionPolicyTypes
指定 Azure 现成虚拟机和 Azure 现成规模集的逐出策略。 <br>``<br>
对于 Azure 现成虚拟机,支持“Deallocate”和“Delete”,最低 API 版本为 2019-03-01。
:code:<br>
:code:>><<<br>
对于 Azure 现成规模集,支持“Deallocate”和“Delete”,最低 API 版本为 2017-10-30-preview。 已知值为:“Deallocate”和“Delete”。
- billing_profile
- BillingProfile
指定 Azure 现成虚拟机的计费相关详细信息。
<br>
:code:>><<<br>
Minimum api-version:2019-03-01。
- host
- SubResource
指定有关虚拟机所在的专用主机的信息。
<br>
:code:>><<<br>
Minimum api-version:2018-10-01。
- host_group
- SubResource
指定有关虚拟机所在的专用主机组的信息。 <br>``<br>
最低 API 版本:2020-06-01。
:code:<br>
:code:>><<<br>
注意:用户不能同时指定 host 和 hostGroup 属性。
- provisioning_state
- str
预配状态,仅显示在响应中。
- instance_view
- VirtualMachineInstanceView
虚拟机实例视图。
- license_type
- str
指定正在使用的映像或磁盘已在本地获得许可。 <br>``<br>
Windows Server 操作系统的可能值为: <br>``<br>
Windows_Client <br>``<br>
Windows_Server <br>``<br>
Linux Server 操作系统的可能值为: <br>``<br>
SUSE) RHEL) <br>``<br>
SLES_BYOS (RHEL_BYOS (<br>``<br>
有关详细信息,请参阅适用于 Linux<br>``<br>
Server 的 Windows Server <br>``<br>
Azure 混合使用权益的 Azure 混合使用权益最低 api 版本:2015-06-15。
- vm_id
- str
指定 VM 唯一 ID,它是一个 128 位标识符,已编码并存储在所有 Azure IaaS VM SMBIOS 中,可以使用平台 BIOS 命令进行读取。
- extensions_time_budget
- str
指定分配的所有扩展的开始时间。 持续时间应介于 15 分钟到 120 分钟之间, (含) ,并且应以 ISO 8601 格式指定。 默认值为 PT1H30M) (90 分钟。 <br>``<br>
最低 API 版本:2020-06-01。
- platform_fault_domain
- int
指定要在其中创建虚拟机的规模集逻辑容错域。 默认情况下,虚拟机将自动分配给容错域,该容错域最好地跨可用容错域保持平衡。:code:<li>
仅当此虚拟机的“virtualMachineScaleSet”属性设置为时适用。:code:<li>
引用的虚拟机规模集必须具有“platformFaultDomainCount” > 1.:code:此属性:<li>
在创建虚拟机后无法更新此属性。:code:<li>
容错域分配可以在虚拟机实例视图中查看。:code:<br>
:code:code:>><<<br>
Minimum api-version: 2020‐12‐01.
- scheduled_events_profile
- ScheduledEventsProfile
指定与计划事件相关的配置。
- user_data
- str
VM 的 UserData,必须采用 base-64 编码。 客户不应在此处传递任何机密。 <br>
:code:>><<<br>
Minimum api-version:2021-03-01。
- capacity_reservation
- CapacityReservationProfile
指定有关用于分配虚拟机的容量预留的信息。 <br>
:code:>><<<br>
Minimum api-version:2021-04-01。