Dev Boxes - Get Customization Group

Reference

Service:: Dev Center

API Version:: 2025-02-01

Gets a customization group.

GET {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
customizationGroupName	path	True	string	Name of the customization group. 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	CustomizationGroup	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

CustomizationGroup

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 a customization group.

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "name": "Provisioning",
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning",
  "tasks": [
    {
      "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb",
      "name": "catalogName/choco",
      "displayName": "Install VS Code",
      "status": "Succeeded",
      "parameters": {
        "packageName": "vscode",
        "packageVersion": "1.0.0"
      },
      "startTime": "2021-08-05T18:00:00.000Z",
      "endTime": "2021-08-05T18:00:00.000Z",
      "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb"
    },
    {
      "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4",
      "name": "catalogName/write-to-file",
      "status": "Running",
      "startTime": "2021-08-05T18:00:00.000Z",
      "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4"
    }
  ],
  "status": "Running",
  "startTime": "2021-08-05T18:00:00.000Z"
}

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.
CustomizationGroup	Represents a list of tasks to apply to a Dev Box.
CustomizationGroupStatus	Status of a customization group.
CustomizationTask	A customization task to run on a Dev Box.
CustomizationTaskExecutionAccount	What account to run the task as.
CustomizationTaskStatus	Status of a customization task.

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.

CustomizationGroup

Object

Represents a list of tasks to apply to a Dev Box.

Name	Type	Description
endTime	string	End time of the customization group, in RFC3339 format.
name	string	Name of the customization group.
startTime	string	Start time of the customization group, in RFC3339 format.
status	CustomizationGroupStatus	Status of the customization group.
tasks	CustomizationTask[]	Tasks to apply. Note by default tasks are excluded from the response when listing customization groups. To include them, use the `include=tasks` query parameter.
uri	string	The unique URI of the customization group.

CustomizationGroupStatus

Enumeration

Status of a customization group.

Value	Description
Failed	At least one task in the customization group failed.
NotStarted	The customization group has not yet started.
Running	The customization group is currently executing.
Succeeded	All tasks in the customization group successfully executed.
ValidationFailed	At least one task in the customization group failed validation.

CustomizationTask

Object

A customization task to run on a Dev Box.

Name	Type	Description
displayName	string	Display name to help differentiate multiple instances of the same task.
endTime	string	End time of the task, in RFC3339 format.
id	string	ID of the task instance.
logUri	string	The unique URI for retrieving the task logs.
name	string	Name of the task.
parameters	object	Parameters for the task.
runAs	CustomizationTaskExecutionAccount	What account to run the task as.
startTime	string	Start time of the task, in RFC3339 format.
status	CustomizationTaskStatus	Status of the task.
timeoutInSeconds	integer	Timeout, in seconds. Overrides any timeout provided on the task definition.

CustomizationTaskExecutionAccount

Enumeration

What account to run the task as.

Value	Description
System	The SYSTEM account.
User	The account of the signed in user.

CustomizationTaskStatus

Enumeration

Status of a customization task.

Value	Description
Failed	The task failed to execute.
FailedValidation	The task reference is not valid.
NotStarted	The task has not yet started.
Running	The task is currently executing.
Skipped	he task was skipped.
Succeeded	The task successfully executed.
TimedOut	The task timed out.
WaitingForUserInputUac	The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/)
WaitingForUserSession	The task is awaiting the user to connect to the Dev Box to execute.

Share via

Dev Boxes - Get Customization Group

URI Parameters

Responses

Security

OAuth2Auth

Scopes

Examples

Gets a customization group.

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CustomizationGroup

CustomizationGroupStatus

CustomizationTask

CustomizationTaskExecutionAccount

CustomizationTaskStatus

Additional resources