Share via

Dev Boxes - Get Operation

  • Reference
Service:
Dev Center
API Version:
2024-02-01

Gets an operation on a Dev Box.

GET {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}?api-version=2024-02-01

URI Parameters

Name In Required Type Description
devBoxName
 path True

string

Display name for the Dev Box.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
endpoint
 path True

string

uri

The DevCenter-specific URI to operate on.
operationId
 path True

string

uuid

Unique identifier for the Dev Box operation.

Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$
projectName
 path True

string

Name of the project.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
userId
 path True

string

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK DevBoxOperation:

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://devcenter.azure.com/.default

Examples

Gets an operation on a Dev Box.

Sample request

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680?api-version=2024-02-01

Sample response

Status code:
200 
{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680",
  "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680",
  "status": "Succeeded",
  "kind": "Start",
  "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93",
  "startTime": "2022-09-06T16:58:51.7229492+00:00",
  "endTime": "2022-09-06T16:59:51.7229492+00:00"
}

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DevBoxOperationKind

The type of Dev Box operation.
DevBoxRepairOperation

Information about a start operation on a Dev Box.
DevBoxRepairOperationResult

Information about the result of a repair operation on a Dev Box.
DevBoxRepairOutcome

The action taken during a repair operation.
DevBoxRestartOperation

Information about a restart operation on a Dev Box.
DevBoxStartOperation

Information about a start operation on a Dev Box.
DevBoxStopOperation

Information about a stop operation on a Dev Box.
OperationState

The operation status.

Azure.Core.Foundations.Error

Object

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

DevBoxOperationKind

Enumeration

The type of Dev Box operation.

Value Description
Repair

The operation represents a Dev Box repair.
Restart

The operation represents a Dev Box restart.
Start

The operation represents a Dev Box start.
Stop

The operation represents a Dev Box stop.

DevBoxRepairOperation

Object

Information about a start operation on a Dev Box.

Name Type Description
createdByObjectId

string

The object ID of the actor which initiated the operation.
endTime

string

The time the operation finished, in RFC3339 format.
error

Azure.Core.Foundations.Error

Provisioning or operation error details. Populated only for error states.
kind string:

Repair

The kind of operation that occurred.
operationId

string

Unique identifier for the Dev Box operation.
result

DevBoxRepairOperationResult

The result of the repair operation.
startTime

string

he time the operation started, in RFC3339 format.
status

OperationState

The operation status.
uri

string

The unique URI for the Dev Box operation.

DevBoxRepairOperationResult

Object

Information about the result of a repair operation on a Dev Box.

Name Type Description
code

string

The result code associated with the repair operation.
message

string

The result message associated with the repair operation.
repairOutcome

DevBoxRepairOutcome

The outcome of the repair operation.

DevBoxRepairOutcome

Enumeration

The action taken during a repair operation.

Value Description
FixApplied

A fix for an issue was automatically applied to the Dev Box.
IssuesDetected

One or more issues was detected on the Dev Box, but they could not be fixed automatically.
NoIssuesDetected

The service did not identify any issues on the Dev Box.

DevBoxRestartOperation

Object

Information about a restart operation on a Dev Box.

Name Type Description
createdByObjectId

string

The object ID of the actor which initiated the operation.
endTime

string

The time the operation finished, in RFC3339 format.
error

Azure.Core.Foundations.Error

Provisioning or operation error details. Populated only for error states.
kind string:

Restart

The kind of operation that occurred.
operationId

string

Unique identifier for the Dev Box operation.
startTime

string

he time the operation started, in RFC3339 format.
status

OperationState

The operation status.
uri

string

The unique URI for the Dev Box operation.

DevBoxStartOperation

Object

Information about a start operation on a Dev Box.

Name Type Description
createdByObjectId

string

The object ID of the actor which initiated the operation.
endTime

string

The time the operation finished, in RFC3339 format.
error

Azure.Core.Foundations.Error

Provisioning or operation error details. Populated only for error states.
kind string:

Start

The kind of operation that occurred.
operationId

string

Unique identifier for the Dev Box operation.
startTime

string

he time the operation started, in RFC3339 format.
status

OperationState

The operation status.
uri

string

The unique URI for the Dev Box operation.

DevBoxStopOperation

Object

Information about a stop operation on a Dev Box.

Name Type Description
createdByObjectId

string

The object ID of the actor which initiated the operation.
endTime

string

The time the operation finished, in RFC3339 format.
error

Azure.Core.Foundations.Error

Provisioning or operation error details. Populated only for error states.
kind string:

Stop

The kind of operation that occurred.
operationId

string

Unique identifier for the Dev Box operation.
startTime

string

he time the operation started, in RFC3339 format.
status

OperationState

The operation status.
uri

string

The unique URI for the Dev Box operation.

OperationState

Enumeration

The operation status.

Value Description
Canceled

The operation has been canceled by the user.
Failed

The operation has failed.
NotStarted

The operation has not started.
Running

The operation is in progress.
Succeeded

The operation has completed successfully.