VirtualMachineScaleSetVM Class

Describes a virtual machine scale set virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.compute.v2021_04_01.models._models_py3.Resource

VirtualMachineScaleSetVM

Constructor

VirtualMachineScaleSetVM(*, location: str, tags: Dict[str, str] | None = None, plan: _models.Plan | 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, security_profile: _models.SecurityProfile | None = None, network_profile: _models.NetworkProfile | None = None, network_profile_configuration: _models.VirtualMachineScaleSetVMNetworkProfileConfiguration | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource | None = None, license_type: str | None = None, protection_policy: _models.VirtualMachineScaleSetVMProtectionPolicy | None = None, user_data: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
plan	Plan Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
hardware_profile	HardwareProfile Specifies the hardware settings for the virtual machine.
storage_profile	StorageProfile Specifies the storage settings for the virtual machine disks.
additional_capabilities	AdditionalCapabilities Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
os_profile	OSProfile Specifies the operating system settings for the virtual machine.
security_profile	SecurityProfile Specifies the Security related profile settings for the virtual machine.
network_profile	NetworkProfile Specifies the network interfaces of the virtual machine.
network_profile_configuration	VirtualMachineScaleSetVMNetworkProfileConfiguration Specifies the network profile configuration of the virtual machine.
diagnostics_profile	DiagnosticsProfile Specifies the boot diagnostic settings state. <br>:code:>><<<br>Minimum api-version: 2015-06-15.
availability_set	SubResource Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br>``<br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br>``<br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
license_type	str Specifies that the image or disk that is being used was licensed on-premises. <br>``<br> Possible values for Windows Server operating system are: <br>``<br> Windows_Client <br>``<br> Windows_Server <br>``<br> Possible values for Linux Server operating system are: <br>``<br> RHEL_BYOS (for RHEL) <br>``<br> SLES_BYOS (for SUSE) <br>``<br> For more information, see Azure Hybrid Use Benefit for Windows Server <br>``<br> Azure Hybrid Use Benefit for Linux Server <br>``<br> Minimum api-version: 2015-06-15.
protection_policy	VirtualMachineScaleSetVMProtectionPolicy Specifies the protection policy of the virtual machine.
user_data	str UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br>:code:>><<<br>Minimum api-version: 2021-03-01.

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
instance_id	str The virtual machine instance ID.
sku	Sku The virtual machine SKU.
plan	Plan Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
resources	list[VirtualMachineExtension] The virtual machine child extension resources.
zones	list[str] The virtual machine zones.
latest_model_applied	bool Specifies whether the latest model has been applied to the virtual machine.
vm_id	str Azure VM unique ID.
instance_view	VirtualMachineScaleSetVMInstanceView The virtual machine instance view.
hardware_profile	HardwareProfile Specifies the hardware settings for the virtual machine.
storage_profile	StorageProfile Specifies the storage settings for the virtual machine disks.
additional_capabilities	AdditionalCapabilities Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
os_profile	OSProfile Specifies the operating system settings for the virtual machine.
security_profile	SecurityProfile Specifies the Security related profile settings for the virtual machine.
network_profile	NetworkProfile Specifies the network interfaces of the virtual machine.
network_profile_configuration	VirtualMachineScaleSetVMNetworkProfileConfiguration Specifies the network profile configuration of the virtual machine.
diagnostics_profile	DiagnosticsProfile Specifies the boot diagnostic settings state. <br>:code:>><<<br>Minimum api-version: 2015-06-15.
availability_set	SubResource Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. <br>``<br> For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure <br>``<br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
provisioning_state	str The provisioning state, which only appears in the response.
license_type	str Specifies that the image or disk that is being used was licensed on-premises. <br>``<br> Possible values for Windows Server operating system are: <br>``<br> Windows_Client <br>``<br> Windows_Server <br>``<br> Possible values for Linux Server operating system are: <br>``<br> RHEL_BYOS (for RHEL) <br>``<br> SLES_BYOS (for SUSE) <br>``<br> For more information, see Azure Hybrid Use Benefit for Windows Server <br>``<br> Azure Hybrid Use Benefit for Linux Server <br>``<br> Minimum api-version: 2015-06-15.
model_definition_applied	str Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
protection_policy	VirtualMachineScaleSetVMProtectionPolicy Specifies the protection policy of the virtual machine.
user_data	str UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br>:code:>><<<br>Minimum api-version: 2021-03-01.