Package com.azure.resourcemanager.devcenter.models

Interface DevBoxDefinitions

public interface DevBoxDefinitions
Resource collection API of DevBoxDefinitions.

  • Method Details

    • listByDevCenter

      com.azure.core.http.rest.PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName)
      List Dev Box definitions for a devcenter.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      devCenterName - The name of the devcenter.
      Returns:
      results of the Dev Box definition list operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByDevCenter

      com.azure.core.http.rest.PagedIterable<DevBoxDefinition> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, com.azure.core.util.Context context)
      List Dev Box definitions for a devcenter.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      DevBoxDefinition get(String resourceGroupName, String devCenterName, String devBoxDefinitionName)
      Gets a Dev Box definition.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      devCenterName - The name of the devcenter.
      devBoxDefinitionName - The name of the Dev Box definition.
      Returns:
      a Dev Box definition.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<DevBoxDefinition> getWithResponse(String resourceGroupName, String devCenterName, String devBoxDefinitionName, com.azure.core.util.Context context)
      Gets a Dev Box definition.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName)
      Deletes a Dev Box definition.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      devCenterName - The name of the devcenter.
      devBoxDefinitionName - The name of the Dev Box definition.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String devCenterName, String devBoxDefinitionName, com.azure.core.util.Context context)
      Deletes a Dev Box definition.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      devCenterName - The name of the devcenter.
      devBoxDefinitionName - The name of the Dev Box definition.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByProject

      com.azure.core.http.rest.PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName)
      List Dev Box definitions configured for a project.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      Returns:
      results of the Dev Box definition list operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByProject

      com.azure.core.http.rest.PagedIterable<DevBoxDefinition> listByProject(String resourceGroupName, String projectName, Integer top, com.azure.core.util.Context context)
      List Dev Box definitions configured for a project.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByProject

      DevBoxDefinition getByProject(String resourceGroupName, String projectName, String devBoxDefinitionName)
      Gets a Dev Box definition configured for a project.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      projectName - The name of the project.
      devBoxDefinitionName - The name of the Dev Box definition.
      Returns:
      a Dev Box definition configured for a project.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByProjectWithResponse

      com.azure.core.http.rest.Response<DevBoxDefinition> getByProjectWithResponse(String resourceGroupName, String projectName, String devBoxDefinitionName, com.azure.core.util.Context context)
      Gets a Dev Box definition configured for a project.
      Parameters:
      resourceGroupName - Name of the resource group within the Azure subscription.
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      DevBoxDefinition getById(String id)
      Gets a Dev Box definition.
      Parameters:
      id - the resource ID.
      Returns:
      a Dev Box definition along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<DevBoxDefinition> getByIdWithResponse(String id, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Deletes a Dev Box definition.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a Dev Box definition.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      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.