com.microsoft.azure.management.compute

Interface VirtualMachines

All Superinterfaces:

HasInner<com.microsoft.azure.management.compute.implementation.VirtualMachinesInner>, HasManager<com.microsoft.azure.management.compute.implementation.ComputeManager>, SupportsBatchCreation<VirtualMachine>, SupportsBatchDeletion, SupportsCreating<VirtualMachine.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsGettingById<VirtualMachine>, SupportsGettingByResourceGroup<VirtualMachine>, SupportsListing<VirtualMachine>, SupportsListingByResourceGroup<VirtualMachine>

public interface VirtualMachines
extends SupportsListing<VirtualMachine>, SupportsListingByResourceGroup<VirtualMachine>, SupportsGettingByResourceGroup<VirtualMachine>, SupportsGettingById<VirtualMachine>, SupportsCreating<VirtualMachine.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsBatchCreation<VirtualMachine>, SupportsBatchDeletion, HasManager<com.microsoft.azure.management.compute.implementation.ComputeManager>, HasInner<com.microsoft.azure.management.compute.implementation.VirtualMachinesInner>

Entry point to virtual machine management API.

Method Summary

Modifier and Type	Method and Description
String	capture(String groupName, String name, String containerName, String vhdPrefix, boolean overwriteVhd) Captures the virtual machine by copying virtual hard disks of the VM and returns template as a JSON string that can be used to create similar VMs.
rx.Observable<String>	captureAsync(String groupName, String name, String containerName, String vhdPrefix, boolean overwriteVhd) Captures the virtual machine by copying virtual hard disks of the VM asynchronously.
ServiceFuture<String>	captureAsync(String groupName, String name, String containerName, String vhdPrefix, boolean overwriteVhd, ServiceCallback<String> callback) Captures the virtual machine by copying virtual hard disks of the VM asynchronously.
void	deallocate(String groupName, String name) Shuts down the virtual machine and releases the compute resources.
rx.Completable	deallocateAsync(String groupName, String name) Shuts down the virtual machine and releases the compute resources asynchronously.
ServiceFuture<Void>	deallocateAsync(String groupName, String name, ServiceCallback<Void> callback) Shuts down the virtual machine and releases the compute resources asynchronously.
void	generalize(String groupName, String name) Generalizes the virtual machine.
rx.Completable	generalizeAsync(String groupName, String name) Generalizes the virtual machine asynchronously.
ServiceFuture<Void>	generalizeAsync(String groupName, String name, ServiceCallback<Void> callback) Generalizes the virtual machine asynchronously.
void	migrateToManaged(String groupName, String name) Migrates the virtual machine with unmanaged disks to use managed disks.
rx.Completable	migrateToManagedAsync(String groupName, String name) Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.
ServiceFuture<Void>	migrateToManagedAsync(String groupName, String name, ServiceCallback<Void> callback) Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.
void	powerOff(String groupName, String name) Powers off (stops) a virtual machine.
rx.Completable	powerOffAsync(String groupName, String name) Powers off (stops) the virtual machine asynchronously.
ServiceFuture<Void>	powerOffAsync(String groupName, String name, ServiceCallback<Void> callback) Powers off (stop) the virtual machine asynchronously.
void	redeploy(String groupName, String name) Redeploys a virtual machine.
rx.Completable	redeployAsync(String groupName, String name) Redeploys the virtual machine asynchronously.
ServiceFuture<Void>	redeployAsync(String groupName, String name, ServiceCallback<Void> callback) Redeploys the virtual machine asynchronously.
void	restart(String groupName, String name) Restarts a virtual machine.
rx.Completable	restartAsync(String groupName, String name) Restarts the virtual machine asynchronously.
ServiceFuture<Void>	restartAsync(String groupName, String name, ServiceCallback<Void> callback) Restarts the virtual machine asynchronously.
RunCommandResult	runCommand(String groupName, String name, RunCommandInput inputCommand) Run commands in a virtual machine.
rx.Observable<RunCommandResult>	runCommandAsync(String groupName, String name, RunCommandInput inputCommand) Run commands in a virtual machine asynchronously.
RunCommandResult	runPowerShellScript(String groupName, String name, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine.
rx.Observable<RunCommandResult>	runPowerShellScriptAsync(String groupName, String name, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine asynchronously.
RunCommandResult	runShellScript(String groupName, String name, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine.
rx.Observable<RunCommandResult>	runShellScriptAsync(String groupName, String name, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine asynchronously.
VirtualMachineSizes	sizes()
void	start(String groupName, String name) Starts a virtual machine.
rx.Completable	startAsync(String groupName, String name) Starts the virtual machine asynchronously.
ServiceFuture<Void>	startAsync(String groupName, String name, ServiceCallback<Void> callback) Starts the virtual machine asynchronously.

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing

list, listAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

listByResourceGroup, listByResourceGroupAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

getByResourceGroup, getByResourceGroupAsync, getByResourceGroupAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById

getById, getByIdAsync, getByIdAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating

define

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById

deleteById, deleteByIdAsync, deleteByIdAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

deleteByResourceGroup, deleteByResourceGroupAsync, deleteByResourceGroupAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation

create, create, createAsync, createAsync, createAsync, createAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsBatchDeletion

deleteByIds, deleteByIds, deleteByIdsAsync, deleteByIdsAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Method Detail

sizes

VirtualMachineSizes sizes()

Returns:

available virtual machine sizes

deallocate

void deallocate(String groupName,
                String name)

Shuts down the virtual machine and releases the compute resources.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

deallocateAsync

rx.Completable deallocateAsync(String groupName,
                               String name)

Shuts down the virtual machine and releases the compute resources asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

deallocateAsync

ServiceFuture<Void> deallocateAsync(String groupName,
                                    String name,
                                    ServiceCallback<Void> callback)

Shuts down the virtual machine and releases the compute resources asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

generalize

void generalize(String groupName,
                String name)

Generalizes the virtual machine.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

generalizeAsync

rx.Completable generalizeAsync(String groupName,
                               String name)

Generalizes the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

generalizeAsync

ServiceFuture<Void> generalizeAsync(String groupName,
                                    String name,
                                    ServiceCallback<Void> callback)

Generalizes the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

powerOff

void powerOff(String groupName,
              String name)

Powers off (stops) a virtual machine.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

powerOffAsync

rx.Completable powerOffAsync(String groupName,
                             String name)

Powers off (stops) the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

powerOffAsync

ServiceFuture<Void> powerOffAsync(String groupName,
                                  String name,
                                  ServiceCallback<Void> callback)

Powers off (stop) the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

restart

void restart(String groupName,
             String name)

Restarts a virtual machine.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

restartAsync

rx.Completable restartAsync(String groupName,
                            String name)

Restarts the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

restartAsync

ServiceFuture<Void> restartAsync(String groupName,
                                 String name,
                                 ServiceCallback<Void> callback)

Restarts the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

start

void start(String groupName,
           String name)

Starts a virtual machine.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

startAsync

rx.Completable startAsync(String groupName,
                          String name)

Starts the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

startAsync

ServiceFuture<Void> startAsync(String groupName,
                               String name,
                               ServiceCallback<Void> callback)

Starts the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

redeploy

void redeploy(String groupName,
              String name)

Redeploys a virtual machine.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

redeployAsync

rx.Completable redeployAsync(String groupName,
                             String name)

Redeploys the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

redeployAsync

ServiceFuture<Void> redeployAsync(String groupName,
                                  String name,
                                  ServiceCallback<Void> callback)

Redeploys the virtual machine asynchronously.

Parameters:

groupName - the name of the resource group the virtual machine is in

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

capture

String capture(String groupName,
               String name,
               String containerName,
               String vhdPrefix,
               boolean overwriteVhd)

Captures the virtual machine by copying virtual hard disks of the VM and returns template as a JSON string that can be used to create similar VMs.

Parameters:

groupName - the resource group name

name - the virtual machine name

containerName - destination container name to store the captured VHD

vhdPrefix - the prefix for the VHD holding captured image

overwriteVhd - whether to overwrites destination VHD if it exists

Returns:

the template as JSON string

captureAsync

rx.Observable<String> captureAsync(String groupName,
                                   String name,
                                   String containerName,
                                   String vhdPrefix,
                                   boolean overwriteVhd)

Captures the virtual machine by copying virtual hard disks of the VM asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

containerName - destination container name to store the captured VHD

vhdPrefix - the prefix for the VHD holding captured image

overwriteVhd - whether to overwrites destination VHD if it exists

Returns:

a representation of the deferred computation of this call

captureAsync

ServiceFuture<String> captureAsync(String groupName,
                                   String name,
                                   String containerName,
                                   String vhdPrefix,
                                   boolean overwriteVhd,
                                   ServiceCallback<String> callback)

Captures the virtual machine by copying virtual hard disks of the VM asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

containerName - destination container name to store the captured VHD

vhdPrefix - the prefix for the VHD holding captured image

overwriteVhd - whether to overwrites destination VHD if it exists

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

migrateToManaged

void migrateToManaged(String groupName,
                      String name)

Migrates the virtual machine with unmanaged disks to use managed disks.

Parameters:

groupName - the resource group name

name - the virtual machine name

migrateToManagedAsync

rx.Completable migrateToManagedAsync(String groupName,
                                     String name)

Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

Returns:

a representation of the deferred computation of this call

migrateToManagedAsync

ServiceFuture<Void> migrateToManagedAsync(String groupName,
                                          String name,
                                          ServiceCallback<Void> callback)

Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

runPowerShellScript

RunCommandResult runPowerShellScript(String groupName,
                                     String name,
                                     List<String> scriptLines,
                                     List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine.

Parameters:

groupName - the resource group name

name - the virtual machine name

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

result of PowerShell script execution

runPowerShellScriptAsync

rx.Observable<RunCommandResult> runPowerShellScriptAsync(String groupName,
                                                         String name,
                                                         List<String> scriptLines,
                                                         List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runShellScript

RunCommandResult runShellScript(String groupName,
                                String name,
                                List<String> scriptLines,
                                List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine.

Parameters:

groupName - the resource group name

name - the virtual machine name

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

result of shell script execution

runShellScriptAsync

rx.Observable<RunCommandResult> runShellScriptAsync(String groupName,
                                                    String name,
                                                    List<String> scriptLines,
                                                    List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runCommand

RunCommandResult runCommand(String groupName,
                            String name,
                            RunCommandInput inputCommand)

Run commands in a virtual machine.

Parameters:

groupName - the resource group name

name - the virtual machine name

inputCommand - command input

Returns:

result of execution

runCommandAsync

rx.Observable<RunCommandResult> runCommandAsync(String groupName,
                                                String name,
                                                RunCommandInput inputCommand)

Run commands in a virtual machine asynchronously.

Parameters:

groupName - the resource group name

name - the virtual machine name

inputCommand - command input

Returns:

handle to the asynchronous execution