Package com.azure.resourcemanager.compute.models

Interface VirtualMachineScaleSets

All Superinterfaces:

HasManager<ComputeManager>, SupportsBatchCreation<VirtualMachineScaleSet>, SupportsBatchDeletion, SupportsCreating<VirtualMachineScaleSet.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsGettingById<VirtualMachineScaleSet>, SupportsGettingByResourceGroup<VirtualMachineScaleSet>, SupportsListing<VirtualMachineScaleSet>, SupportsListingByResourceGroup<VirtualMachineScaleSet>

public interface VirtualMachineScaleSets
extends SupportsListing<VirtualMachineScaleSet>, SupportsListingByResourceGroup<VirtualMachineScaleSet>, SupportsGettingByResourceGroup<VirtualMachineScaleSet>, SupportsGettingById<VirtualMachineScaleSet>, SupportsCreating<VirtualMachineScaleSet.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsBatchCreation<VirtualMachineScaleSet>, SupportsBatchDeletion, HasManager<ComputeManager>

Entry point to virtual machine scale set management API.

Method Summary

Modifier and Type	Method	Description
void	deallocate(String groupName, String name)	Shuts down the virtual machines in the scale set and releases the compute resources.
Mono<Void>	deallocateAsync(String groupName, String name)	Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.
void	deleteById(String id, boolean forceDeletion)	Force delete a resource from Azure, identifying it by its resource ID.
Mono<Void>	deleteByIdAsync(String id, boolean forceDeletion)	Asynchronously force delete a resource from Azure, identifying it by its resource ID.
void	deleteByResourceGroup(String resourceGroupName, String name, boolean forceDeletion)	Force delete a resource from Azure, identifying it by its name and its resource group.
Mono<Void>	deleteByResourceGroupAsync(String resourceGroupName, String name, boolean forceDeletion)	Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.
void	deleteInstances(String groupName, String scaleSetName, Collection<String> instanceIds, boolean forceDeletion)	Delete virtual machine instances.
Mono<Void>	deleteInstancesAsync(String groupName, String scaleSetName, Collection<String> instanceIds, boolean forceDeletion)	Delete virtual machine instances.
void	powerOff(String groupName, String name)	Powers off (stops) the virtual machines in the scale set.
Mono<Void>	powerOffAsync(String groupName, String name)	Powers off (stops) the virtual machines in the scale set asynchronously.
void	reimage(String groupName, String name)	Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
Mono<Void>	reimageAsync(String groupName, String name)	Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
void	restart(String groupName, String name)	Restarts the virtual machines in the scale set.
Mono<Void>	restartAsync(String groupName, String name)	Restarts the virtual machines in the scale set asynchronously.
RunCommandResult	runCommandInVMInstance(String groupName, String scaleSetName, String vmId, RunCommandInput inputCommand)	Run commands in a virtual machine instance in a scale set.
Mono<RunCommandResult>	runCommandVMInstanceAsync(String groupName, String scaleSetName, String vmId, RunCommandInput inputCommand)	Run commands in a virtual machine instance in a scale set asynchronously.
RunCommandResult	runPowerShellScriptInVMInstance(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)	Run PowerShell script in a virtual machine instance in a scale set.
Mono<RunCommandResult>	runPowerShellScriptInVMInstanceAsync(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)	Run PowerShell in a virtual machine instance in a scale set asynchronously.
RunCommandResult	runShellScriptInVMInstance(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)	Run shell script in a virtual machine instance in a scale set.
Mono<RunCommandResult>	runShellScriptInVMInstanceAsync(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)	Run shell script in a virtual machine instance in a scale set asynchronously.
void	start(String groupName, String name)	Starts the virtual machines in the scale set.
Mono<Void>	startAsync(String groupName, String name)	Starts the virtual machines in the scale set asynchronously.

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

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsBatchCreation

create, create, createAsync, createAsync

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

deleteByIds, deleteByIds, deleteByIdsAsync, deleteByIdsAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating

define

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById

deleteById, deleteByIdAsync

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

deleteByResourceGroup, deleteByResourceGroupAsync

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

getById, getByIdAsync

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

getByResourceGroup, getByResourceGroupAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing

list, listAsync

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

listByResourceGroup, listByResourceGroupAsync

Method Detail

deallocate

void deallocate(String groupName,
                String name)
         throws com.azure.core.management.exception.ManagementException,
                IOException,
                InterruptedException

Shuts down the virtual machines in the scale set and releases the compute resources.

Parameters:

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

name - the name of the virtual machine scale set

Throws:

com.azure.core.management.exception.ManagementException - thrown for an invalid response from the service.

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

deallocateAsync

Mono<Void> deallocateAsync(String groupName,
                           String name)

Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.

Parameters:

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

name - the name of the virtual machine scale set

Returns:

a representation of the deferred computation of this call

powerOff

void powerOff(String groupName,
              String name)
       throws com.azure.core.management.exception.ManagementException,
              IOException,
              InterruptedException

Powers off (stops) the virtual machines in the scale set.

Parameters:

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

name - the name of the virtual machine scale set

Throws:

com.azure.core.management.exception.ManagementException - thrown for an invalid response from the service.

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

powerOffAsync

Mono<Void> powerOffAsync(String groupName,
                         String name)

Powers off (stops) the virtual machines in the scale set asynchronously.

Parameters:

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

name - the name of the virtual machine scale set

Returns:

a representation of the deferred computation of this call

restart

