com.azure.resourcemanager.compute.models.VirtualMachineScaleSetVMs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-compute Show documentation
This package contains Microsoft Azure Compute Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
There is a newer version: 2.46.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.resourcemanager.compute.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.http.rest.PagedFlux;
import com.azure.core.http.rest.PagedIterable;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing;
import java.util.Collection;
import reactor.core.publisher.Mono;

/** Entry point to virtual machine scale set instance management API. */
@Fluent
public interface VirtualMachineScaleSetVMs extends SupportsListing {
    /**
     * Deletes the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be deleted
     * @return a representation of the deferred computation of this call.
     */
    Mono deleteInstancesAsync(Collection instanceIds);

    /**
     * Deletes the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be deleted
     * @return a representation of the deferred computation of this call.
     */
    Mono deleteInstancesAsync(String... instanceIds);

    /**
     * Deletes the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be deleted
     */
    void deleteInstances(String... instanceIds);

    /**
     * Deletes the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be deleted
     * @param forceDeletion force delete without graceful shutdown
     * @return a representation of the deferred computation of this call.
     */
    Mono deleteInstancesAsync(Collection instanceIds, boolean forceDeletion);

    /**
     * Deletes the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be deleted
     * @param forceDeletion force delete without graceful shutdown
     */
    void deleteInstances(Collection instanceIds, boolean forceDeletion);

    /**
     * Get the specified virtual machine instance from the scale set.
     *
     * @param instanceId instance ID of the virtual machine scale set instance to be fetched.
     * @return the virtual machine scale set instance.
     */
    VirtualMachineScaleSetVM getInstance(String instanceId);

    /**
     * Get the specified virtual machine instance from the scale set.
     *
     * @param instanceId instance ID of the virtual machine scale set instance to be fetched.
     * @return the virtual machine scale set instance.
     */
    Mono getInstanceAsync(String instanceId);

    /**
     * Updates the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be updated
     * @return a representation of the deferred computation of this call.
     */
    Mono updateInstancesAsync(Collection instanceIds);

    /**
     * Updates the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be updated
     * @return a representation of the deferred computation of this call.
     */
    Mono updateInstancesAsync(String... instanceIds);

    /**
     * Updates the specified virtual machine instances from the scale set.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances to be updated
     */
    void updateInstances(String... instanceIds);

    /**
     * Shuts down the virtual machine instances and releases the associated compute resources.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     */
    void deallocateInstances(Collection instanceIds);

    /**
     * Shuts down the virtual machine instances and releases the associated compute resources.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @return a representation of the deferred computation of this call.
     */
    Mono deallocateInstancesAsync(Collection instanceIds);

    /**
     * Stops the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @param skipShutdown power off without graceful shutdown
     */
    void powerOffInstances(Collection instanceIds, boolean skipShutdown);

    /**
     * Stops the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @param skipShutdown power off without graceful shutdown
     * @return a representation of the deferred computation of this call.
     */
    Mono powerOffInstancesAsync(Collection instanceIds, boolean skipShutdown);

    /**
     * Starts the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     */
    void startInstances(Collection instanceIds);

    /**
     * Starts the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @return a representation of the deferred computation of this call.
     */
    Mono startInstancesAsync(Collection instanceIds);

    /**
     * Restarts the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     */
    void restartInstances(Collection instanceIds);

    /**
     * Restarts the virtual machine instances.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @return a representation of the deferred computation of this call.
     */
    Mono restartInstancesAsync(Collection instanceIds);

    /**
     * Shuts down the virtual machine instances, move them to new node, and powers them back on.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     */
    void redeployInstances(Collection instanceIds);

    /**
     * Shuts down the virtual machine instances, move them to new node, and powers them back on.
     *
     * @param instanceIds instance IDs of the virtual machine scale set instances
     * @return a representation of the deferred computation of this call.
     */
    Mono redeployInstancesAsync(Collection instanceIds);

//    /**
//     * Updates the version of the installed operating system in the virtual machine instances.
//     *
//     * @param instanceIds instance IDs of the virtual machine scale set instances
//     */
//    void reimageInstances(Collection instanceIds);
//
//    /**
//     * Updates the version of the installed operating system in the virtual machine instances.
//     *
//     * @param instanceIds instance IDs of the virtual machine scale set instances
//     * @return a representation of the deferred computation of this call.
//     */
//    Mono reimageInstancesAsync(Collection instanceIds);

    /**
     * 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.
     *
     * @param instanceId The instance ID of the virtual machine.
     * @return a representation of the deferred computation of this call
     */
    Mono simulateEvictionAsync(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.
     *
     * @param instanceId The instance ID of the virtual machine.
     */
    void simulateEviction(String instanceId);

    /**
     * Lists all the resources of the specified type in the currently selected subscription.
     *
     * @param 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'.
     * @param expand The expand expression to apply to the operation. Allowed values are 'instanceView'.
     * @return A {@link PagedIterable} of resources
     */
    PagedIterable list(String filter, VirtualMachineScaleSetVMExpandType expand);

    /**
     * Lists all the resources of the specified type in the currently selected subscription.
     *
     * @param 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'.
     * @param expand The expand expression to apply to the operation. Allowed values are 'instanceView'.
     * @return A {@link PagedFlux} of resources
     */
    PagedFlux listAsync(String filter, VirtualMachineScaleSetVMExpandType expand);
}