VirtualMachinesClient Interface

public interface VirtualMachinesClient

An instance of this class provides access to all the operations defined in VirtualMachinesClient.

Method Summary

Modifier and Type Method and Description
abstract OperationStatusResult assignRelay(String resourceGroupName, String virtualMachineName)

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

abstract OperationStatusResult assignRelay(String resourceGroupName, String virtualMachineName, VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

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

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginAssignRelay(String resourceGroupName, String virtualMachineName)

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

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginAssignRelay(String resourceGroupName, String virtualMachineName, VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

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

abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginCreateOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters)

Create a new virtual machine or update the properties of the existing virtual machine.

abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginCreateOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new virtual machine or update the properties of the existing virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String virtualMachineName)

Delete the provided virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginPowerOff(String resourceGroupName, String virtualMachineName)

Power off the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginPowerOff(String resourceGroupName, String virtualMachineName, VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginReimage(String resourceGroupName, String virtualMachineName)

Reimage the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginReimage(String resourceGroupName, String virtualMachineName, Context context)

Reimage the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginRestart(String resourceGroupName, String virtualMachineName)

Restart the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginRestart(String resourceGroupName, String virtualMachineName, Context context)

Restart the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginStart(String resourceGroupName, String virtualMachineName)

Start the provided virtual machine.

abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginStart(String resourceGroupName, String virtualMachineName, Context context)

Start the provided virtual machine.

abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginUpdate(String resourceGroupName, String virtualMachineName)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine.

abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginUpdate(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, VirtualMachinePatchParameters virtualMachineUpdateParameters, Context context)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine.

abstract VirtualMachineInner createOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters)

Create a new virtual machine or update the properties of the existing virtual machine.

abstract VirtualMachineInner createOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new virtual machine or update the properties of the existing virtual machine.

abstract void delete(String resourceGroupName, String virtualMachineName)

Delete the provided virtual machine.

