Package com.azure.developer.devcenter

Class DevBoxesClient

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

  • Method Details

    • listPools

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listPools(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists available pools.

      Response Body Schema

       
 {
     name: String (Required)
     location: String (Required)
     osType: String(Windows) (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     localAdministrator: String(Enabled/Disabled) (Optional)
     stopOnDisconnect (Optional): {
         status: String(Enabled/Disabled) (Required)
         gracePeriodMinutes: Integer (Optional)
     }
     healthStatus: String(Unknown/Pending/Healthy/Warning/Unhealthy) (Required)
 }
      Parameters:
      projectName - Name of the project.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Pool 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.

    • getPoolWithResponse

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

      Response Body Schema

       
 {
     name: String (Required)
     location: String (Required)
     osType: String(Windows) (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     localAdministrator: String(Enabled/Disabled) (Optional)
     stopOnDisconnect (Optional): {
         status: String(Enabled/Disabled) (Required)
         gracePeriodMinutes: Integer (Optional)
     }
     healthStatus: String(Unknown/Pending/Healthy/Warning/Unhealthy) (Required)
 }
      Parameters:
      projectName - Name of the project.
      poolName - Pool name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a pool 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.

    • listSchedules

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listSchedules(String projectName, String poolName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all schedules within a pool that are configured by your project administrator.

      Response Body Schema

       
 {
     name: String (Required)
     type: String(StopDevBox) (Required)
     frequency: String(Daily) (Required)
     time: String (Required)
     timeZone: String (Required)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      poolName - The name of a pool of Dev Boxes.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Schedule 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.

    • getScheduleWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getScheduleWithResponse(String projectName, String poolName, String scheduleName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets a schedule.

      Response Body Schema

       
 {
     name: String (Required)
     type: String(StopDevBox) (Required)
     frequency: String(Daily) (Required)
     time: String (Required)
     timeZone: String (Required)
 }
      Parameters:
      projectName - Name of the project.
      poolName - Pool name.
      scheduleName - Display name for the Schedule.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a schedule 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.

    • listAllDevBoxes

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listAllDevBoxes(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists Dev Boxes that the caller has access to in the DevCenter.

      Response Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DevBox 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.

    • listAllDevBoxesByUser

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listAllDevBoxesByUser(String userId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists Dev Boxes in the Dev Center for a particular user.

      Response Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
      Parameters:
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DevBox 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.

    • listDevBoxes

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listDevBoxes(String projectName, String userId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists Dev Boxes in the project for a particular user.

      Response Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DevBox 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.

    • getDevBoxWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getDevBoxWithResponse(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets a Dev Box.

      Response Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a Dev Box 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.

    • beginCreateDevBox

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateDevBox(String projectName, String userId, String devBoxName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or replaces a Dev Box.

      Request Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }

      Response Body Schema

       
 {
     name: String (Required)
     projectName: String (Optional)
     poolName: String (Required)
     hibernateSupport: String(Enabled/Disabled/OsUnsupported) (Optional)
     provisioningState: String(Succeeded/Failed/Canceled/Creating/Deleting/Updating/Starting/Stopping/Provisioning/ProvisionedWithWarning/InGracePeriod/NotProvisioned) (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Running/Deallocated/PoweredOff/Hibernated) (Optional)
     uniqueId: String (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String(general_i_8c32gb256ssd_v2/general_i_8c32gb512ssd_v2/general_i_8c32gb1024ssd_v2/general_i_8c32gb2048ssd_v2/general_i_16c64gb256ssd_v2/general_i_16c64gb512ssd_v2/general_i_16c64gb1024ssd_v2/general_i_16c64gb2048ssd_v2/general_i_32c128gb512ssd_v2/general_i_32c128gb1024ssd_v2/general_i_32c128gb2048ssd_v2/general_a_8c32gb256ssd_v2/general_a_8c32gb512ssd_v2/general_a_8c32gb1024ssd_v2/general_a_8c32gb2048ssd_v2/general_a_16c64gb256ssd_v2/general_a_16c64gb512ssd_v2/general_a_16c64gb1024ssd_v2/general_a_16c64gb2048ssd_v2/general_a_32c128gb512ssd_v2/general_a_32c128gb1024ssd_v2/general_a_32c128gb2048ssd_v2) (Optional)
         vCPUs: Integer (Optional)
         memoryGB: Integer (Optional)
     }
     storageProfile (Optional): {
         osDisk (Optional): {
             diskSizeGB: Integer (Optional)
         }
     }
     imageReference (Optional): {
         name: String (Optional)
         version: String (Optional)
         operatingSystem: String (Optional)
         osBuildNumber: String (Optional)
         publishedDate: OffsetDateTime (Optional)
     }
     createdTime: OffsetDateTime (Optional)
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - The name of a Dev Box.
      body - Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of a Dev Box.
      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.

    • beginDeleteDevBox

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,Void> beginDeleteDevBox(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Dev Box.

      Response Body Schema

       
 {
     id: String (Required)
     name: String (Required)
     status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
     resourceId: String (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
     percentComplete: Double (Optional)
     properties: Object (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - The name of a Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginStartDevBox

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginStartDevBox(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Starts a Dev Box.

      Response Body Schema

       
 {
     id: String (Required)
     name: String (Required)
     status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
     resourceId: String (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
     percentComplete: Double (Optional)
     properties: Object (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginStopDevBox

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginStopDevBox(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Stops a Dev Box.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      hibernateBooleanNoOptional parameter to hibernate the dev box.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Required)
     name: String (Required)
     status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
     resourceId: String (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
     percentComplete: Double (Optional)
     properties: Object (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginRestartDevBox

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginRestartDevBox(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Restarts a Dev Box.

      Response Body Schema

       
 {
     id: String (Required)
     name: String (Required)
     status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
     resourceId: String (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
     percentComplete: Double (Optional)
     properties: Object (Optional)
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • getRemoteConnectionWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getRemoteConnectionWithResponse(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets RDP Connection info.

      Response Body Schema

       
 {
     webUrl: String (Optional)
     rdpConnectionUrl: String (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - The name of a Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      rDP Connection info 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.

    • listDevBoxActions

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listDevBoxActions(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists actions on a Dev Box.

      Response Body Schema

       
 {
     name: String (Required)
     actionType: String(Stop) (Required)
     sourceId: String (Required)
     suspendedUntil: OffsetDateTime (Optional)
     next (Optional): {
         scheduledTime: OffsetDateTime (Required)
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DevBoxAction 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.

    • getDevBoxActionWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getDevBoxActionWithResponse(String projectName, String userId, String devBoxName, String actionName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets an action.

      Response Body Schema

       
 {
     name: String (Required)
     actionType: String(Stop) (Required)
     sourceId: String (Required)
     suspendedUntil: OffsetDateTime (Optional)
     next (Optional): {
         scheduledTime: OffsetDateTime (Required)
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      an action 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.

    • skipActionWithResponse

      public com.azure.core.http.rest.Response<Void> skipActionWithResponse(String projectName, String userId, String devBoxName, String actionName, com.azure.core.http.rest.RequestOptions requestOptions)
      Skips an occurrence of an action.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the 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.

    • delayActionWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> delayActionWithResponse(String projectName, String userId, String devBoxName, String actionName, OffsetDateTime delayUntil, com.azure.core.http.rest.RequestOptions requestOptions)
      Delays the occurrence of an action.

      Response Body Schema

       
 {
     name: String (Required)
     actionType: String(Stop) (Required)
     sourceId: String (Required)
     suspendedUntil: OffsetDateTime (Optional)
     next (Optional): {
         scheduledTime: OffsetDateTime (Required)
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      delayUntil - The time to delay the Dev Box action or actions until, in RFC3339 format.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      an action which will take place on a Dev Box 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.

    • delayAllActions

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> delayAllActions(String projectName, String userId, String devBoxName, OffsetDateTime delayUntil, com.azure.core.http.rest.RequestOptions requestOptions)
      Delays all actions.

      Response Body Schema

       
 {
     name: String (Required)
     result: String(Succeeded/Failed) (Required)
     action (Optional): {
         name: String (Required)
         actionType: String(Stop) (Required)
         sourceId: String (Required)
         suspendedUntil: OffsetDateTime (Optional)
         next (Optional): {
             scheduledTime: OffsetDateTime (Required)
         }
     }
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      delayUntil - The time to delay the Dev Box action or actions until, in RFC3339 format.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DevBoxActionDelayResult 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.

    • listPools

      public com.azure.core.http.rest.PagedIterable<DevBoxPool> listPools(String projectName)
      Lists available pools.
      Parameters:
      projectName - Name of the project.
      Returns:
      paged collection of Pool items as paginated response with PagedIterable.
      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.

    • getPool

      public DevBoxPool getPool(String projectName, String poolName)
      Gets a pool.
      Parameters:
      projectName - Name of the project.
      poolName - Pool name.
      Returns:
      a pool.
      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.

    • listSchedules

      public com.azure.core.http.rest.PagedIterable<DevBoxSchedule> listSchedules(String projectName, String poolName)
      Lists all schedules within a pool that are configured by your project administrator.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      poolName - The name of a pool of Dev Boxes.
      Returns:
      paged collection of Schedule items as paginated response with PagedIterable.
      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.

    • getSchedule

      public DevBoxSchedule getSchedule(String projectName, String poolName, String scheduleName)
      Gets a schedule.
      Parameters:
      projectName - Name of the project.
      poolName - Pool name.
      scheduleName - Display name for the Schedule.
      Returns:
      a schedule.
      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.

    • listAllDevBoxes

      public com.azure.core.http.rest.PagedIterable<DevBox> listAllDevBoxes()
      Lists Dev Boxes that the caller has access to in the DevCenter.
      Returns:
      paged collection of DevBox 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.

    • listAllDevBoxesByUser

      public com.azure.core.http.rest.PagedIterable<DevBox> listAllDevBoxesByUser(String userId)
      Lists Dev Boxes in the Dev Center for a particular user.
      Parameters:
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      Returns:
      paged collection of DevBox items as paginated response with PagedIterable.
      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.

    • listDevBoxes

      public com.azure.core.http.rest.PagedIterable<DevBox> listDevBoxes(String projectName, String userId)
      Lists Dev Boxes in the project for a particular user.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      Returns:
      paged collection of DevBox items as paginated response with PagedIterable.
      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.

    • getDevBox

      public DevBox getDevBox(String projectName, String userId, String devBoxName)
      Gets a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      Returns:
      a Dev Box.
      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.

    • beginCreateDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,DevBox> beginCreateDevBox(String projectName, String userId, DevBox devBox)
      Creates or replaces a Dev Box.
      Parameters:
      projectName - The DevCenter Project upon which to execute the operation.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBox - A DevBox object that requires dev box name and pool. Setting local administrator status is optional.
      Returns:
      the SyncPoller for polling of a Dev Box.
      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.

    • beginDeleteDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginDeleteDevBox(String projectName, String userId, String devBoxName)
      Deletes a Dev Box.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - The name of a Dev Box.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginStartDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginStartDevBox(String projectName, String userId, String devBoxName)
      Starts a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginStopDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginStopDevBox(String projectName, String userId, String devBoxName, Boolean hibernate)
      Stops a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      hibernate - Optional parameter to hibernate the dev box.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginStopDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginStopDevBox(String projectName, String userId, String devBoxName)
      Stops a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • beginRestartDevBox

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginRestartDevBox(String projectName, String userId, String devBoxName)
      Restarts a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      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.

    • getRemoteConnection

      public RemoteConnection getRemoteConnection(String projectName, String userId, String devBoxName)
      Gets RDP Connection info.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - The name of a Dev Box.
      Returns:
      rDP Connection info.
      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.

    • listDevBoxActions

      public com.azure.core.http.rest.PagedIterable<DevBoxAction> listDevBoxActions(String projectName, String userId, String devBoxName)
      Lists actions on a Dev Box.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      Returns:
      paged collection of DevBoxAction items as paginated response with PagedIterable.
      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.

    • getDevBoxAction

      public DevBoxAction getDevBoxAction(String projectName, String userId, String devBoxName, String actionName)
      Gets an action.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      Returns:
      an action.
      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.

    • skipAction

      public void skipAction(String projectName, String userId, String devBoxName, String actionName)
      Skips an occurrence of an action.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      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.

    • delayAction

      public DevBoxAction delayAction(String projectName, String userId, String devBoxName, String actionName, OffsetDateTime delayUntil)
      Delays the occurrence of an action.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      actionName - The name of the action.
      delayUntil - The time to delay the Dev Box action or actions until, in RFC3339 format.
      Returns:
      an action which will take place on a Dev Box.
      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.

    • delayAllActions

      public com.azure.core.http.rest.PagedIterable<DevBoxActionDelayResult> delayAllActions(String projectName, String userId, String devBoxName, OffsetDateTime delayUntil)
      Delays all actions.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      devBoxName - Display name for the Dev Box.
      delayUntil - The time to delay the Dev Box action or actions until, in RFC3339 format.
      Returns:
      paged collection of DevBoxActionDelayResult items as paginated response with PagedIterable.
      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.