Share via

VirtualMachineScaleSetVMs Interface

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

Implements

SupportsListing<VirtualMachineScaleSetVM>

public interface VirtualMachineScaleSetVMs
extends SupportsListing<VirtualMachineScaleSetVM>

Entry point to virtual machine scale set instance management API.

Method Summary

Modifier and Type Method and Description
abstract void deallocateInstances(Collection<String> instanceIds)

Shuts down the virtual machine instances and releases the associated compute resources.
abstract Mono<Void> deallocateInstancesAsync(Collection<String> instanceIds)

Shuts down the virtual machine instances and releases the associated compute resources.
abstract void deleteInstances(String[] instanceIds)

Deletes the specified virtual machine instances from the scale set.
abstract void deleteInstances(Collection<String> instanceIds, boolean forceDeletion)

Deletes the specified virtual machine instances from the scale set.
abstract Mono<Void> deleteInstancesAsync(String[] instanceIds)

Deletes the specified virtual machine instances from the scale set.
abstract Mono<Void> deleteInstancesAsync(Collection<String> instanceIds)

Deletes the specified virtual machine instances from the scale set.
abstract Mono<Void> deleteInstancesAsync(Collection<String> instanceIds, boolean forceDeletion)

Deletes the specified virtual machine instances from the scale set.
abstract VirtualMachineScaleSetVM getInstance(String instanceId)

Get the specified virtual machine instance from the scale set.
abstract Mono<VirtualMachineScaleSetVM> getInstanceAsync(String instanceId)

Get the specified virtual machine instance from the scale set.
abstract PagedIterable<VirtualMachineScaleSetVM> list(String filter, VirtualMachineScaleSetVMExpandType expand)

Lists all the resources of the specified type in the currently selected subscription.
abstract PagedFlux<VirtualMachineScaleSetVM> listAsync(String filter, VirtualMachineScaleSetVMExpandType expand)

Lists all the resources of the specified type in the currently selected subscription.
abstract void powerOffInstances(Collection<String> instanceIds, boolean skipShutdown)

Stops the virtual machine instances.
abstract Mono<Void> powerOffInstancesAsync(Collection<String> instanceIds, boolean skipShutdown)

Stops the virtual machine instances.
abstract void redeployInstances(Collection<String> instanceIds)

Shuts down the virtual machine instances, move them to new node, and powers them back on.
abstract Mono<Void> redeployInstancesAsync(Collection<String> instanceIds)

Shuts down the virtual machine instances, move them to new node, and powers them back on.
abstract void restartInstances(Collection<String> instanceIds)

Restarts the virtual machine instances.
abstract Mono<Void> restartInstancesAsync(Collection<String> instanceIds)

Restarts the virtual machine instances.
abstract void simulateEviction(String instanceId)

Simulates the eviction of the specified spot virtual machine in the scale set.
abstract Mono<Void> simulateEvictionAsync(String instanceId)

Simulates the eviction of the specified spot virtual machine in the scale set asynchronously.
abstract void startInstances(Collection<String> instanceIds)

Starts the virtual machine instances.
abstract Mono<Void> startInstancesAsync(Collection<String> instanceIds)

Starts the virtual machine instances.
abstract void updateInstances(String[] instanceIds)

Updates the specified virtual machine instances from the scale set.
abstract Mono<Void> updateInstancesAsync(String[] instanceIds)

Updates the specified virtual machine instances from the scale set.
abstract Mono<Void> updateInstancesAsync(Collection<String> instanceIds)

Updates the specified virtual machine instances from the scale set.

Method Details

deallocateInstances

public abstract void deallocateInstances(Collection instanceIds)

Shuts down the virtual machine instances and releases the associated compute resources.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

deallocateInstancesAsync

public abstract Mono deallocateInstancesAsync(Collection instanceIds)

Shuts down the virtual machine instances and releases the associated compute resources.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

Returns:

a representation of the deferred computation of this call.

deleteInstances

public abstract void deleteInstances(String[] instanceIds)

Deletes the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be deleted

deleteInstances

public abstract void deleteInstances(Collection instanceIds, boolean forceDeletion)

Deletes the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be deleted
forceDeletion - force delete without graceful shutdown

