Package com.azure.developer.devcenter

Class DevBoxesAsyncClient

java.lang.Object

com.azure.developer.devcenter.DevBoxesAsyncClient

public final class DevBoxesAsyncClient
extends Object

Initializes a new instance of the asynchronous DevCenterClient type.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.PollerFlux<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 updates a Dev Box.
com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,Void>	beginDeleteDevBox(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)	Deletes a Dev Box.
com.azure.core.util.polling.PollerFlux<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.
com.azure.core.util.polling.PollerFlux<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.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getDevBoxByUserWithResponse(String projectName, String userId, String devBoxName, com.azure.core.http.rest.RequestOptions requestOptions)	Gets a Dev Box.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getPoolWithResponse(String poolName, String projectName, com.azure.core.http.rest.RequestOptions requestOptions)	Gets a pool.
Mono<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.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getScheduleByPoolWithResponse(String projectName, String poolName, String scheduleName, com.azure.core.http.rest.RequestOptions requestOptions)	Gets a schedule.
com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>	listDevBoxesByUser(String projectName, String userId, com.azure.core.http.rest.RequestOptions requestOptions)	Lists Dev Boxes in the project for a particular user.
com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>	listPools(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)	Lists available pools.
com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>	listSchedulesByPool(String projectName, String poolName, com.azure.core.http.rest.RequestOptions requestOptions)	Lists available schedules for a pool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listPools

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listPools(String projectName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Lists available pools.

Query Parameters

Query Parameters

Name	Type	Required	Description
top	Integer	No	The maximum number of resources to return from the operation. Example: 'top=10'.
filter	String	No	An OData filter clause to apply to the operation.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     name: String (Optional)
     location: String (Optional)
     osType: String(Windows) (Optional)
     hardwareProfile (Optional): {
         skuName: String (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)
     }
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
 

Parameters:

projectName - The DevCenter Project upon which to execute operations.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Pool list result as paginated response with PagedFlux.

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 Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getPoolWithResponse(String poolName,
 String projectName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Gets a pool.

Response Body Schema

 {
     name: String (Optional)
     location: String (Optional)
     osType: String(Windows) (Optional)
     hardwareProfile (Optional): {
         skuName: String (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)
     }
     localAdministrator: String(Enabled/Disabled) (Optional)
 }
 

Parameters:

poolName - The name of a pool of Dev Boxes.

projectName - The DevCenter Project upon which to execute operations.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a pool along with Response on successful completion of Mono.

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.

listSchedulesByPool

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listSchedulesByPool(String projectName,
 String poolName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Lists available schedules for a pool.

Query Parameters

Query Parameters

Name	Type	Required	Description
top	Integer	No	The maximum number of resources to return from the operation. Example: 'top=10'.
filter	String	No	An OData filter clause to apply to the operation.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     name: String (Optional)
     type: String(StopDevBox) (Optional)
     frequency: String(Daily) (Optional)
     time: String (Optional)
     timeZone: String (Optional)
 }
 

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:

the Schedule list result as paginated response with PagedFlux.

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.

getScheduleByPoolWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getScheduleByPoolWithResponse(String projectName,
 String poolName,
 String scheduleName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Gets a schedule.

Response Body Schema

 {
     name: String (Optional)
     type: String(StopDevBox) (Optional)
     frequency: String(Daily) (Optional)
     time: String (Optional)
     timeZone: String (Optional)
 }
 

Parameters:

projectName - The DevCenter Project upon which to execute operations.

poolName - The name of a pool of Dev Boxes.

scheduleName - The name of a schedule.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a schedule along with Response on successful completion of Mono.

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.

listDevBoxesByUser

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDevBoxesByUser(String projectName,
 String userId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Lists Dev Boxes in the project for a particular user.

Query Parameters

Query Parameters

Name	Type	Required	Description
filter	String	No	An OData filter clause to apply to the operation.
top	Integer	No	The maximum number of resources to return from the operation. Example: 'top=10'.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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:

the Dev Box list result as paginated response with PagedFlux.

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.

getDevBoxByUserWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDevBoxByUserWithResponse(String projectName,
 String userId,
 String devBoxName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Gets a Dev Box.

Response Body Schema

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a Dev Box along with Response on successful completion of Mono.

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.PollerFlux<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 updates a Dev Box.

Request Body Schema

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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 (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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 a environment.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the PollerFlux for polling of a DevBox 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.PollerFlux<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

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the PollerFlux for polling of a DevBox 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.

beginStartDevBox

public com.azure.core.util.polling.PollerFlux<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

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the PollerFlux for polling of a DevBox 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.

beginStopDevBox

public com.azure.core.util.polling.PollerFlux<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.

Response Body Schema

 {
     name: String (Optional)
     projectName: String (Optional)
     poolName: String (Required)
     provisioningState: String (Optional)
     actionState: String (Optional)
     powerState: String(Unknown/Deallocated/PoweredOff/Running/Hibernated) (Optional)
     uniqueId: String (Optional)
     errorDetails (Optional): {
         code: String (Optional)
         message: String (Optional)
     }
     location: String (Optional)
     osType: String(Windows) (Optional)
     user: String (Optional)
     hardwareProfile (Optional): {
         skuName: String (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.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the PollerFlux for polling of a DevBox 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.

getRemoteConnectionWithResponse

public Mono<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 on successful completion of Mono.

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.