Interface VirtualMachines


  • public interface VirtualMachines
    Resource collection API of VirtualMachines.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<VirtualMachine> list​(String resourceGroupName,
                                                                    String privateCloudName,
                                                                    String clusterName)
        List of virtual machines in a private cloud cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        Returns:
        a list of Virtual Machines.
        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.
      • list

        com.azure.core.http.rest.PagedIterable<VirtualMachine> list​(String resourceGroupName,
                                                                    String privateCloudName,
                                                                    String clusterName,
                                                                    com.azure.core.util.Context context)
        List of virtual machines in a private cloud cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        context - The context to associate with this operation.
        Returns:
        a list of Virtual Machines.
        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.
      • get

        VirtualMachine get​(String resourceGroupName,
                           String privateCloudName,
                           String clusterName,
                           String virtualMachineId)
        Get a virtual machine by id in a private cloud cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        virtualMachineId - Virtual Machine identifier.
        Returns:
        a virtual machine by id in a private cloud cluster.
        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.
      • getWithResponse

        com.azure.core.http.rest.Response<VirtualMachine> getWithResponse​(String resourceGroupName,
                                                                          String privateCloudName,
                                                                          String clusterName,
                                                                          String virtualMachineId,
                                                                          com.azure.core.util.Context context)
        Get a virtual machine by id in a private cloud cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        virtualMachineId - Virtual Machine identifier.
        context - The context to associate with this operation.
        Returns:
        a virtual machine by id in a private cloud cluster.
        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.
      • restrictMovement

        void restrictMovement​(String resourceGroupName,
                              String privateCloudName,
                              String clusterName,
                              String virtualMachineId,
                              VirtualMachineRestrictMovement restrictMovement)
        Enable or disable DRS-driven VM movement restriction.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        virtualMachineId - Virtual Machine identifier.
        restrictMovement - Whether VM DRS-driven movement is restricted (Enabled) or not (Disabled).
        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.
      • restrictMovement

        void restrictMovement​(String resourceGroupName,
                              String privateCloudName,
                              String clusterName,
                              String virtualMachineId,
                              VirtualMachineRestrictMovement restrictMovement,
                              com.azure.core.util.Context context)
        Enable or disable DRS-driven VM movement restriction.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        clusterName - Name of the cluster in the private cloud.
        virtualMachineId - Virtual Machine identifier.
        restrictMovement - Whether VM DRS-driven movement is restricted (Enabled) or not (Disabled).
        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.