DevBoxDefinitions Interface

Package:
com.azure.resourcemanager.devcenter.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-devcenter:1.0.0

public interface DevBoxDefinitions

Resource collection API of DevBoxDefinitions.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new DevBoxDefinition resource.
abstract void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName)

Deletes a Dev Box definition.
abstract void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName, Context context)

Deletes a Dev Box definition.
abstract void deleteById(String id)

Deletes a Dev Box definition.
abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Dev Box definition.
abstract DevBoxDefinition get(String resourceGroupName, String devCenterName, String devBoxDefinitionName)

Gets a Dev Box definition.
abstract DevBoxDefinition getById(String id)

Gets a Dev Box definition.
abstract Response<DevBoxDefinition> getByIdWithResponse(String id, Context context)

Gets a Dev Box definition.
abstract DevBoxDefinition getByProject(String resourceGroupName, String projectName, String devBoxDefinitionName)

Gets a Dev Box definition configured for a project.
abstract Response<DevBoxDefinition> getByProjectWithResponse(String resourceGroupName, String projectName, String devBoxDefinitionName, Context context)

Gets a Dev Box definition configured for a project.
abstract Response<DevBoxDefinition> getWithResponse(String resourceGroupName, String devCenterName, String devBoxDefinitionName, Context context)

Gets a Dev Box definition.
abstract PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName)

List Dev Box definitions for a devcenter.
abstract PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, Context context)

List Dev Box definitions for a devcenter.
abstract PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName)

List Dev Box definitions configured for a project.
abstract PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName, Integer top, Context context)

List Dev Box definitions configured for a project.

Method Details

define

public abstract DevBoxDefinition.DefinitionStages.Blank define(String name)

Begins definition for a new DevBoxDefinition resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DevBoxDefinition definition.

delete

public abstract void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName)

Deletes a Dev Box definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
devBoxDefinitionName - The name of the Dev Box definition.

delete

public abstract void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName, Context context)

Deletes a Dev Box definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
devBoxDefinitionName - The name of the Dev Box definition.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a Dev Box definition.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Dev Box definition.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract DevBoxDefinition get(String resourceGroupName, String devCenterName, String devBoxDefinitionName)

Gets a Dev Box definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
devBoxDefinitionName - The name of the Dev Box definition.

Returns:

a Dev Box definition.

getById

public abstract DevBoxDefinition getById(String id)

Gets a Dev Box definition.

Parameters:

id - the resource ID.

Returns:

a Dev Box definition along with Response<T>.

getByIdWithResponse

public abstract Response<DevBoxDefinition> getByIdWithResponse(String id, Context context)

Gets a Dev Box definition.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a Dev Box definition along with Response<T>.

getByProject

public abstract DevBoxDefinition getByProject(String resourceGroupName, String projectName, String devBoxDefinitionName)

Gets a Dev Box definition configured for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
devBoxDefinitionName - The name of the Dev Box definition.

Returns:

a Dev Box definition configured for a project.

getByProjectWithResponse

public abstract Response<DevBoxDefinition> getByProjectWithResponse(String resourceGroupName, String projectName, String devBoxDefinitionName, Context context)

Gets a Dev Box definition configured for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
devBoxDefinitionName - The name of the Dev Box definition.
context - The context to associate with this operation.

Returns:

a Dev Box definition configured for a project along with Response<T>.

getWithResponse

public abstract Response<DevBoxDefinition> getWithResponse(String resourceGroupName, String devCenterName, String devBoxDefinitionName, Context context)

Gets a Dev Box definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
devBoxDefinitionName - The name of the Dev Box definition.
context - The context to associate with this operation.

Returns:

a Dev Box definition along with Response<T>.

listByDevCenter

public abstract PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName)

List Dev Box definitions for a devcenter.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.

Returns:

results of the Dev Box definition list operation as paginated response with PagedIterable<T>.

listByDevCenter

public abstract PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, Context context)

List Dev Box definitions for a devcenter.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
context - The context to associate with this operation.

Returns:

results of the Dev Box definition list operation as paginated response with PagedIterable<T>.

listByProject

public abstract PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName)

List Dev Box definitions configured for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.

Returns:

results of the Dev Box definition list operation as paginated response with PagedIterable<T>.

listByProject

public abstract PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName, Integer top, Context context)

List Dev Box definitions configured for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
context - The context to associate with this operation.

Returns:

results of the Dev Box definition list operation as paginated response with PagedIterable<T>.

Applies to