Dev Boxes - Start Dev Box

Service:

Dev Center

API Version:

2024-02-01

Starts a Dev Box.

POST {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start?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.
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
202 Accepted	OperationStatus	The request has been accepted for processing, but processing has not yet completed. Headers Operation-Location: string
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

Starts a Dev Box.

Sample request

HTTP

POST https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/MyDevBox:start?api-version=2024-02-01

Sample response

Status code:

202

Location: https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0
Operation-Location: https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0

{
  "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0",
  "name": "786a823c-8037-48ab-89b8-8599901e67d0",
  "status": "Running",
  "startTime": "2023-02-01T12:43:54.122Z"
}

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.
OperationState	The operation status.
OperationStatus	The current status of an async operation.

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.

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.

OperationStatus

Object

The current status of an async operation.

Name	Type	Description
endTime	string	The end time of the operation, in RFC3339 format.
error	Azure.Core.Foundations.Error	Operation Error message.
id	string	Fully qualified ID for the operation status.
name	string	The operation id name.
percentComplete	number	Percent of the operation that is complete.
properties		Custom operation properties, populated only for a successful operation.
resourceId	string	The id of the resource.
startTime	string	The start time of the operation, in RFC3339 format.
status	OperationState	Provisioning state of the resource.