deleteInstancesAsync

public abstract Mono deleteInstancesAsync(String[] instanceIds)

Deletes the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be deleted

Returns:

a representation of the deferred computation of this call.

deleteInstancesAsync

public abstract Mono deleteInstancesAsync(Collection instanceIds)

Deletes the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be deleted

Returns:

a representation of the deferred computation of this call.

deleteInstancesAsync

public abstract Mono deleteInstancesAsync(Collection instanceIds, boolean forceDeletion)

Deletes the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be deleted
forceDeletion - force delete without graceful shutdown

Returns:

a representation of the deferred computation of this call.

getInstance

public abstract VirtualMachineScaleSetVM getInstance(String instanceId)

Get the specified virtual machine instance from the scale set.

Parameters:

instanceId - instance ID of the virtual machine scale set instance to be fetched.

Returns:

the virtual machine scale set instance.

getInstanceAsync

public abstract Mono getInstanceAsync(String instanceId)

Get the specified virtual machine instance from the scale set.

Parameters:

instanceId - instance ID of the virtual machine scale set instance to be fetched.

Returns:

the virtual machine scale set instance.

list

public abstract PagedIterable list(String filter, VirtualMachineScaleSetVMExpandType expand)

Lists all the resources of the specified type in the currently selected subscription.

Parameters:

filter - The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'.
expand - The expand expression to apply to the operation. Allowed values are 'instanceView'.

Returns:

A PagedIterable<T> of resources

listAsync

public abstract PagedFlux listAsync(String filter, VirtualMachineScaleSetVMExpandType expand)

Lists all the resources of the specified type in the currently selected subscription.

Parameters:

filter - The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'.
expand - The expand expression to apply to the operation. Allowed values are 'instanceView'.

Returns:

A PagedFlux<T> of resources

powerOffInstances

public abstract void powerOffInstances(Collection instanceIds, boolean skipShutdown)

Stops the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances
skipShutdown - power off without graceful shutdown

powerOffInstancesAsync

public abstract Mono powerOffInstancesAsync(Collection instanceIds, boolean skipShutdown)

Stops the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances
skipShutdown - power off without graceful shutdown

Returns:

a representation of the deferred computation of this call.

redeployInstances

public abstract void redeployInstances(Collection instanceIds)

Shuts down the virtual machine instances, move them to new node, and powers them back on.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

redeployInstancesAsync

public abstract Mono redeployInstancesAsync(Collection instanceIds)

Shuts down the virtual machine instances, move them to new node, and powers them back on.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

Returns:

a representation of the deferred computation of this call.

restartInstances

public abstract void restartInstances(Collection instanceIds)

Restarts the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

restartInstancesAsync

public abstract Mono restartInstancesAsync(Collection instanceIds)

Restarts the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

Returns:

a representation of the deferred computation of this call.

simulateEviction

public abstract void simulateEviction(String instanceId)

Simulates the eviction of the specified spot virtual machine in the scale set. The eviction will occur with 30 minutes after calling this API.

Parameters:

instanceId - The instance ID of the virtual machine.

simulateEvictionAsync

public abstract Mono simulateEvictionAsync(String instanceId)

Simulates the eviction of the specified spot virtual machine in the scale set asynchronously. The eviction will occur with 30 minutes after calling this API.

Parameters:

instanceId - The instance ID of the virtual machine.

Returns:

a representation of the deferred computation of this call

startInstances

public abstract void startInstances(Collection instanceIds)

Starts the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

startInstancesAsync

public abstract Mono startInstancesAsync(Collection instanceIds)

Starts the virtual machine instances.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances

Returns:

a representation of the deferred computation of this call.

updateInstances

public abstract void updateInstances(String[] instanceIds)

Updates the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be updated

updateInstancesAsync

public abstract Mono updateInstancesAsync(String[] instanceIds)

Updates the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be updated

Returns:

a representation of the deferred computation of this call.

updateInstancesAsync

public abstract Mono updateInstancesAsync(Collection instanceIds)

Updates the specified virtual machine instances from the scale set.

Parameters:

instanceIds - instance IDs of the virtual machine scale set instances to be updated

Returns:

a representation of the deferred computation of this call.

Applies to