com.azure.resourcemanager.desktopvirtualization.models.Desktops Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-desktopvirtualization Show documentation
This package contains Microsoft Azure SDK for DesktopVirtualization Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Package tag package-2024-04.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.desktopvirtualization.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;

/**
 * Resource collection API of Desktops.
 */
public interface Desktops {
    /**
     * Get a desktop.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @param desktopName The name of the desktop within the specified desktop group.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a desktop along with {@link Response}.
     */
    Response getWithResponse(String resourceGroupName, String applicationGroupName, String desktopName,
        Context context);

    /**
     * Get a desktop.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @param desktopName The name of the desktop within the specified desktop group.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a desktop.
     */
    Desktop get(String resourceGroupName, String applicationGroupName, String desktopName);

    /**
     * Update a desktop.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @param desktopName The name of the desktop within the specified desktop group.
     * @param desktop Object containing Desktop definitions.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return schema for Desktop properties along with {@link Response}.
     */
    Response updateWithResponse(String resourceGroupName, String applicationGroupName, String desktopName,
        DesktopPatch desktop, Context context);

    /**
     * Update a desktop.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @param desktopName The name of the desktop within the specified desktop group.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return schema for Desktop properties.
     */
    Desktop update(String resourceGroupName, String applicationGroupName, String desktopName);

    /**
     * List desktops.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return desktopList as paginated response with {@link PagedIterable}.
     */
    PagedIterable list(String resourceGroupName, String applicationGroupName);

    /**
     * List desktops.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param applicationGroupName The name of the application group.
     * @param pageSize Number of items per page.
     * @param isDescending Indicates whether the collection is descending.
     * @param initialSkip Initial number of items to skip.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return desktopList as paginated response with {@link PagedIterable}.
     */
    PagedIterable list(String resourceGroupName, String applicationGroupName, Integer pageSize,
        Boolean isDescending, Integer initialSkip, Context context);
}