Taskgroups - List
Enumerar grupos de tareas.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId}?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId}?expanded={expanded}&taskIdFilter={taskIdFilter}&deleted={deleted}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&api-version=7.1
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Nombre de la organización de Azure DevOps. |
project
|
path | True |
string |
Id. de proyecto o nombre del proyecto |
task
|
path |
string (uuid) |
Identificador del grupo de tareas. |
|
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API. |
$top
|
query |
integer (int32) |
Número de grupos de tareas que se van a obtener. |
|
continuation
|
query |
string (date-time) |
Obtiene los grupos de tareas después del token de continuación proporcionado. |
|
deleted
|
query |
boolean |
"true" para incluir grupos de tareas eliminados. El valor predeterminado es "false". |
|
expanded
|
query |
boolean |
"true" para expandir de forma recursiva los grupos de tareas. El valor predeterminado es "false". |
|
query
|
query |
Obtiene los resultados en el orden definido. El valor predeterminado es "CreatedOnDescending". |
||
task
|
query |
string (uuid) |
Guid del taskId que se va a filtrar. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta |
Seguridad
oauth2
Tipo:
oauth2
Flujo:
accessCode
Dirección URL de autorización:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Ámbitos
Nombre | Description |
---|---|
vso.taskgroups_read | Concede la capacidad de leer grupos de tareas |
Ejemplos
List all task groups |
List all versions of a task group |
List all task groups
Solicitud de ejemplo
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/taskgroups?api-version=7.1
Respuesta de muestra
{
"count": 3,
"value": [
{
"tasks": [
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"inlineScript": "Write-Host \"Hello World\""
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
},
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"inlineScript": "Write-Host \"New task\""
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
}
],
"runsOn": [
"Agent",
"DeploymentGroup"
],
"revision": 2,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"createdOn": "2017-12-18T08:01:25.24Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"modifiedOn": "2017-12-18T08:01:25.893Z",
"comment": "Updated the task group",
"id": "2da4ab36-6fd7-416f-a8ee-5b2a9d3bd61c",
"name": "PowerShell TG1",
"version": {
"major": 1,
"minor": 0,
"patch": 0,
"isTest": false
},
"category": "Deploy",
"definitionType": "metaTask",
"instanceNameFormat": "Task group: TG"
},
{
"tasks": [
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": true,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
},
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"New task\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
}
],
"runsOn": [
"Agent",
"DeploymentGroup"
],
"revision": 4,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"createdOn": "2017-12-18T08:01:36.74Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"modifiedOn": "2017-12-18T08:01:43.787Z",
"comment": "Published preview",
"id": "2da4ab36-6fd7-416f-a8ee-5b2a9d3bd61c",
"name": "PowerShell TG1",
"version": {
"major": 2,
"minor": 0,
"patch": 0,
"isTest": false
},
"iconUrl": "https://cdn.vsassets.io/v/20171217T033454/_content/icon-meta-task.png",
"friendlyName": "PowerShell TG1",
"category": "Deploy",
"definitionType": "metaTask",
"instanceNameFormat": "Task group: PowerShell TG1 "
},
{
"tasks": [
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
},
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"New task\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
}
],
"runsOn": [
"Agent",
"DeploymentGroup"
],
"revision": 1,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"createdOn": "2017-12-17T20:15:04.517Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"modifiedOn": "2017-12-17T20:15:04.517Z",
"id": "a4bec09c-4360-45cb-8242-78672fc31a53",
"name": "My PowerShell TG2",
"version": {
"major": 1,
"minor": 0,
"patch": 0,
"isTest": false
},
"friendlyName": "My PowerShell TG2",
"category": "Deploy",
"definitionType": "metaTask",
"instanceNameFormat": "Task group: My PowerShell TG2 "
}
]
}
List all versions of a task group
Solicitud de ejemplo
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/taskgroups?api-version=7.1
Respuesta de muestra
{
"count": 2,
"value": [
{
"tasks": [
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"inlineScript": "Write-Host \"Hello World\""
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
},
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"inlineScript": "Write-Host \"New task\""
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
}
],
"runsOn": [
"Agent",
"DeploymentGroup"
],
"revision": 2,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"createdOn": "2017-12-18T08:01:25.24Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"modifiedOn": "2017-12-18T08:01:25.893Z",
"comment": "Updated the task group",
"id": "2da4ab36-6fd7-416f-a8ee-5b2a9d3bd61c",
"name": "PowerShell TG1",
"version": {
"major": 1,
"minor": 0,
"patch": 0,
"isTest": false
},
"category": "Deploy",
"definitionType": "metaTask",
"instanceNameFormat": "Task group: TG"
},
{
"tasks": [
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": true,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
},
{
"displayName": "PowerShell Script",
"alwaysRun": false,
"continueOnError": false,
"enabled": true,
"timeoutInMinutes": 0,
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "Write-Host \"New task\"",
"workingFolder": "",
"failOnStandardError": "true"
},
"task": {
"id": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"versionSpec": "1.*",
"definitionType": "task"
}
}
],
"runsOn": [
"Agent",
"DeploymentGroup"
],
"revision": 4,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"createdOn": "2017-12-18T08:01:36.74Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com"
},
"modifiedOn": "2017-12-18T08:01:43.787Z",
"comment": "Published preview",
"id": "2da4ab36-6fd7-416f-a8ee-5b2a9d3bd61c",
"name": "PowerShell TG1",
"version": {
"major": 2,
"minor": 0,
"patch": 0,
"isTest": false
},
"iconUrl": "https://cdn.vsassets.io/v/20171217T033454/_content/icon-meta-task.png",
"friendlyName": "PowerShell TG1",
"category": "Deploy",
"definitionType": "metaTask",
"instanceNameFormat": "Task group: PowerShell TG1 "
}
]
}
Definiciones
Nombre | Description |
---|---|
Authorization |
|
Data |
|
Demand | |
Identity |
|
JObject |
Representa un objeto JSON. |
JToken |
Representa un token JSON abstracto. |
Reference |
Clase que representa una colección de vínculos de referencia rest. |
Task |
|
Task |
|
Task |
|
Task |
|
Task |
|
Task |
|
Task |
Obtiene los resultados en el orden definido. El valor predeterminado es "CreatedOnDescending". |
Task |
Representa las tareas del grupo de tareas. |
Task |
|
Task |
|
Task |
|
Task |
Referencia a una tarea. |
Task |
|
Task |
|
Task |
|
Task |
AuthorizationHeader
Nombre | Tipo | Description |
---|---|---|
name |
string |
Obtiene o establece el nombre del encabezado de autorización. |
value |
string |
Obtiene o establece el valor del encabezado de autorización. |
DataSourceBinding
Nombre | Tipo | Description |
---|---|---|
callbackContextTemplate |
string |
Formato de paginación admitido por este origen de datos(ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
¿Se necesitan llamadas posteriores? |
dataSourceName |
string |
Obtiene o establece el nombre del origen de datos. |
endpointId |
string |
Obtiene o establece el identificador del punto de conexión. |
endpointUrl |
string |
Obtiene o establece la dirección URL del punto de conexión de servicio. |
headers |
Obtiene o establece los encabezados de autorización. |
|
initialContextTemplate |
string |
Define el valor inicial de los parámetros de consulta. |
parameters |
object |
Obtiene o establece los parámetros del origen de datos. |
requestContent |
string |
Obtiene o establece el cuerpo de la solicitud HTTP. |
requestVerb |
string |
Obtiene o establece el verbo de solicitud HTTP. |
resultSelector |
string |
Obtiene o establece el selector de resultados. |
resultTemplate |
string |
Obtiene o establece la plantilla de resultado. |
target |
string |
Obtiene o establece el destino del origen de datos. |
Demand
Nombre | Tipo | Description |
---|---|---|
name |
string |
|
value |
string |
IdentityRef
Nombre | Tipo | Description |
---|---|---|
_links |
Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo. |
|
descriptor |
string |
El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones. |
directoryAlias |
string |
En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links". |
displayName |
string |
Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen. |
id |
string |
|
imageUrl |
string |
En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef |
inactive |
boolean |
En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser. |
isAadIdentity |
boolean |
En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef |
uniqueName |
string |
En desuso: use Domain+PrincipalName en su lugar. |
url |
string |
Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo. |
JObject
Representa un objeto JSON.
Nombre | Tipo | Description |
---|---|---|
item |
Representa un token JSON abstracto. |
|
type |
string (JTokenType) |
Obtiene el tipo de nodo para este JToken. |
JToken
Representa un token JSON abstracto.
Nombre | Tipo | Description |
---|---|---|
first |
Obtenga el primer token secundario de este token. |
|
hasValues |
boolean |
Obtiene un valor que indica si este token tiene tokens secundarios. |
item |
Representa un token JSON abstracto. |
|
last |
Obtenga el último token secundario de este token. |
|
next |
Obtiene el siguiente token relacionado de este nodo. |
|
parent |
string (JContainer) |
Obtiene o establece el elemento primario. |
path |
string |
Obtiene la ruta de acceso del token JSON. |
previous |
Obtiene el token relacionado anterior de este nodo. |
|
root |
Obtiene el JToken raíz de este JToken. |
|
type |
string (JTokenType) |
Obtiene el tipo de nodo para este JToken. |
ReferenceLinks
Clase que representa una colección de vínculos de referencia rest.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
TaskCommandMode
Valor | Description |
---|---|
any | |
restricted |
TaskCommandRestrictions
Nombre | Tipo | Description |
---|---|---|
mode |
TaskDefinitionReference
Nombre | Tipo | Description |
---|---|---|
definitionType |
string |
Obtiene o establece el tipo de definición. Los valores pueden ser "task" o "metaTask". |
id |
string (uuid) |
Obtiene o establece el identificador único de la tarea. |
versionSpec |
string |
Obtiene o establece la especificación de versión de la tarea. |
TaskExecution
Nombre | Tipo | Description |
---|---|---|
execTask |
Tarea de utilidad que se va a ejecutar. Especificar esto significa que esta definición de tarea es simplemente una metatarea para llamar a otra tarea. Esto es útil para las tareas que llaman a tareas de utilidad como powershell y línea de comandos. |
|
platformInstructions |
object |
Si una tarea va a ejecutar código, esto proporciona el tipo o script, etc. información por plataforma. Por ejemplo, podría parecerse. net45: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } net20: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } java: { jar: "powershelltask.tasks.automation.teamfoundation.microsoft.com", } nodo: { script: "powershellhost.js", } |
TaskGroup
Nombre | Tipo | Description |
---|---|---|
agentExecution | ||
author |
string |
|
category |
string |
|
comment |
string |
Obtiene o establece el comentario. |
contentsUploaded |
boolean |
|
contributionIdentifier |
string |
|
contributionVersion |
string |
|
createdBy |
Obtiene o establece la identidad que creó. |
|
createdOn |
string (date-time) |
Obtiene o establece la fecha en la que se creó. |
dataSourceBindings | ||
definitionType |
string |
|
deleted |
boolean |
Obtiene o establece como "true" para indicar como eliminado, "false" de lo contrario. |
demands |
Demand[] |
|
deprecated |
boolean |
|
description |
string |
|
disabled |
boolean |
|
execution |
<string, JObject> |
|
friendlyName |
string |
|
groups | ||
helpMarkDown |
string |
|
helpUrl |
string |
|
hostType |
string |
|
iconUrl |
string |
|
id |
string (uuid) |
|
inputs | ||
instanceNameFormat |
string |
|
minimumAgentVersion |
string |
|
modifiedBy |
Obtiene o establece la identidad que modificó. |
|
modifiedOn |
string (date-time) |
Obtiene o establece la fecha en la que se modificó. |
name |
string |
|
outputVariables | ||
owner |
string |
Obtiene o establece el propietario. |
packageLocation |
string |
|
packageType |
string |
|
parentDefinitionId |
string (uuid) |
Obtiene o establece el identificador del grupo de tareas primario. Esto se usa al crear un grupo de tareas de borrador. |
postJobExecution |
<string, JObject> |
|
preJobExecution |
<string, JObject> |
|
preview |
boolean |
|
releaseNotes |
string |
|
restrictions | ||
revision |
integer (int32) |
Obtiene o establece la revisión. |
runsOn |
string[] |
|
satisfies |
string[] |
|
serverOwned |
boolean |
|
showEnvironmentVariables |
boolean |
|
sourceDefinitions | ||
sourceLocation |
string |
|
tasks |
Obtiene o establece las tareas. |
|
version | ||
visibility |
string[] |
TaskGroupDefinition
Nombre | Tipo | Description |
---|---|---|
displayName |
string |
|
isExpanded |
boolean |
|
name |
string |
|
tags |
string[] |
|
visibleRule |
string |
TaskGroupQueryOrder
Obtiene los resultados en el orden definido. El valor predeterminado es "CreatedOnDescending".
Valor | Description |
---|---|
createdOnAscending |
Order by createdon ascending. |
createdOnDescending |
Orden por creado de forma descendente. |
TaskGroupStep
Representa las tareas del grupo de tareas.
Nombre | Tipo | Description |
---|---|---|
alwaysRun |
boolean |
Obtiene o establece como "true" para ejecutar la tarea siempre, "false" de lo contrario. |
condition |
string |
Obtiene o establece la condición de la tarea. |
continueOnError |
boolean |
Obtiene o establece como "true" para continuar con el error; de lo contrario, "false". |
displayName |
string |
Obtiene o establece el nombre para mostrar. |
enabled |
boolean |
Obtiene o establece como tarea habilitada o no. |
environment |
object |
Obtiene el diccionario de variables de entorno. |
inputs |
object |
Obtiene o establece el diccionario de entradas. |
retryCountOnTaskFailure |
integer (int32) |
Obtiene o establece el número máximo de reintentos. |
task |
Obtiene o establece la referencia de la tarea. |
|
timeoutInMinutes |
integer (int32) |
Obtiene o establece el tiempo máximo, en minutos, que una tarea puede ejecutarse en el agente antes de ser cancelada por el servidor. Un valor cero indica un tiempo de espera infinito. |
TaskInputDefinition
Nombre | Tipo | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Nombre | Tipo | Description |
---|---|---|
expression |
string |
Expresión condicional |
message |
string |
Mensaje que explica cómo el usuario puede corregir si se produce un error en la validación |
TaskOutputVariable
Nombre | Tipo | Description |
---|---|---|
description |
string |
|
name |
string |
TaskReference
Referencia a una tarea.
Nombre | Tipo | Description |
---|---|---|
id |
string (uuid) |
Identificador de la definición de tarea. Corresponde al valor id de task.json archivo. |
inputs |
object |
Diccionario de entradas específicas de una definición de tarea. Corresponde al valor de entradas del archivo task.json. |
name |
string |
Nombre de la definición de tarea. Corresponde al valor de nombre del archivo task.json. |
version |
string |
Versión de la definición de tarea. Corresponde al valor de versión de task.json archivo. |
TaskRestrictions
Nombre | Tipo | Description |
---|---|---|
commands | ||
settableVariables |
TaskSourceDefinition
Nombre | Tipo | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskVariableRestrictions
Nombre | Tipo | Description |
---|---|---|
allowed |
string[] |
TaskVersion
Nombre | Tipo | Description |
---|---|---|
isTest |
boolean |
|
major |
integer (int32) |
|
minor |
integer (int32) |
|
patch |
integer (int32) |