DevBoxesClient Class
- java.
lang. Object - com.
azure. developer. devcenter. DevBoxesClient
- com.
public final class DevBoxesClient
Initializes a new instance of the synchronous DevBoxesClient type.
Method Summary
Methods inherited from java.lang.Object
Method Details
beginCreateDevBox
public 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<T,U> for polling of a Dev Box.
beginCreateDevBox
public SyncPoller<BinaryData,BinaryData> beginCreateDevBox(String projectName, String userId, String devBoxName, BinaryData body, 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<T,U> for polling of a Dev Box.
beginDeleteDevBox
public 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<T,U> for polling of the current status of an async operation.
beginDeleteDevBox
public SyncPoller<BinaryData,Void> beginDeleteDevBox(String projectName, String userId, String devBoxName, 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<T,U> for polling of the current status of an async operation.
beginRestartDevBox
public 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<T,U> for polling of the current status of an async operation.
beginRestartDevBox
public SyncPoller<BinaryData,BinaryData> beginRestartDevBox(String projectName, String userId, String devBoxName, 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<T,U> for polling of the current status of an async operation.
beginStartDevBox
public 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<T,U> for polling of the current status of an async operation.
beginStartDevBox
public SyncPoller<BinaryData,BinaryData> beginStartDevBox(String projectName, String userId, String devBoxName, 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<T,U> for polling of the current status of an async operation.
beginStopDevBox
public 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<T,U> for polling of the current status of an async operation.
beginStopDevBox
public 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<T,U> for polling of the current status of an async operation.
beginStopDevBox
public SyncPoller<BinaryData,BinaryData> beginStopDevBox(String projectName, String userId, String devBoxName, RequestOptions requestOptions)
Stops a Dev Box.
Query Parameters
| --------- | ------- | -------- | -------------------------------------------- |
| Name | Type | Required | Description |
| hibernate | Boolean | No | Optional parameter to hibernate the dev box. |
You can add these to a request with RequestOptions#addQueryParam
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<T,U> for polling of the current status of an async operation.
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.
delayActionWithResponse
public Response<BinaryData> delayActionWithResponse(String projectName, String userId, String devBoxName, String actionName, OffsetDateTime delayUntil, 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<T>.
delayAllActions
public 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<T>.
delayAllActions
public PagedIterable<BinaryData> delayAllActions(String projectName, String userId, String devBoxName, OffsetDateTime delayUntil, 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<T>.
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.
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.
getDevBoxActionWithResponse
public Response<BinaryData> getDevBoxActionWithResponse(String projectName, String userId, String devBoxName, String actionName, 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<T>.
getDevBoxWithResponse
public Response<BinaryData> getDevBoxWithResponse(String projectName, String userId, String devBoxName, 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<T>.
getPool
public DevBoxPool getPool(String projectName, String poolName)
Gets a pool.
Parameters:
projectName
- Name of the project.
poolName
- Pool name.
Returns:
a pool.
getPoolWithResponse
public Response<BinaryData> getPoolWithResponse(String projectName, String poolName, 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<T>.
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.
getRemoteConnectionWithResponse
public Response<BinaryData> getRemoteConnectionWithResponse(String projectName, String userId, String devBoxName, 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<T>.
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.
getScheduleWithResponse
public Response<BinaryData> getScheduleWithResponse(String projectName, String poolName, String scheduleName, 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<T>.
listAllDevBoxes
public 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<T>.
listAllDevBoxes
public PagedIterable<BinaryData> listAllDevBoxes(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<T>.
listAllDevBoxesByUser
public 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<T>.
listAllDevBoxesByUser
public PagedIterable<BinaryData> listAllDevBoxesByUser(String userId, 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<T>.
listDevBoxActions
public 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<T>.
listDevBoxActions
public PagedIterable<BinaryData> listDevBoxActions(String projectName, String userId, String devBoxName, 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<T>.
listDevBoxes
public 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<T>.
listDevBoxes
public PagedIterable<BinaryData> listDevBoxes(String projectName, String userId, 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<T>.
listPools
public 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<T>.
listPools
public PagedIterable<BinaryData> listPools(String projectName, 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<T>.
listSchedules
public 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<T>.
listSchedules
public PagedIterable<BinaryData> listSchedules(String projectName, String poolName, 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<T>.
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.
skipActionWithResponse
public Response<Void> skipActionWithResponse(String projectName, String userId, String devBoxName, String actionName, 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<T>.
