Dev Boxes - Get Customization Task Definitions

Service:

Dev Center

API Version:

2025-02-01

Gets a customization task.

GET {endpoint}/projects/{projectName}/catalogs/{catalogName}/customizationTasks/{taskName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
catalogName	path	True	string	Name of the catalog. 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}$
taskName	path	True	string	Full name of the task: {catalogName}/{taskName}.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CustomizationTaskDefinition	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 task.

Sample request

HTTP

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

Sample response

Status code:

200

{
  "name": "myCatalog/choco",
  "catalogName": "myCatalog",
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco",
  "description": "Install a package via chocolatey",
  "parameters": {
    "package": {
      "description": "The package to install",
      "type": "string",
      "required": true
    },
    "version": {
      "description": "The version of the package",
      "type": "string",
      "default": "latest"
    },
    "retryOnFail": {
      "type": "boolean"
    }
  }
}

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.
CustomizationTaskDefinition	Represents a task to be used in customizing a Dev Box.
CustomizationTaskDefinitionParameter	Parameters for a customization task.
CustomizationTaskDefinitionParameterType	Type of the parameter.

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.

CustomizationTaskDefinition

Object

Represents a task to be used in customizing a Dev Box.

Name	Type	Description
catalogName	string	Name of the catalog that the task belongs to.
description	string	Description of the task.
name	string	Full name of the task: {catalogName}/{taskName}.
parameters	<string,  CustomizationTaskDefinitionParameter>	Parameters for the task.
uri	string	The unique URI of the customization task.

CustomizationTaskDefinitionParameter

Object

Parameters for a customization task.

Name	Type	Description
allowed	string[]	Allowed values for the parameter.
default	string	Default value for the parameter.
description	string	Description of the parameter.
required	boolean	Whether or not the parameter is required.
type	CustomizationTaskDefinitionParameterType	Type of the parameter.

CustomizationTaskDefinitionParameterType

Enumeration

Type of the parameter.

Value	Description
boolean	The parameter accepts a boolean value.
number	The parameter accepts a number value.
string	The parameter accepts a string value.