Dev Boxes - Validate Customization Tasks Action

Reference

Service:: Dev Center

API Version:: 2025-02-01

Validates a list of customization tasks.

POST {endpoint}/projects/{projectName}/customizationTasks:validateGroup?api-version=2025-02-01

URI Parameters

Name In Required Type Description

Name	In	Required	Type	Description
endpoint	path	True	string uri	The DevCenter-specific URI to operate on.
projectName	path	True	string	The DevCenter Project upon which to execute operations. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$`
api-version	query	True	string	The API version to use for this operation.

endpoint

path

True

string

uri

The DevCenter-specific URI to operate on.

projectName

path

True

string

The DevCenter Project upon which to execute operations.

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

api-version

query

True

string

The API version to use for this operation.

Request Body

Name	Type	Description
tasks	CustomizationTask[]	Tasks to apply.

Responses

Name	Type	Description
202 Accepted	CustomizationTaskListValidationOperationResult	The request has been accepted for processing, but processing has not yet completed. Headers Location: string Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

202 Accepted

CustomizationTaskListValidationOperationResult

The request has been accepted for processing, but processing has not yet completed.

Headers

Location: string
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

Validates a list of customization tasks.

Sample request

HTTP

POST https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com//projects/myProject/customizationTasks:validateGroup?api-version=2025-02-01

{
  "tasks": [
    {
      "name": "catalogName/choco",
      "parameters": {
        "packageName": "vscode",
        "packageVersion": "1.0.0"
      }
    },
    {
      "name": "catalogName/write-to-disk"
    }
  ]
}

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": "Succeeded",
  "startTime": "2023-02-01T12:43:54.122Z",
  "result": {
    "validationResult": "Succeeded"
  }
}

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.
CustomizationTask	A customization task to run on a Dev Box.
CustomizationTaskExecutionAccount	What account to run the task as.
CustomizationTaskList	Represents a list of tasks to apply to a Dev Box
CustomizationTaskListValidationError	All of the validation errors for a customization task.
CustomizationTaskListValidationOperationResult	The operation result of validating a list of customization tasks.
CustomizationTaskListValidationResult	The result of validating a list of customization tasks.
CustomizationTaskListValidationStatus	Status of validating a list of customization tasks.
CustomizationTaskStatus	Status of a customization task.
OperationState	Provisioning state of the resource.

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.

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.

CustomizationTaskList

Object

Represents a list of tasks to apply to a Dev Box

Name	Type	Description
tasks	CustomizationTask[]	Tasks to apply.

CustomizationTaskListValidationError

Object

All of the validation errors for a customization task.

Name	Type	Description
details	Azure.Core.Foundations.Error[]	List of validation errors for the task.
target	CustomizationTask	The customization task that the error is about.

CustomizationTaskListValidationOperationResult

Object

The operation result of validating a list of customization tasks.

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.
result	CustomizationTaskListValidationResult	Outcome of validation.
startTime	string	The start time of the operation, in RFC3339 format.
status	OperationState	Provisioning state of the resource.

CustomizationTaskListValidationResult

Object

The result of validating a list of customization tasks.

Name	Type	Description
errors	CustomizationTaskListValidationError[]	List of validation errors. Absent if no errors.
validationResult	CustomizationTaskListValidationStatus	Outcome of validation.

CustomizationTaskListValidationStatus

Enumeration

Status of validating a list of customization tasks.

Value	Description
Failed	Validation failed.
Succeeded	Validation succeeded.

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.

OperationState

Enumeration

Provisioning state of the resource.

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.

Share via

Dev Boxes - Validate Customization Tasks Action

URI Parameters

Request Body

Responses

Security

OAuth2Auth

Scopes

Examples

Validates a list of customization tasks.

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CustomizationTask

CustomizationTaskExecutionAccount

CustomizationTaskList

CustomizationTaskListValidationError

CustomizationTaskListValidationOperationResult

CustomizationTaskListValidationResult

CustomizationTaskListValidationStatus

CustomizationTaskStatus

OperationState

Additional resources