Dev Boxes - Get Action

Service:

Dev Center

API Version:

2024-02-01

Gets an action.

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

URI Parameters

Name	In	Required	Type	Description
actionName	path	True	string	The name of the action. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
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
200 OK	DevBoxAction	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 action.

Sample request

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/myDevBox/actions/schedule-default?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/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default",
  "name": "schedule-default",
  "actionType": "Stop",
  "sourceId": "/projects/myProject/pools/myPool/schedules/default",
  "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default",
  "sourceType": "Schedule",
  "next": {
    "scheduledTime": "2022-09-30T17:00:00Z"
  }
}

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.
DevBoxAction	An action which will take place on a Dev Box.
DevBoxActionSourceType	The type of the resource which triggered the action.
DevBoxActionType	The type of action which will take place on a Dev Box.
DevBoxNextAction	Details about the next run of an action.

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.

DevBoxAction

Object

An action which will take place on a Dev Box.

Name	Type	Description
actionType	DevBoxActionType	The action that will be taken.
name	string	The name of the action.
next	DevBoxNextAction	Details about the next run of this action.
sourceId	string	The id of the resource which triggered this action.
sourceType	DevBoxActionSourceType	The type of the resource which triggered this action.
sourceUri	string	The URI of the resource which triggered this action.
suspendedUntil	string	The earliest time that the action could occur (UTC), in RFC3339 format.
uri	string	The unique URI for the Dev Box action.

DevBoxActionSourceType

Enumeration

The type of the resource which triggered the action.

Value	Description
Pool	The action was triggered by a Dev Box pool.
Schedule	The action was triggered by a Dev Box schedule.

DevBoxActionType

Enumeration

The type of action which will take place on a Dev Box.

Value	Description
Stop	The action will stop the Dev Box.

DevBoxNextAction

Object

Details about the next run of an action.

Name	Type	Description
scheduledTime	string	The time the action will be triggered (UTC), in RFC3339 format.