Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.management.compute;

import com.microsoft.azure.CloudException;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.compute.implementation.ComputeManager;
import com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetsInner;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsBatchDeletion;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.rest.ServiceCallback;
import com.microsoft.rest.ServiceFuture;
import rx.Completable;
import rx.Observable;

import java.io.IOException;
import java.util.Collection;
import java.util.List;

 Entry point to virtual machine scale set management API.
/**
 *  Entry point to virtual machine scale set management API.
 */
@Fluent
public interface VirtualMachineScaleSets extends
        SupportsListing<VirtualMachineScaleSet>,
        SupportsListingByResourceGroup<VirtualMachineScaleSet>,
        SupportsGettingByResourceGroup<VirtualMachineScaleSet>,
        SupportsGettingById<VirtualMachineScaleSet>,
        SupportsCreating<VirtualMachineScaleSet.DefinitionStages.Blank>,
        SupportsDeletingById,
        SupportsDeletingByResourceGroup,
        SupportsBatchCreation<VirtualMachineScaleSet>,
        SupportsBatchDeletion,
        HasManager<ComputeManager>,
        HasInner<VirtualMachineScaleSetsInner> {
    
Shuts down the virtual machines in the scale set and releases the compute resources.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
Throws:
CloudException – thrown for an invalid response from the service.
IOException – exception thrown from serialization/deserialization
InterruptedException – exception thrown when the operation is interrupted/**
     * Shuts down the virtual machines in the scale set and releases the compute resources.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @throws CloudException thrown for an invalid response from the service.
     * @throws IOException exception thrown from serialization/deserialization
     * @throws InterruptedException exception thrown when the operation is interrupted
     */
    void deallocate(String groupName, String name) throws CloudException, IOException, InterruptedException;

    
Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.
Params:
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/**
     * Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     *
     * @return a representation of the deferred computation of this call
     */
    Completable deallocateAsync(String groupName, String name);

    
Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Shuts down the virtual machines in the scale set and releases the compute resources asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deallocateAsync(String groupName, String name, ServiceCallback<Void> callback);

    
Powers off (stops) the virtual machines in the scale set.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
Throws:
CloudException – thrown for an invalid response from the service.
IOException – exception thrown from serialization/deserialization
InterruptedException – exception thrown when the operation is interrupted/**
     * Powers off (stops) the virtual machines in the scale set.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @throws CloudException thrown for an invalid response from the service.
     * @throws IOException exception thrown from serialization/deserialization
     * @throws InterruptedException exception thrown when the operation is interrupted
     */
    void powerOff(String groupName, String name) throws CloudException, IOException, InterruptedException;

    
Powers off (stops) the virtual machines in the scale set asynchronously.
Params:
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/**
     * Powers off (stops) the virtual machines in the scale set asynchronously.
     * @param groupName the name of the resource group the virtual machine in the scale set is in
     * @param name the name of the virtual machine scale set
     *
     * @return a representation of the deferred computation of this call
     */
    Completable powerOffAsync(String groupName, String name);

    
Powers off (stop) the virtual machines in the scale set asynchronously.
Params:
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
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Powers off (stop) the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine in the scale set is in
     * @param name the name of the virtual machine scale set
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> powerOffAsync(String groupName, String name, ServiceCallback<Void> callback);

    
Restarts the virtual machines in the scale set.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
Throws:
CloudException – thrown for an invalid response from the service.
IOException – exception thrown from serialization/deserialization
InterruptedException – exception thrown when the operation is interrupted/**
     * Restarts the virtual machines in the scale set.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @throws CloudException thrown for an invalid response from the service.
     * @throws IOException exception thrown from serialization/deserialization
     * @throws InterruptedException exception thrown when the operation is interrupted
     */
    void restart(String groupName, String name) throws CloudException, IOException, InterruptedException;

    
Restarts the virtual machines in the scale set asynchronously.
Params:
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/**
     * Restarts the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the virtual machine scale set name
     * @return a representation of the deferred computation of this call
     */
    Completable restartAsync(String groupName, String name);

    
Restarts the virtual machines in the scale set asynchronously.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the virtual machine scale set name
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Restarts the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the virtual machine scale set name
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> restartAsync(String groupName, String name, ServiceCallback<Void> callback);

    
Starts the virtual machines in the scale set.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
Throws:
CloudException – thrown for an invalid response from the service.
IOException – exception thrown from serialization/deserialization
InterruptedException – exception thrown when the operation is interrupted/**
     * Starts the virtual machines in the scale set.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @throws CloudException thrown for an invalid response from the service.
     * @throws IOException exception thrown from serialization/deserialization
     * @throws InterruptedException exception thrown when the operation is interrupted
     */
    void start(String groupName, String name) throws CloudException, IOException, InterruptedException;

    
Starts the virtual machines in the scale set asynchronously.
Params:
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/**
     * Starts the virtual machines in the scale set asynchronously.
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     *
     * @return a representation of the deferred computation of this call
     */
    Completable startAsync(String groupName, String name);

    
Starts the virtual machines in the scale set asynchronously.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Starts the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> startAsync(String groupName, String name, ServiceCallback<Void> callback);

    
Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
Throws:
CloudException – thrown for an invalid response from the service.
IOException – exception thrown from serialization/deserialization
InterruptedException – exception thrown when the operation is interrupted/**
     * Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @throws CloudException thrown for an invalid response from the service.
     * @throws IOException exception thrown from serialization/deserialization
     * @throws InterruptedException exception thrown when the operation is interrupted
     */
    void reimage(String groupName, String name) throws CloudException, IOException, InterruptedException;

    
Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
Params:
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/**
     * Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     *
     * @return a representation of the deferred computation of this call
     */
    Completable reimageAsync(String groupName, String name);

    
Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
Params:
groupName – the name of the resource group the virtual machine scale set is in
name – the name of the virtual machine scale set
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
     *
     * @param groupName the name of the resource group the virtual machine scale set is in
     * @param name the name of the virtual machine scale set
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> reimageAsync(String groupName, String name, ServiceCallback<Void> callback);

    
Run PowerShell script in a virtual machine instance in a scale set.
Params:
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/**
     * Run PowerShell script in a virtual machine instance in a scale set.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param scriptLines PowerShell script lines
     * @param scriptParameters script parameters
     * @return result of PowerShell script execution
     */
    RunCommandResult runPowerShellScriptInVMInstance(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters);

    
Run PowerShell in a virtual machine instance in a scale set asynchronously.
Params:
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/**
     * Run PowerShell in a virtual machine instance in a scale set asynchronously.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param scriptLines PowerShell script lines
     * @param scriptParameters script parameters
     * @return handle to the asynchronous execution
     */
    Observable<RunCommandResult> runPowerShellScriptInVMInstanceAsync(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters);

    
Run shell script in a virtual machine instance in a scale set.
Params:
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/**
     * Run shell script in a virtual machine instance in a scale set.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param scriptLines shell script lines
     * @param scriptParameters script parameters
     * @return result of shell script execution
     */
    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 asynchronously.
Params:
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/**
     * Run shell script in a virtual machine instance in a scale set asynchronously.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param scriptLines shell script lines
     * @param scriptParameters script parameters
     * @return handle to the asynchronous execution
     */
    Observable<RunCommandResult> runShellScriptInVMInstanceAsync(String groupName, String scaleSetName, String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters);

    
Run commands in a virtual machine instance in a scale set.
Params:
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/**
     * Run commands in a virtual machine instance in a scale set.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param inputCommand command input
     * @return result of execution
     */
    RunCommandResult runCommandInVMInstance(String groupName, String scaleSetName, String vmId, RunCommandInput inputCommand);

    
Run commands in a virtual machine instance in a scale set asynchronously.
Params:
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/**
     * Run commands in a virtual machine instance in a scale set asynchronously.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param vmId the virtual machine instance id
     * @param inputCommand command input
     * @return handle to the asynchronous execution
     */
    Observable<RunCommandResult> runCommandVMInstanceAsync(String groupName, String scaleSetName, String vmId, RunCommandInput inputCommand);

    
Delete virtual machine instances.
Params:
groupName – the resource group name
scaleSetName – the virtual machine scale set name
instanceIds – instance IDs
forceDeletion – force delete without graceful shutdown/**
     * Delete virtual machine instances.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param instanceIds instance IDs
     * @param forceDeletion force delete without graceful shutdown
     */
    void deleteInstances(String groupName, String scaleSetName, Collection<String> instanceIds, boolean forceDeletion);

    
Delete virtual machine instances.
Params:
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/**
     * Delete virtual machine instances.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param instanceIds instance IDs
     * @param forceDeletion force delete without graceful shutdown
     * @return a representation of the deferred computation of this call
     */
    Completable deleteInstancesAsync(String groupName, String scaleSetName, Collection<String> instanceIds, boolean forceDeletion);

    
Delete virtual machine instances.
Params:
groupName – the resource group name
scaleSetName – the virtual machine scale set name
instanceIds – instance IDs
forceDeletion – force delete without graceful shutdown
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Delete virtual machine instances.
     *
     * @param groupName the resource group name
     * @param scaleSetName the virtual machine scale set name
     * @param instanceIds instance IDs
     * @param forceDeletion force delete without graceful shutdown
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deleteInstancesAsync(String groupName, String scaleSetName, Collection<String> instanceIds, boolean forceDeletion, ServiceCallback<Void> callback);

    
Force delete a resource from Azure, identifying it by its resource ID.
Params:
id – the resource ID of the resource to delete
forceDeletion – force delete without graceful shutdown/**
     * Force delete a resource from Azure, identifying it by its resource ID.
     *
     * @param id the resource ID of the resource to delete
     * @param forceDeletion force delete without graceful shutdown
     */
    void deleteById(String id, boolean forceDeletion);

    
Asynchronously force delete a resource from Azure, identifying it by its resource ID.
Params:
id – the resource ID of the resource to delete
forceDeletion – force delete without graceful shutdown
callback – the callback on success or failure
Returns:
a handle to cancel the request/**
     * Asynchronously force delete a resource from Azure, identifying it by its resource ID.
     *
     * @param id the resource ID of the resource to delete
     * @param forceDeletion force delete without graceful shutdown
     * @param callback the callback on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deleteByIdAsync(String id, boolean forceDeletion, ServiceCallback<Void> callback);

    
Asynchronously force delete a resource from Azure, identifying it by its resource ID.
Params:
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/**
     * Asynchronously force delete a resource from Azure, identifying it by its resource ID.
     *
     * @param id the resource ID of the resource to delete
     * @param forceDeletion force delete without graceful shutdown
     * @return a representation of the deferred computation of this call
     */
    Completable deleteByIdAsync(String id, boolean forceDeletion);

    
Force delete a resource from Azure, identifying it by its name and its resource group.
Params:
resourceGroupName – the resource group the resource is part of
name – the name of the resource
forceDeletion – force delete without graceful shutdown/**
     * Force delete a resource from Azure, identifying it by its name and its resource group.
     *
     * @param resourceGroupName the resource group the resource is part of
     * @param name the name of the resource
     * @param forceDeletion force delete without graceful shutdown
     */
    void deleteByResourceGroup(String resourceGroupName, String name, boolean forceDeletion);

    
Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.
Params:
resourceGroupName – the resource group the resource is part of
name – the name of the resource
forceDeletion – force delete without graceful shutdown
callback – the callback to call on success or failure
Returns:
a handle to cancel the request/**
     * Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.
     *
     * @param resourceGroupName the resource group the resource is part of
     * @param name the name of the resource
     * @param forceDeletion force delete without graceful shutdown
     * @param callback the callback to call on success or failure
     * @return a handle to cancel the request
     */
    ServiceFuture<Void> deleteByResourceGroupAsync(String resourceGroupName, String name, boolean forceDeletion, ServiceCallback<Void> callback);

    
Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.
Params:
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/**
     * Asynchronously force delete a resource from Azure, identifying it by its name and its resource group.
     *
     * @param resourceGroupName the resource group the resource is part of
     * @param name the name of the resource
     * @param forceDeletion force delete without graceful shutdown
     * @return a representation of the deferred computation of this call
     */
    Completable deleteByResourceGroupAsync(String resourceGroupName, String name, boolean forceDeletion);
}