Package com.azure.developer.devcenter

Class DevCenterClient

java.lang.Object
com.azure.developer.devcenter.DevCenterClient
public final class DevCenterClient extends Object
Initializes a new instance of the synchronous DevCenterClient type.

  • Method Details

    • getDevBoxesClient

      public DevBoxesClient getDevBoxesClient()
      Initializes a new instance of DevBoxesClient from DevCenterClient.
      Returns:
      Dev Boxes Client

    • getDeploymentEnvironmentsClient

      public DeploymentEnvironmentsClient getDeploymentEnvironmentsClient()
      Initializes a new instance of DeploymentEnvironmentsClient from DevCenterClient.
      Returns:
      Deployment Environments Client

    • listProjects

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listProjects(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all projects.

      Response Body Schema

       
 {
     name: String (Required)
     description: String (Optional)
     maxDevBoxesPerUser: Integer (Optional)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Project items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getProjectWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getProjectWithResponse(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets a project.

      Response Body Schema

       
 {
     name: String (Required)
     description: String (Optional)
     maxDevBoxesPerUser: Integer (Optional)
 }
      Parameters:
      projectName - Name of the project.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a project along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listProjects

      public com.azure.core.http.rest.PagedIterable<DevCenterProject> listProjects()
      Lists all projects.
      Returns:
      paged collection of Project items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getProject

      public DevCenterProject getProject(String projectName)
      Gets a project.
      Parameters:
      projectName - Name of the project.
      Returns:
      a project.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.