All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.resourcemanager.devcenter.models.DevBoxDefinitions Maven / Gradle / Ivy

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.devcenter.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 DevBoxDefinitions.
 */
public interface DevBoxDefinitions {
    /**
     * List Dev Box definitions for a devcenter.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @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 results of the Dev Box definition list operation as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByDevCenter(String resourceGroupName, String devCenterName);

    /**
     * List Dev Box definitions for a devcenter.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @param top The maximum number of resources to return from the operation. Example: '$top=10'.
     * @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 results of the Dev Box definition list operation as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByDevCenter(String resourceGroupName, String devCenterName, Integer top,
        Context context);

    /**
     * Gets a Dev Box definition.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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 Dev Box definition along with {@link Response}.
     */
    Response getWithResponse(String resourceGroupName, String devCenterName,
        String devBoxDefinitionName, Context context);

    /**
     * Gets a Dev Box definition.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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 Dev Box definition.
     */
    DevBoxDefinition get(String resourceGroupName, String devCenterName, String devBoxDefinitionName);

    /**
     * Deletes a Dev Box definition.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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.
     */
    void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName);

    /**
     * Deletes a Dev Box definition.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param devCenterName The name of the devcenter.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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.
     */
    void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName, Context context);

    /**
     * List Dev Box definitions configured for a project.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param projectName The name of the project.
     * @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 results of the Dev Box definition list operation as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByProject(String resourceGroupName, String projectName);

    /**
     * List Dev Box definitions configured for a project.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param projectName The name of the project.
     * @param top The maximum number of resources to return from the operation. Example: '$top=10'.
     * @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 results of the Dev Box definition list operation as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByProject(String resourceGroupName, String projectName, Integer top,
        Context context);

    /**
     * Gets a Dev Box definition configured for a project.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param projectName The name of the project.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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 Dev Box definition configured for a project along with {@link Response}.
     */
    Response getByProjectWithResponse(String resourceGroupName, String projectName,
        String devBoxDefinitionName, Context context);

    /**
     * Gets a Dev Box definition configured for a project.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param projectName The name of the project.
     * @param devBoxDefinitionName The name of the Dev Box definition.
     * @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 Dev Box definition configured for a project.
     */
    DevBoxDefinition getByProject(String resourceGroupName, String projectName, String devBoxDefinitionName);

    /**
     * Gets a Dev Box definition.
     * 
     * @param id the resource ID.
     * @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 Dev Box definition along with {@link Response}.
     */
    DevBoxDefinition getById(String id);

    /**
     * Gets a Dev Box definition.
     * 
     * @param id the resource ID.
     * @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 Dev Box definition along with {@link Response}.
     */
    Response getByIdWithResponse(String id, Context context);

    /**
     * Deletes a Dev Box definition.
     * 
     * @param id the resource ID.
     * @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.
     */
    void deleteById(String id);

    /**
     * Deletes a Dev Box definition.
     * 
     * @param id the resource ID.
     * @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.
     */
    void deleteByIdWithResponse(String id, Context context);

    /**
     * Begins definition for a new DevBoxDefinition resource.
     * 
     * @param name resource name.
     * @return the first stage of the new DevBoxDefinition definition.
     */
    DevBoxDefinition.DefinitionStages.Blank define(String name);
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy