VirtualMachine Interface

Package:
com.azure.resourcemanager.networkcloud.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-networkcloud:2.1.0

public interface VirtualMachine

An immutable client-side representation of VirtualMachine.

Method Summary

Modifier and Type Method and Description
abstract String adminUsername()

Gets the adminUsername property: The name of the administrator to which the ssh public keys will be added into the authorized keys.
abstract OperationStatusResult assignRelay()

Assigns a relay to the specified Microsoft.HybridCompute machine.
abstract OperationStatusResult assignRelay(VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

Assigns a relay to the specified Microsoft.HybridCompute machine.
abstract String availabilityZone()

Gets the availabilityZone property: The cluster availability zone containing this virtual machine.
abstract String bareMetalMachineId()

Gets the bareMetalMachineId property: The resource ID of the bare metal machine that hosts the virtual machine.
abstract VirtualMachineBootMethod bootMethod()

Gets the bootMethod property: Selects the boot method for the virtual machine.
abstract NetworkAttachment cloudServicesNetworkAttachment()

Gets the cloudServicesNetworkAttachment property: The cloud service network that provides platform-level services for the virtual machine.
abstract String clusterId()

Gets the clusterId property: The resource ID of the cluster the virtual machine is created for.
abstract ExtendedLocation consoleExtendedLocation()

Gets the consoleExtendedLocation property: The extended location to use for creation of a VM console resource.
abstract long cpuCores()

Gets the cpuCores property: The number of CPU cores in the virtual machine.
abstract VirtualMachineDetailedStatus detailedStatus()

Gets the detailedStatus property: The more detailed status of the virtual machine.
abstract String detailedStatusMessage()

Gets the detailedStatusMessage property: The descriptive message about the current detailed status.
abstract String etag()

Gets the etag property: Resource ETag.
abstract ExtendedLocation extendedLocation()

Gets the extendedLocation property: The extended location of the cluster associated with the resource.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedServiceIdentity identity()

Gets the identity property: The identity for the resource.
abstract VirtualMachineInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.VirtualMachineInner object.
abstract VirtualMachineIsolateEmulatorThread isolateEmulatorThread()

Gets the isolateEmulatorThread property: Field Deprecated, the value will be ignored if provided.
abstract String location()

Gets the location property: The geo-location where the resource lives.
abstract long memorySizeGB()

Gets the memorySizeGB property: The memory size of the virtual machine.
abstract String name()

Gets the name property: The name of the resource.
abstract List<NetworkAttachment> networkAttachments()

Gets the networkAttachments property: The list of network attachments to the virtual machine.
abstract String networkData()

Gets the networkData property: Field Deprecated: The Base64 encoded cloud-init network data.
abstract String networkDataContent()

Gets the networkDataContent property: The Base64 encoded cloud-init network data.
abstract List<VirtualMachinePlacementHint> placementHints()

Gets the placementHints property: The scheduling hints for the virtual machine.
abstract OperationStatusResult powerOff()

Power off the virtual machine.
abstract OperationStatusResult powerOff(VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the virtual machine.
abstract VirtualMachinePowerState powerState()

Gets the powerState property: The power state of the virtual machine.
abstract VirtualMachineProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the virtual machine.
abstract VirtualMachine refresh()

Refreshes the resource to sync with Azure.
abstract VirtualMachine refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract OperationStatusResult reimage()

Reimage the virtual machine.
abstract OperationStatusResult reimage(Context context)

Reimage the virtual machine.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract OperationStatusResult restart()

Restart the virtual machine.
abstract OperationStatusResult restart(Context context)

Restart the virtual machine.
abstract List<SshPublicKey> sshPublicKeys()

Gets the sshPublicKeys property: The list of ssh public keys.
abstract OperationStatusResult start()

Start the virtual machine.
abstract OperationStatusResult start(Context context)

Start the virtual machine.
abstract StorageProfile storageProfile()

Gets the storageProfile property: The storage profile that specifies size and other parameters about the disks related to the virtual machine.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the VirtualMachine resource.
abstract String userData()

Gets the userData property: Field Deprecated: The Base64 encoded cloud-init user data.
abstract String userDataContent()

Gets the userDataContent property: The Base64 encoded cloud-init user data.
abstract VirtualMachineVirtioInterfaceType virtioInterface()

Gets the virtioInterface property: Field Deprecated, use virtualizationModel instead.
abstract VirtualMachineDeviceModelType vmDeviceModel()

Gets the vmDeviceModel property: The type of the device model to use.
abstract String vmImage()

Gets the vmImage property: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
abstract ImageRepositoryCredentials vmImageRepositoryCredentials()

Gets the vmImageRepositoryCredentials property: The credentials used to login to the image repository that has access to the specified image.
abstract List<String> volumes()

Gets the volumes property: The resource IDs of volumes that are attached to the virtual machine.

Method Details

adminUsername

public abstract String adminUsername()

Gets the adminUsername property: The name of the administrator to which the ssh public keys will be added into the authorized keys.

Returns:

the adminUsername value.

assignRelay

public abstract OperationStatusResult assignRelay()

Assigns a relay to the specified Microsoft.HybridCompute machine. Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.

Returns:

the current status of an async operation.

assignRelay

public abstract OperationStatusResult assignRelay(VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

Assigns a relay to the specified Microsoft.HybridCompute machine. Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.

Parameters:

virtualMachineAssignRelayParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

availabilityZone

public abstract String availabilityZone()

Gets the availabilityZone property: The cluster availability zone containing this virtual machine.

Returns:

the availabilityZone value.

bareMetalMachineId

public abstract String bareMetalMachineId()

Gets the bareMetalMachineId property: The resource ID of the bare metal machine that hosts the virtual machine.

Returns:

the bareMetalMachineId value.

bootMethod

public abstract VirtualMachineBootMethod bootMethod()

Gets the bootMethod property: Selects the boot method for the virtual machine.

Returns:

the bootMethod value.

cloudServicesNetworkAttachment

public abstract NetworkAttachment cloudServicesNetworkAttachment()

Gets the cloudServicesNetworkAttachment property: The cloud service network that provides platform-level services for the virtual machine.

Returns:

the cloudServicesNetworkAttachment value.

clusterId

public abstract String clusterId()

Gets the clusterId property: The resource ID of the cluster the virtual machine is created for.

Returns:

the clusterId value.

consoleExtendedLocation

public abstract ExtendedLocation consoleExtendedLocation()

Gets the consoleExtendedLocation property: The extended location to use for creation of a VM console resource.

Returns:

the consoleExtendedLocation value.

cpuCores

public abstract long cpuCores()

Gets the cpuCores property: The number of CPU cores in the virtual machine.

Returns:

the cpuCores value.

detailedStatus

public abstract VirtualMachineDetailedStatus detailedStatus()

Gets the detailedStatus property: The more detailed status of the virtual machine.

Returns:

the detailedStatus value.

detailedStatusMessage

public abstract String detailedStatusMessage()

Gets the detailedStatusMessage property: The descriptive message about the current detailed status.

Returns:

the detailedStatusMessage value.

etag

public abstract String etag()

Gets the etag property: Resource ETag.

Returns:

the etag value.

extendedLocation

public abstract ExtendedLocation extendedLocation()

Gets the extendedLocation property: The extended location of the cluster associated with the resource.

Returns:

the extendedLocation value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: The identity for the resource.

Returns:

the identity value.

innerModel

public abstract VirtualMachineInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.VirtualMachineInner object.

Returns:

the inner object.

isolateEmulatorThread

public abstract VirtualMachineIsolateEmulatorThread isolateEmulatorThread()

Gets the isolateEmulatorThread property: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.

Returns:

the isolateEmulatorThread value.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

memorySizeGB

public abstract long memorySizeGB()

Gets the memorySizeGB property: The memory size of the virtual machine. Allocations are measured in gibibytes.

Returns:

the memorySizeGB value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkAttachments

public abstract List<NetworkAttachment> networkAttachments()

Gets the networkAttachments property: The list of network attachments to the virtual machine.

Returns:

the networkAttachments value.

networkData

public abstract String networkData()

Gets the networkData property: Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.

Returns:

the networkData value.

networkDataContent

public abstract String networkDataContent()

Gets the networkDataContent property: The Base64 encoded cloud-init network data.

Returns:

the networkDataContent value.

placementHints

public abstract List<VirtualMachinePlacementHint> placementHints()

Gets the placementHints property: The scheduling hints for the virtual machine.

Returns:

the placementHints value.

powerOff

public abstract OperationStatusResult powerOff()

Power off the virtual machine. Power off the provided virtual machine.

Returns:

the current status of an async operation.

powerOff

public abstract OperationStatusResult powerOff(VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the virtual machine. Power off the provided virtual machine.

Parameters:

virtualMachinePowerOffParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

powerState

public abstract VirtualMachinePowerState powerState()

Gets the powerState property: The power state of the virtual machine.

Returns:

the powerState value.

provisioningState

public abstract VirtualMachineProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the virtual machine.

Returns:

the provisioningState value.

refresh

public abstract VirtualMachine refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract VirtualMachine refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

reimage

public abstract OperationStatusResult reimage()

Reimage the virtual machine. Reimage the provided virtual machine.

Returns:

the current status of an async operation.

reimage

public abstract OperationStatusResult reimage(Context context)

Reimage the virtual machine. Reimage the provided virtual machine.

Parameters:

context - The context to associate with this operation.

Returns:

the current status of an async operation.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

restart

public abstract OperationStatusResult restart()

Restart the virtual machine. Restart the provided virtual machine.

Returns:

the current status of an async operation.

restart

public abstract OperationStatusResult restart(Context context)

Restart the virtual machine. Restart the provided virtual machine.

Parameters:

context - The context to associate with this operation.

Returns:

the current status of an async operation.

sshPublicKeys

public abstract List<SshPublicKey> sshPublicKeys()

Gets the sshPublicKeys property: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.

Returns:

the sshPublicKeys value.

start

public abstract OperationStatusResult start()

Start the virtual machine. Start the provided virtual machine.

Returns:

the current status of an async operation.

start

public abstract OperationStatusResult start(Context context)

Start the virtual machine. Start the provided virtual machine.

Parameters:

context - The context to associate with this operation.

Returns:

the current status of an async operation.

storageProfile

public abstract StorageProfile storageProfile()

Gets the storageProfile property: The storage profile that specifies size and other parameters about the disks related to the virtual machine.

Returns:

the storageProfile value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract VirtualMachine.Update update()

Begins update for the VirtualMachine resource.

Returns:

the stage of resource update.

userData

public abstract String userData()

Gets the userData property: Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.

Returns:

the userData value.

userDataContent

public abstract String userDataContent()

Gets the userDataContent property: The Base64 encoded cloud-init user data.

Returns:

the userDataContent value.

virtioInterface

public abstract VirtualMachineVirtioInterfaceType virtioInterface()

Gets the virtioInterface property: Field Deprecated, use virtualizationModel instead. The type of the virtio interface.

Returns:

the virtioInterface value.

vmDeviceModel

public abstract VirtualMachineDeviceModelType vmDeviceModel()

Gets the vmDeviceModel property: The type of the device model to use.

Returns:

the vmDeviceModel value.

vmImage

public abstract String vmImage()

Gets the vmImage property: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.

Returns:

the vmImage value.

vmImageRepositoryCredentials

public abstract ImageRepositoryCredentials vmImageRepositoryCredentials()

Gets the vmImageRepositoryCredentials property: The credentials used to login to the image repository that has access to the specified image.

Returns:

the vmImageRepositoryCredentials value.

volumes

public abstract List<String> volumes()

Gets the volumes property: The resource IDs of volumes that are attached to the virtual machine.

Returns:

the volumes value.

Applies to