com.azure.developer.devcenter.DevCenterAsyncClient

public final class DevCenterAsyncClient extends Object

Initializes a new instance of the asynchronous DevCenterClient type.

Method Summary

Modifier and Type

Method

Description

Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>

getProjectWithResponse(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)

Gets a project.

com.azure.core.http.rest.PagedFlux<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.

com.azure.core.http.rest.PagedFlux<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.

com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>

listProjects(com.azure.core.http.rest.RequestOptions requestOptions)

Lists all projects.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listProjects

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listProjects(com.azure.core.http.rest.RequestOptions requestOptions)

Lists all projects.

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)
     description: String (Optional)
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: results of the project list operation 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.

getProjectWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getProjectWithResponse(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
Gets a project.
Response Body Schema
```
 {
     name: String (Optional)
     description: String (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:

a project 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.

listAllDevBoxes

public com.azure.core.http.rest.PagedFlux<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.

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:: 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.

listAllDevBoxesByUser

public com.azure.core.http.rest.PagedFlux<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.

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:: 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.

Class DevCenterAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

listProjects

getProjectWithResponse

listAllDevBoxes

listAllDevBoxesByUser