Package com.azure.resourcemanager.connectedvmware.models

Interface VirtualMachine

public interface VirtualMachine
An immutable client-side representation of VirtualMachine.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    VirtualMachine.Definition
    The entirety of the VirtualMachine definition.
    static interface 
    VirtualMachine.DefinitionStages
    The VirtualMachine definition stages.
    static interface 
    VirtualMachine.Update
    The template for VirtualMachine update.
    static interface 
    VirtualMachine.UpdateStages
    The VirtualMachine update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    customResourceName()
    Gets the customResourceName property: Gets the name of the corresponding resource in Kubernetes.
    ExtendedLocation
    extendedLocation()
    Gets the extendedLocation property: Gets or sets the extended location.
    FirmwareType
    firmwareType()
    Gets the firmwareType property: Firmware type.
    String
    folderPath()
    Gets the folderPath property: Gets or sets the folder path of the vm.
    GuestAgentProfile
    guestAgentProfile()
    Gets the guestAgentProfile property: Guest agent status properties.
    HardwareProfile
    hardwareProfile()
    Gets the hardwareProfile property: Hardware properties.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    Identity
    identity()
    Gets the identity property: The identity of the resource.
    VirtualMachineInner
    innerModel()
    Gets the inner com.azure.resourcemanager.connectedvmware.fluent.models.VirtualMachineInner object.
    String
    instanceUuid()
    Gets the instanceUuid property: Gets or sets the instance uuid of the vm.
    String
    inventoryItemId()
    Gets the inventoryItemId property: Gets or sets the inventory Item ID for the virtual machine.
    String
    kind()
    Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    String
    moName()
    Gets the moName property: Gets or sets the vCenter Managed Object name for the virtual machine.
    String
    moRefId()
    Gets the moRefId property: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.
    String
    name()
    Gets the name property: The name of the resource.
    NetworkProfile
    networkProfile()
    Gets the networkProfile property: Network properties.
    OsProfile
    osProfile()
    Gets the osProfile property: OS properties.
    PlacementProfile
    placementProfile()
    Gets the placementProfile property: Placement properties.
    String
    powerState()
    Gets the powerState property: Gets the power state of the virtual machine.
    String
    provisioningState()
    Gets the provisioningState property: Gets or sets the provisioning state.
    VirtualMachine
    refresh()
    Refreshes the resource to sync with Azure.
    VirtualMachine
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    String
    resourcePoolId()
    Gets the resourcePoolId property: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.
    void
    restart()
    Implements the operation to restart a virtual machine.
    void
    restart(com.azure.core.util.Context context)
    Implements the operation to restart a virtual machine.
    SecurityProfile
    securityProfile()
    Gets the securityProfile property: Gets the security profile.
    String
    smbiosUuid()
    Gets the smbiosUuid property: Gets or sets the SMBIOS UUID of the vm.
    void
    start()
    Implements the operation to start a virtual machine.
    void
    start(com.azure.core.util.Context context)
    Implements the operation to start a virtual machine.
    List<ResourceStatus>
    statuses()
    Gets the statuses property: The resource status information.
    void
    stop()
    Implements the operation to stop a virtual machine.
    void
    stop(StopVirtualMachineOptions body)
    Implements the operation to stop a virtual machine.
    void
    stop(StopVirtualMachineOptions body, com.azure.core.util.Context context)
    Implements the operation to stop a virtual machine.
    StorageProfile
    storageProfile()
    Gets the storageProfile property: Storage properties.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: The system data.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    templateId()
    Gets the templateId property: Gets or sets the ARM Id of the template resource to deploy the virtual machine.
    String
    type()
    Gets the type property: The type of the resource.
    VirtualMachine.Update
    update()
    Begins update for the VirtualMachine resource.
    String
    uuid()
    Gets the uuid property: Gets or sets a unique identifier for this resource.
    String
    vCenterId()
    Gets the vCenterId property: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.
    String
    vmId()
    Gets the vmId property: Gets or sets a unique identifier for the vm resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • extendedLocation

      ExtendedLocation extendedLocation()
      Gets the extendedLocation property: Gets or sets the extended location.
      Returns:
      the extendedLocation value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system data.
      Returns:
      the systemData value.

    • kind

      String kind()
      Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
      Returns:
      the kind value.

    • identity

      Identity identity()
      Gets the identity property: The identity of the resource.
      Returns:
      the identity value.

    • resourcePoolId

      String resourcePoolId()
      Gets the resourcePoolId property: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.
      Returns:
      the resourcePoolId value.

    • templateId

      String templateId()
      Gets the templateId property: Gets or sets the ARM Id of the template resource to deploy the virtual machine.
      Returns:
      the templateId value.

    • vCenterId

      String vCenterId()
      Gets the vCenterId property: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.
      Returns:
      the vCenterId value.

    • placementProfile

      PlacementProfile placementProfile()
      Gets the placementProfile property: Placement properties.
      Returns:
      the placementProfile value.

    • osProfile

      OsProfile osProfile()
      Gets the osProfile property: OS properties.
      Returns:
      the osProfile value.

    • hardwareProfile

      HardwareProfile hardwareProfile()
      Gets the hardwareProfile property: Hardware properties.
      Returns:
      the hardwareProfile value.

    • networkProfile

      NetworkProfile networkProfile()
      Gets the networkProfile property: Network properties.
      Returns:
      the networkProfile value.

    • storageProfile

      StorageProfile storageProfile()
      Gets the storageProfile property: Storage properties.
      Returns:
      the storageProfile value.

    • guestAgentProfile

      GuestAgentProfile guestAgentProfile()
      Gets the guestAgentProfile property: Guest agent status properties.
      Returns:
      the guestAgentProfile value.

    • securityProfile

      SecurityProfile securityProfile()
      Gets the securityProfile property: Gets the security profile.
      Returns:
      the securityProfile value.

    • moRefId

      String moRefId()
      Gets the moRefId property: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.
      Returns:
      the moRefId value.

    • inventoryItemId

      String inventoryItemId()
      Gets the inventoryItemId property: Gets or sets the inventory Item ID for the virtual machine.
      Returns:
      the inventoryItemId value.

    • moName

      String moName()
      Gets the moName property: Gets or sets the vCenter Managed Object name for the virtual machine.
      Returns:
      the moName value.

    • folderPath

      String folderPath()
      Gets the folderPath property: Gets or sets the folder path of the vm.
      Returns:
      the folderPath value.

    • instanceUuid

      String instanceUuid()
      Gets the instanceUuid property: Gets or sets the instance uuid of the vm.
      Returns:
      the instanceUuid value.

    • smbiosUuid

      String smbiosUuid()
      Gets the smbiosUuid property: Gets or sets the SMBIOS UUID of the vm.
      Returns:
      the smbiosUuid value.

    • firmwareType

      FirmwareType firmwareType()
      Gets the firmwareType property: Firmware type.
      Returns:
      the firmwareType value.

    • powerState

      String powerState()
      Gets the powerState property: Gets the power state of the virtual machine.
      Returns:
      the powerState value.

    • customResourceName

      String customResourceName()
      Gets the customResourceName property: Gets the name of the corresponding resource in Kubernetes.
      Returns:
      the customResourceName value.

    • uuid

      String uuid()
      Gets the uuid property: Gets or sets a unique identifier for this resource.
      Returns:
      the uuid value.

    • statuses

      List<ResourceStatus> statuses()
      Gets the statuses property: The resource status information.
      Returns:
      the statuses value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: Gets or sets the provisioning state.
      Returns:
      the provisioningState value.

    • vmId

      String vmId()
      Gets the vmId property: Gets or sets a unique identifier for the vm resource.
      Returns:
      the vmId value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      VirtualMachineInner innerModel()
      Gets the inner com.azure.resourcemanager.connectedvmware.fluent.models.VirtualMachineInner object.
      Returns:
      the inner object.

    • update

      VirtualMachine.Update update()
      Begins update for the VirtualMachine resource.
      Returns:
      the stage of resource update.

    • refresh

      VirtualMachine refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      VirtualMachine refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • stop

      void stop(StopVirtualMachineOptions body)
      Implements the operation to stop a virtual machine.

      Stop virtual machine.

      Parameters:
      body - Virtualmachine stop action payload.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop()
      Implements the operation to stop a virtual machine.

      Stop virtual machine.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(StopVirtualMachineOptions body, com.azure.core.util.Context context)
      Implements the operation to stop a virtual machine.

      Stop virtual machine.

      Parameters:
      body - Virtualmachine stop action payload.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start()
      Implements the operation to start a virtual machine.

      Start virtual machine.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start(com.azure.core.util.Context context)
      Implements the operation to start a virtual machine.

      Start virtual machine.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restart

      void restart()
      Implements the operation to restart a virtual machine.

      Restart virtual machine.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restart

      void restart(com.azure.core.util.Context context)
      Implements the operation to restart a virtual machine.

      Restart virtual machine.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.