void restart(String groupName,
             String name)
      throws com.azure.core.management.exception.ManagementException,
             IOException,
             InterruptedException

Restarts the virtual machines in the scale set.

Parameters:

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

name - the name of the virtual machine scale set

Throws:

com.azure.core.management.exception.ManagementException - thrown for an invalid response from the service.

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

restartAsync

Mono<Void> restartAsync(String groupName,
                        String name)

Restarts the virtual machines in the scale set asynchronously.

Parameters:

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

name - the virtual machine scale set name

Returns:

a representation of the deferred computation of this call

start

void start(String groupName,
           String name)
    throws com.azure.core.management.exception.ManagementException,
           IOException,
           InterruptedException

Starts the virtual machines in the scale set.

Parameters:

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

name - the name of the virtual machine scale set

Throws:

com.azure.core.management.exception.ManagementException - thrown for an invalid response from the service.

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

startAsync

Mono<Void> startAsync(String groupName,
                      String name)

Starts the virtual machines in the scale set asynchronously.

Parameters:

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

name - the name of the virtual machine scale set

Returns:

a representation of the deferred computation of this call

reimage

void reimage(String groupName,
             String name)
      throws com.azure.core.management.exception.ManagementException,
             IOException,
             InterruptedException

Re-images (updates the version of the installed operating system) the virtual machines in the scale set.

Parameters:

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

name - the name of the virtual machine scale set

Throws:

com.azure.core.management.exception.ManagementException - thrown for an invalid response from the service.

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

reimageAsync

Mono<Void> reimageAsync(String groupName,
                        String name)

Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.

Parameters:

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

name - the name of the virtual machine scale set

Returns:

a representation of the deferred computation of this call

runPowerShellScriptInVMInstance

RunCommandResult runPowerShellScriptInVMInstance(String groupName,
                                                 String scaleSetName,
                                                 String vmId,
                                                 List<String> scriptLines,
                                                 List<RunCommandInputParameter> scriptParameters)

Run PowerShell script in a virtual machine instance in a scale set.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

result of PowerShell script execution

runPowerShellScriptInVMInstanceAsync

Mono<RunCommandResult> runPowerShellScriptInVMInstanceAsync(String groupName,
                                                            String scaleSetName,
                                                            String vmId,
                                                            List<String> scriptLines,
                                                            List<RunCommandInputParameter> scriptParameters)

Run PowerShell in a virtual machine instance in a scale set asynchronously.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runShellScriptInVMInstance

RunCommandResult runShellScriptInVMInstance(String groupName,
                                            String scaleSetName,
                                            String vmId,
                                            List<String> scriptLines,
                                            List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine instance in a scale set.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

result of shell script execution

runShellScriptInVMInstanceAsync

Mono<RunCommandResult> runShellScriptInVMInstanceAsync(String groupName,
                                                       String scaleSetName,
                                                       String vmId,
                                                       List<String> scriptLines,
                                                       List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine instance in a scale set asynchronously.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runCommandInVMInstance

RunCommandResult runCommandInVMInstance(String groupName,
                                        String scaleSetName,
                                        String vmId,
                                        RunCommandInput inputCommand)

Run commands in a virtual machine instance in a scale set.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

inputCommand - command input

Returns:

result of execution

runCommandVMInstanceAsync

Mono<RunCommandResult> runCommandVMInstanceAsync(String groupName,
                                                 String scaleSetName,
                                                 String vmId,
                                                 RunCommandInput inputCommand)

Run commands in a virtual machine instance in a scale set asynchronously.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

vmId - the virtual machine instance id

inputCommand - command input

Returns:

handle to the asynchronous execution

deleteInstances

void deleteInstances(String groupName,
                     String scaleSetName,
                     Collection<String> instanceIds,
                     boolean forceDeletion)

Delete virtual machine instances.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

instanceIds - instance IDs

forceDeletion - force delete without graceful shutdown

deleteInstancesAsync

Mono<Void> deleteInstancesAsync(String groupName,
                                String scaleSetName,
                                Collection<String> instanceIds,
                                boolean forceDeletion)

Delete virtual machine instances.

Parameters:

groupName - the resource group name

scaleSetName - the virtual machine scale set name

instanceIds - instance IDs

forceDeletion - force delete without graceful shutdown

Returns:

a representation of the deferred computation of this call

deleteById

void deleteById(String id,
                boolean forceDeletion)

Force delete a resource from Azure, identifying it by its resource ID.

Parameters:

id - the resource ID of the resource to delete

forceDeletion - force delete without graceful shutdown

deleteByIdAsync

Mono<Void> deleteByIdAsync(String id,
                           boolean forceDeletion)

Asynchronously force delete a resource from Azure, identifying it by its resource ID.

Parameters:

id - the resource ID of the resource to delete

forceDeletion - force delete without graceful shutdown

Returns:

a representation of the deferred computation of this call

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String name,
                           boolean forceDeletion)

Force delete a resource from Azure, identifying it by its name and its resource group.

Parameters:

resourceGroupName - the resource group the resource is part of

name - the name of the resource

forceDeletion - force delete without graceful shutdown

deleteByResourceGroupAsync

Mono<Void> deleteByResourceGroupAsync(String resourceGroupName,
                                      String name,
                                      boolean forceDeletion)

Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.

Parameters:

resourceGroupName - the resource group the resource is part of

name - the name of the resource

forceDeletion - force delete without graceful shutdown

Returns:

a representation of the deferred computation of this call