Package com.azure.resourcemanager.scvmm.models

Interface VirtualMachine

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

    • Method Detail

      • 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.

      • systemData

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

      • extendedLocation

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

      • inventoryItemId

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

      • vmmServerId

        String vmmServerId()
        Gets the vmmServerId property: ARM Id of the vmmServer resource in which this resource resides.
        Returns:
        the vmmServerId value.

      • cloudId

        String cloudId()
        Gets the cloudId property: ARM Id of the cloud resource to use for deploying the vm.
        Returns:
        the cloudId value.

      • templateId

        String templateId()
        Gets the templateId property: ARM Id of the template resource to use for deploying the vm.
        Returns:
        the templateId value.

      • checkpointType

        String checkpointType()
        Gets the checkpointType property: Type of checkpoint supported for the vm.
        Returns:
        the checkpointType value.

      • checkpoints

        List<Checkpoint> checkpoints()
        Gets the checkpoints property: Checkpoints in the vm.
        Returns:
        the checkpoints value.

      • availabilitySets

        List<AvailabilitySetListItem> availabilitySets()
        Gets the availabilitySets property: Availability Sets in vm.
        Returns:
        the availabilitySets 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.

      • vmName

        String vmName()
        Gets the vmName property: VMName is the name of VM on the SCVMM server.
        Returns:
        the vmName value.

      • uuid

        String uuid()
        Gets the uuid property: Unique ID of the virtual machine.
        Returns:
        the uuid value.

      • generation

        Integer generation()
        Gets the generation property: Gets or sets the generation for the vm.
        Returns:
        the generation value.

      • powerState

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

      • provisioningState

        String provisioningState()
        Gets the provisioningState property: Gets or sets the provisioning state.
        Returns:
        the provisioningState 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.

      • innerModel

        VirtualMachineInner innerModel()
        Gets the inner com.azure.resourcemanager.scvmm.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)
        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()
        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)
        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()
        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)
        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()
        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)
        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.

      • createCheckpoint

        void createCheckpoint​(VirtualMachineCreateCheckpoint body)
        Creates a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine create checkpoint 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.

      • createCheckpoint

        void createCheckpoint()
        Creates a checkpoint in 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.

      • createCheckpoint

        void createCheckpoint​(VirtualMachineCreateCheckpoint body,
                      com.azure.core.util.Context context)
        Creates a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine create checkpoint 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.

      • deleteCheckpoint

        void deleteCheckpoint​(VirtualMachineDeleteCheckpoint body)
        Deletes a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine delete checkpoint 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.

      • deleteCheckpoint

        void deleteCheckpoint()
        Deletes a checkpoint in 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.

      • deleteCheckpoint

        void deleteCheckpoint​(VirtualMachineDeleteCheckpoint body,
                      com.azure.core.util.Context context)
        Deletes a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine delete checkpoint 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.

      • restoreCheckpoint

        void restoreCheckpoint​(VirtualMachineRestoreCheckpoint body)
        Restores to a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine restore checkpoint 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.

      • restoreCheckpoint

        void restoreCheckpoint()
        Restores to a checkpoint in 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.

      • restoreCheckpoint

        void restoreCheckpoint​(VirtualMachineRestoreCheckpoint body,
                       com.azure.core.util.Context context)
        Restores to a checkpoint in virtual machine.
        Parameters:
        body - Virtualmachine restore checkpoint 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.