abstract void delete(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided virtual machine.

abstract VirtualMachineInner getByResourceGroup(String resourceGroupName, String virtualMachineName)

Get properties of the provided virtual machine.

abstract Response<VirtualMachineInner> getByResourceGroupWithResponse(String resourceGroupName, String virtualMachineName, Context context)

Get properties of the provided virtual machine.

abstract PagedIterable<VirtualMachineInner> list()

Get a list of virtual machines in the provided subscription.

abstract PagedIterable<VirtualMachineInner> list(Integer top, String skipToken, Context context)

Get a list of virtual machines in the provided subscription.

abstract PagedIterable<VirtualMachineInner> listByResourceGroup(String resourceGroupName)

Get a list of virtual machines in the provided resource group.

abstract PagedIterable<VirtualMachineInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

Get a list of virtual machines in the provided resource group.

abstract OperationStatusResult powerOff(String resourceGroupName, String virtualMachineName)

Power off the provided virtual machine.

abstract OperationStatusResult powerOff(String resourceGroupName, String virtualMachineName, VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the provided virtual machine.

abstract OperationStatusResult reimage(String resourceGroupName, String virtualMachineName)

Reimage the provided virtual machine.

abstract OperationStatusResult reimage(String resourceGroupName, String virtualMachineName, Context context)

Reimage the provided virtual machine.

abstract OperationStatusResult restart(String resourceGroupName, String virtualMachineName)

Restart the provided virtual machine.

abstract OperationStatusResult restart(String resourceGroupName, String virtualMachineName, Context context)

Restart the provided virtual machine.

abstract OperationStatusResult start(String resourceGroupName, String virtualMachineName)

Start the provided virtual machine.

abstract OperationStatusResult start(String resourceGroupName, String virtualMachineName, Context context)

Start the provided virtual machine.

abstract VirtualMachineInner update(String resourceGroupName, String virtualMachineName)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine.

abstract VirtualMachineInner update(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, VirtualMachinePatchParameters virtualMachineUpdateParameters, Context context)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine.

Method Details

assignRelay

public abstract OperationStatusResult assignRelay(String resourceGroupName, String virtualMachineName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the response.

assignRelay

public abstract OperationStatusResult assignRelay(String resourceGroupName, String virtualMachineName, VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineAssignRelayParameters - The request body.
context - The context to associate with this operation.

Returns:

the response.

beginAssignRelay

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginAssignRelay(String resourceGroupName, String virtualMachineName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginAssignRelay

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginAssignRelay(String resourceGroupName, String virtualMachineName, VirtualMachineAssignRelayParameters virtualMachineAssignRelayParameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineAssignRelayParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginCreateOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters)

Create a new virtual machine or update the properties of the existing virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of virtualMachine represents the on-premises Network Cloud virtual machine.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginCreateOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new virtual machine or update the properties of the existing virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of virtualMachine represents the on-premises Network Cloud virtual machine.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String virtualMachineName)

Delete the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginPowerOff

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginPowerOff(String resourceGroupName, String virtualMachineName)

Power off the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginPowerOff

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginPowerOff(String resourceGroupName, String virtualMachineName, VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachinePowerOffParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReimage

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginReimage(String resourceGroupName, String virtualMachineName)

Reimage the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReimage

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginReimage(String resourceGroupName, String virtualMachineName, Context context)

Reimage the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginRestart(String resourceGroupName, String virtualMachineName)

Restart the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginRestart(String resourceGroupName, String virtualMachineName, Context context)

Restart the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginStart(String resourceGroupName, String virtualMachineName)

Start the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<OperationStatusResult>,OperationStatusResult> beginStart(String resourceGroupName, String virtualMachineName, Context context)

Start the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginUpdate(String resourceGroupName, String virtualMachineName)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the SyncPoller<T,U> for polling of virtualMachine represents the on-premises Network Cloud virtual machine.

beginUpdate

public abstract SyncPoller<PollResult<VirtualMachineInner>,VirtualMachineInner> beginUpdate(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, VirtualMachinePatchParameters virtualMachineUpdateParameters, Context context)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
virtualMachineUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of virtualMachine represents the on-premises Network Cloud virtual machine.

createOrUpdate

public abstract VirtualMachineInner createOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters)

Create a new virtual machine or update the properties of the existing virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineParameters - The request body.

Returns:

virtualMachine represents the on-premises Network Cloud virtual machine.

createOrUpdate

public abstract VirtualMachineInner createOrUpdate(String resourceGroupName, String virtualMachineName, VirtualMachineInner virtualMachineParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new virtual machine or update the properties of the existing virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachineParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

virtualMachine represents the on-premises Network Cloud virtual machine.

delete

public abstract void delete(String resourceGroupName, String virtualMachineName)

Delete the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

delete

public abstract void delete(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

getByResourceGroup

public abstract VirtualMachineInner getByResourceGroup(String resourceGroupName, String virtualMachineName)

Get properties of the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

properties of the provided virtual machine.

getByResourceGroupWithResponse

public abstract Response<VirtualMachineInner> getByResourceGroupWithResponse(String resourceGroupName, String virtualMachineName, Context context)

Get properties of the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

properties of the provided virtual machine along with Response<T>.

list

public abstract PagedIterable<VirtualMachineInner> list()

Get a list of virtual machines in the provided subscription.

Returns:

a list of virtual machines in the provided subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<VirtualMachineInner> list(Integer top, String skipToken, Context context)

Get a list of virtual machines in the provided subscription.

Parameters:

top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of virtual machines in the provided subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VirtualMachineInner> listByResourceGroup(String resourceGroupName)

Get a list of virtual machines in the provided resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

a list of virtual machines in the provided resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VirtualMachineInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

Get a list of virtual machines in the provided resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of virtual machines in the provided resource group as paginated response with PagedIterable<T>.

powerOff

public abstract OperationStatusResult powerOff(String resourceGroupName, String virtualMachineName)

Power off the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the response.

powerOff

public abstract OperationStatusResult powerOff(String resourceGroupName, String virtualMachineName, VirtualMachinePowerOffParameters virtualMachinePowerOffParameters, Context context)

Power off the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
virtualMachinePowerOffParameters - The request body.
context - The context to associate with this operation.

Returns:

the response.

reimage

public abstract OperationStatusResult reimage(String resourceGroupName, String virtualMachineName)

Reimage the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the response.

reimage

public abstract OperationStatusResult reimage(String resourceGroupName, String virtualMachineName, Context context)

Reimage the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the response.

restart

public abstract OperationStatusResult restart(String resourceGroupName, String virtualMachineName)

Restart the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the response.

restart

public abstract OperationStatusResult restart(String resourceGroupName, String virtualMachineName, Context context)

Restart the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the response.

start

public abstract OperationStatusResult start(String resourceGroupName, String virtualMachineName)

Start the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

the response.

start

public abstract OperationStatusResult start(String resourceGroupName, String virtualMachineName, Context context)

Start the provided virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
context - The context to associate with this operation.

Returns:

the response.

update

public abstract VirtualMachineInner update(String resourceGroupName, String virtualMachineName)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.

Returns:

virtualMachine represents the on-premises Network Cloud virtual machine.

update

public abstract VirtualMachineInner update(String resourceGroupName, String virtualMachineName, String ifMatch, String ifNoneMatch, VirtualMachinePatchParameters virtualMachineUpdateParameters, Context context)

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
virtualMachineName - The name of the virtual machine.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
virtualMachineUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

virtualMachine represents the on-premises Network Cloud virtual machine.

Applies to