Dev Boxes - Get Customization Task Definitions

Serviço:

Dev Center

Versão da API:

2025-02-01

Obtém uma tarefa de personalização.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
catalogName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Nome do catálogo.
endpoint	path	True	string (uri)	O URI específico do DevCenter para operar.
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Nome do projeto.
taskName	path	True	string	Nome completo da tarefa: {catalogName}/{taskName}.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	CustomizationTaskDefinition	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://devcenter.azure.com/.default

Exemplos

Gets a customization task.

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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"
    }
  }
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
CustomizationTaskDefinition	Representa uma tarefa a ser usada na personalização de uma Caixa de Desenvolvimento.
CustomizationTaskDefinitionParameter	Parâmetros para uma tarefa de personalização.
CustomizationTaskDefinitionParameterType	Tipo do parâmetro.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

CustomizationTaskDefinition

Object

Representa uma tarefa a ser usada na personalização de uma Caixa de Desenvolvimento.

Name	Tipo	Description
catalogName	string	Nome do catálogo ao qual a tarefa pertence.
description	string	Descrição da tarefa.
name	string	Nome completo da tarefa: {catalogName}/{taskName}.
parameters	<string,  CustomizationTaskDefinitionParameter>	Parâmetros para a tarefa.
uri	string (uri)	O URI exclusivo da tarefa de personalização.

CustomizationTaskDefinitionParameter

Object

Parâmetros para uma tarefa de personalização.

Name	Tipo	Description
allowed	string[]	Valores permitidos para o parâmetro.
default	string	Valor padrão para o parâmetro.
description	string	Descrição do parâmetro.
required	boolean	Se o parâmetro é necessário ou não.
type	CustomizationTaskDefinitionParameterType	Tipo do parâmetro.

CustomizationTaskDefinitionParameterType

Enumeração

Tipo do parâmetro.

Valor	Description
boolean	O parâmetro aceita um valor booleano.
number	O parâmetro aceita um valor numérico.
string	O parâmetro aceita um valor de cadeia de caracteres.