Class VirtualMachineScaleSetVMInner
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.compute.fluent.models.VirtualMachineScaleSetVMInner
public final class VirtualMachineScaleSetVMInner
extends com.azure.core.management.Resource
Describes a virtual machine scale set virtual machine.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of VirtualMachineScaleSetVMInner class. -
Method Summary
Modifier and TypeMethodDescriptionGet the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set.com.azure.core.management.SubResourceGet the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to.Get the diagnosticsProfile property: Specifies the boot diagnostic settings state.etag()Get the etag property: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.Get the hardwareProfile property: Specifies the hardware settings for the virtual machine.identity()Get the identity property: The identity of the virtual machine, if configured.Get the instanceId property: The virtual machine instance ID.Get the instanceView property: The virtual machine instance view.Get the latestModelApplied property: Specifies whether the latest model has been applied to the virtual machine.Get the licenseType property: Specifies that the image or disk that is being used was licensed on-premises.Get the modelDefinitionApplied property: 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.Get the networkProfile property: Specifies the network interfaces of the virtual machine.Get the networkProfileConfiguration property: Specifies the network profile configuration of the virtual machine.Get the osProfile property: Specifies the operating system settings for the virtual machine.plan()Get the plan property: Specifies information about the marketplace image used to create the virtual machine.Get the protectionPolicy property: Specifies the protection policy of the virtual machine.Get the provisioningState property: The provisioning state, which only appears in the response.Get the resources property: The virtual machine child extension resources.Get the securityProfile property: Specifies the Security related profile settings for the virtual machine.sku()Get the sku property: The virtual machine SKU.Get the storageProfile property: Specifies the storage settings for the virtual machine disks.Get the timeCreated property: Specifies the time at which the Virtual Machine resource was created.userData()Get the userData property: UserData for the VM, which must be base-64 encoded.voidvalidate()Validates the instance.vmId()Get the vmId property: Azure VM unique ID.withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities) Set the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set.withAvailabilitySet(com.azure.core.management.SubResource availabilitySet) Set the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to.withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile) Set the diagnosticsProfile property: Specifies the boot diagnostic settings state.withHardwareProfile(HardwareProfile hardwareProfile) Set the hardwareProfile property: Specifies the hardware settings for the virtual machine.withIdentity(VirtualMachineIdentity identity) Set the identity property: The identity of the virtual machine, if configured.withLicenseType(String licenseType) Set the licenseType property: Specifies that the image or disk that is being used was licensed on-premises.withLocation(String location) withNetworkProfile(NetworkProfile networkProfile) Set the networkProfile property: Specifies the network interfaces of the virtual machine.withNetworkProfileConfiguration(VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration) Set the networkProfileConfiguration property: Specifies the network profile configuration of the virtual machine.withOsProfile(OSProfile osProfile) Set the osProfile property: Specifies the operating system settings for the virtual machine.Set the plan property: Specifies information about the marketplace image used to create the virtual machine.withProtectionPolicy(VirtualMachineScaleSetVMProtectionPolicy protectionPolicy) Set the protectionPolicy property: Specifies the protection policy of the virtual machine.withSecurityProfile(SecurityProfile securityProfile) Set the securityProfile property: Specifies the Security related profile settings for the virtual machine.withStorageProfile(StorageProfile storageProfile) Set the storageProfile property: Specifies the storage settings for the virtual machine disks.withUserData(String userData) Set the userData property: UserData for the VM, which must be base-64 encoded.zones()Get the zones property: The virtual machine zones.Methods inherited from class com.azure.core.management.Resource
location, tagsMethods inherited from class com.azure.core.management.ProxyResource
id, name, type
-
Constructor Details
-
VirtualMachineScaleSetVMInner
public VirtualMachineScaleSetVMInner()Creates an instance of VirtualMachineScaleSetVMInner class.
-
-
Method Details
-
instanceId
Get the instanceId property: The virtual machine instance ID.- Returns:
- the instanceId value.
-
sku
Get the sku property: The virtual machine SKU.- Returns:
- the sku value.
-
plan
Get the plan property: 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**.- Returns:
- the plan value.
-
withPlan
Set the plan property: 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**.- Parameters:
plan- the plan value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
resources
Get the resources property: The virtual machine child extension resources.- Returns:
- the resources value.
-
zones
Get the zones property: The virtual machine zones.- Returns:
- the zones value.
-
identity
Get the identity property: The identity of the virtual machine, if configured.- Returns:
- the identity value.
-
withIdentity
Set the identity property: The identity of the virtual machine, if configured.- Parameters:
identity- the identity value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
etag
Get the etag property: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.- Returns:
- the etag value.
-
withLocation
- Overrides:
withLocationin classcom.azure.core.management.Resource
-
withTags
- Overrides:
withTagsin classcom.azure.core.management.Resource
-
latestModelApplied
Get the latestModelApplied property: Specifies whether the latest model has been applied to the virtual machine.- Returns:
- the latestModelApplied value.
-
vmId
Get the vmId property: Azure VM unique ID.- Returns:
- the vmId value.
-
instanceView
Get the instanceView property: The virtual machine instance view.- Returns:
- the instanceView value.
-
hardwareProfile
Get the hardwareProfile property: Specifies the hardware settings for the virtual machine.- Returns:
- the hardwareProfile value.
-
withHardwareProfile
Set the hardwareProfile property: Specifies the hardware settings for the virtual machine.- Parameters:
hardwareProfile- the hardwareProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
storageProfile
Get the storageProfile property: Specifies the storage settings for the virtual machine disks.- Returns:
- the storageProfile value.
-
withStorageProfile
Set the storageProfile property: Specifies the storage settings for the virtual machine disks.- Parameters:
storageProfile- the storageProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
additionalCapabilities
Get the additionalCapabilities property: 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.- Returns:
- the additionalCapabilities value.
-
withAdditionalCapabilities
public VirtualMachineScaleSetVMInner withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities) Set the additionalCapabilities property: 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.- Parameters:
additionalCapabilities- the additionalCapabilities value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
osProfile
Get the osProfile property: Specifies the operating system settings for the virtual machine.- Returns:
- the osProfile value.
-
withOsProfile
Set the osProfile property: Specifies the operating system settings for the virtual machine.- Parameters:
osProfile- the osProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
securityProfile
Get the securityProfile property: Specifies the Security related profile settings for the virtual machine.- Returns:
- the securityProfile value.
-
withSecurityProfile
Set the securityProfile property: Specifies the Security related profile settings for the virtual machine.- Parameters:
securityProfile- the securityProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
networkProfile
Get the networkProfile property: Specifies the network interfaces of the virtual machine.- Returns:
- the networkProfile value.
-
withNetworkProfile
Set the networkProfile property: Specifies the network interfaces of the virtual machine.- Parameters:
networkProfile- the networkProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
networkProfileConfiguration
Get the networkProfileConfiguration property: Specifies the network profile configuration of the virtual machine.- Returns:
- the networkProfileConfiguration value.
-
withNetworkProfileConfiguration
public VirtualMachineScaleSetVMInner withNetworkProfileConfiguration(VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration) Set the networkProfileConfiguration property: Specifies the network profile configuration of the virtual machine.- Parameters:
networkProfileConfiguration- the networkProfileConfiguration value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
diagnosticsProfile
Get the diagnosticsProfile property: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.- Returns:
- the diagnosticsProfile value.
-
withDiagnosticsProfile
Set the diagnosticsProfile property: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.- Parameters:
diagnosticsProfile- the diagnosticsProfile value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
availabilitySet
public com.azure.core.management.SubResource availabilitySet()Get the availabilitySet property: 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.- Returns:
- the availabilitySet value.
-
withAvailabilitySet
public VirtualMachineScaleSetVMInner withAvailabilitySet(com.azure.core.management.SubResource availabilitySet) Set the availabilitySet property: 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.- Parameters:
availabilitySet- the availabilitySet value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
provisioningState
Get the provisioningState property: The provisioning state, which only appears in the response.- Returns:
- the provisioningState value.
-
licenseType
Get the licenseType property: 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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15.- Returns:
- the licenseType value.
-
withLicenseType
Set the licenseType property: 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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15.- Parameters:
licenseType- the licenseType value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
modelDefinitionApplied
Get the modelDefinitionApplied property: 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.- Returns:
- the modelDefinitionApplied value.
-
protectionPolicy
Get the protectionPolicy property: Specifies the protection policy of the virtual machine.- Returns:
- the protectionPolicy value.
-
withProtectionPolicy
public VirtualMachineScaleSetVMInner withProtectionPolicy(VirtualMachineScaleSetVMProtectionPolicy protectionPolicy) Set the protectionPolicy property: Specifies the protection policy of the virtual machine.- Parameters:
protectionPolicy- the protectionPolicy value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
userData
Get the userData property: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01.- Returns:
- the userData value.
-
withUserData
Set the userData property: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01.- Parameters:
userData- the userData value to set.- Returns:
- the VirtualMachineScaleSetVMInner object itself.
-
timeCreated
Get the timeCreated property: Specifies the time at which the Virtual Machine resource was created.- Returns:
- the timeCreated value.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-