Releases - Create
Crear una versión.
POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=5.0
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
project
|
path | True |
string |
Id. de proyecto o nombre del proyecto |
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
artifacts |
Establece la lista de artefactos para crear una versión. |
|
definitionId |
integer |
Establece el identificador de definición para crear una versión. |
description |
string |
Establece la descripción para crear una versión. |
environmentsMetadata |
Establece la lista de metadatos de entornos. |
|
isDraft |
boolean |
Establece "true" para crear la versión en modo borrador; de lo contrario, "false". |
manualEnvironments |
string[] |
Establece la lista de entornos en manual como condición. |
properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un |
|
reason |
Establece el motivo para crear una versión. |
|
variables |
<string,
Configuration |
Establece la lista de variables de versión que se reemplazarán en el momento de la implementación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta |
Seguridad
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
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
Scopes
Nombre | Description |
---|---|
vso.release_execute | Concede la capacidad de leer y actualizar artefactos de versión, incluidas las versiones, las definiciones de versión y la envrionment de versiones, y la capacidad de poner en cola una nueva versión. |
Ejemplos
Sample Request
POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=5.0
{
"definitionId": 1,
"description": "Creating Sample release",
"artifacts": [
{
"alias": "Fabrikam.CI",
"instanceReference": {
"id": "2",
"name": null
}
}
],
"isDraft": false,
"reason": "none",
"manualEnvironments": null
}
Sample Response
{
"id": 19,
"name": "Release-19",
"status": "active",
"createdOn": "2017-06-16T01:53:32.777Z",
"modifiedOn": "2017-06-16T01:53:32.777Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"environments": [
{
"id": 73,
"releaseId": 19,
"name": "Dev",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMintues": 43200
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 1,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "Manual"
},
{
"id": 74,
"releaseId": 19,
"name": "QA",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 2,
"definitionEnvironmentId": 2,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "Dev",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of Dev"
},
{
"id": 75,
"releaseId": 19,
"name": "PPE",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 3,
"definitionEnvironmentId": 3,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "QA",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of QA"
},
{
"id": 76,
"releaseId": 19,
"name": "PROD",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 4,
"definitionEnvironmentId": 4,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "PPE",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 19,
"name": "Release-19",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of PPE"
}
],
"variables": {},
"variableGroups": [],
"artifacts": [
{
"sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
"type": "Build",
"alias": "Fabrikam.CI",
"definitionReference": {
"artifactSourceDefinitionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
"name": ""
},
"defaultVersionBranch": {
"id": "",
"name": ""
},
"defaultVersionSpecific": {
"id": "",
"name": ""
},
"defaultVersionTags": {
"id": "",
"name": ""
},
"defaultVersionType": {
"id": "latestType",
"name": "Latest"
},
"definition": {
"id": "1",
"name": "Fabrikam.CI"
},
"project": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": "MyFirstProject"
},
"version": {
"id": "2",
"name": ""
},
"artifactSourceVersionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
"name": ""
}
},
"isPrimary": true
}
],
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 1,
"logsContainerUrl": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
}
},
"tags": [],
"projectReference": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": null
},
"properties": {}
}
Definiciones
ApprovalExecutionOrder
Nombre | Tipo | Description |
---|---|---|
afterGatesAlways |
string |
|
afterSuccessfulGates |
string |
|
beforeGates |
string |
ApprovalOptions
Nombre | Tipo | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
|
enforceIdentityRevalidation |
boolean |
|
executionOrder | ||
releaseCreatorCanBeApprover |
boolean |
|
requiredApproverCount |
integer |
|
timeoutInMinutes |
integer |
ApprovalStatus
Obtiene o establece el estado de la aprobación.
Nombre | Tipo | Description |
---|---|---|
approved |
string |
|
canceled |
string |
|
pending |
string |
|
reassigned |
string |
|
rejected |
string |
|
skipped |
string |
|
undefined |
string |
ApprovalType
Obtiene o establece el tipo de aprobación.
Nombre | Tipo | Description |
---|---|---|
all |
string |
|
postDeploy |
string |
|
preDeploy |
string |
|
undefined |
string |
Artifact
Nombre | Tipo | Description |
---|---|---|
alias |
string |
Obtiene o establece alias. |
definitionReference |
<string,
Artifact |
Obtiene o establece la referencia de definición. Por ejemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}} |
isPrimary |
boolean |
Obtiene o establece como artefacto principal o no. |
isRetained |
boolean |
|
type |
string |
Obtiene o establece el tipo. Puede tener el valor "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild". |
ArtifactMetadata
Nombre | Tipo | Description |
---|---|---|
alias |
string |
Establece el alias del artefacto. |
instanceReference |
Establece la referencia de instancia del artefacto. Por ejemplo, para el artefacto de compilación, es el número de compilación. |
ArtifactSourceReference
Nombre | Tipo | Description |
---|---|---|
id |
string |
|
name |
string |
AuthorizationHeader
Nombre | Tipo | Description |
---|---|---|
name |
string |
|
value |
string |
BuildVersion
Nombre | Tipo | Description |
---|---|---|
commitMessage |
string |
|
definitionId |
string |
|
definitionName |
string |
|
id |
string |
|
isMultiDefinitionType |
boolean |
|
name |
string |
|
sourceBranch |
string |
|
sourcePullRequestVersion | ||
sourceRepositoryId |
string |
|
sourceRepositoryType |
string |
|
sourceVersion |
string |
ConditionType
Obtiene o establece el tipo de condición.
Nombre | Tipo | Description |
---|---|---|
artifact |
string |
El tipo de condición es artifact. |
environmentState |
string |
El tipo de condición es el estado del entorno. |
event |
string |
El tipo de condición es event. |
undefined |
string |
El tipo de condición no está definido. |
ConfigurationVariableValue
Nombre | Tipo | Description |
---|---|---|
allowOverride |
boolean |
Obtiene o establece si una variable se puede invalidar en el momento de la implementación o no. |
isSecret |
boolean |
Obtiene o establece como variable es secreta o no. |
value |
string |
Obtiene o establece el valor de la variable de configuración. |
DataSourceBindingBase
Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.
Nombre | Tipo | Description |
---|---|---|
callbackContextTemplate |
string |
Formato de paginación compatible con 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. |
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 |
DeploymentAttempt
Nombre | Tipo | Description |
---|---|---|
attempt |
integer |
|
deploymentId |
integer |
|
hasStarted |
boolean |
Especifica si la implementación se ha iniciado o no. |
id |
integer |
|
issues |
Issue[] |
Todos los problemas relacionados con la implementación |
job | ||
lastModifiedBy | ||
lastModifiedOn |
string |
|
operationStatus | ||
postDeploymentGates | ||
preDeploymentGates | ||
queuedOn |
string |
|
reason | ||
releaseDeployPhases | ||
requestedBy | ||
requestedFor | ||
runPlanId |
string |
|
status | ||
tasks |
DeploymentJob
Nombre | Tipo | Description |
---|---|---|
job | ||
tasks |
DeploymentOperationStatus
Obtiene el estado de operación de la implementación.
Nombre | Tipo | Description |
---|---|---|
all |
string |
El estado de la operación de implementación es todo. |
approved |
string |
Se aprueba el estado de la operación de implementación. |
canceled |
string |
El estado de la operación de implementación se cancela. |
cancelling |
string |
El estado de la operación de implementación se cancela. |
deferred |
string |
El estado de la operación de implementación se aplaza. |
evaluatingGates |
string |
El estado de la operación de implementación es EvaluatingGates. |
gateFailed |
string |
El estado de la operación de implementación es GateFailed. |
manualInterventionPending |
string |
El estado de la operación de implementación es manualintervention pendiente. |
pending |
string |
El estado de la operación de implementación está pendiente. |
phaseCanceled |
string |
El estado de la operación de implementación se cancela por fase. |
phaseFailed |
string |
Error en el estado de la operación de implementación. |
phaseInProgress |
string |
El estado de la operación de implementación es la entrada de fase. |
phasePartiallySucceeded |
string |
El estado de la operación de implementación es la fase parcialmente correcta. |
phaseSucceeded |
string |
El estado de la operación de implementación es la fase correcta. |
queued |
string |
El estado de la operación de implementación está en cola. |
queuedForAgent |
string |
El estado de la operación de implementación se pone en cola para el agente. |
queuedForPipeline |
string |
El estado de la operación de implementación se pone en cola para la canalización. |
rejected |
string |
Se rechaza el estado de la operación de implementación. |
scheduled |
string |
El estado de la operación de implementación está programado. |
undefined |
string |
El estado de la operación de implementación no está definido. |
DeploymentReason
Obtiene el motivo de la implementación.
Nombre | Tipo | Description |
---|---|---|
automated |
string |
El motivo de implementación está automatizado. |
manual |
string |
El motivo de implementación es manual. |
none |
string |
El motivo de la implementación no es ninguno. |
redeployTrigger |
string |
El motivo de implementación es RedeployTrigger. |
scheduled |
string |
El motivo de implementación está programado. |
DeploymentStatus
Obtiene el estado de la implementación.
Nombre | Tipo | Description |
---|---|---|
all |
string |
El estado de implementación es todo. |
failed |
string |
Error en el estado de implementación. |
inProgress |
string |
El estado de implementación es inprogress. |
notDeployed |
string |
El estado de implementación no se implementa. |
partiallySucceeded |
string |
El estado de implementación se aplica parcialmente. |
succeeded |
string |
El estado de implementación se realiza correctamente. |
undefined |
string |
El estado de implementación no está definido. |
DeployPhase
Nombre | Tipo | Description |
---|---|---|
name |
string |
|
phaseType | ||
rank |
integer |
|
refName |
string |
|
workflowTasks |
DeployPhaseStatus
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
|
cancelling |
string |
|
failed |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
skipped |
string |
|
succeeded |
string |
|
undefined |
string |
DeployPhaseTypes
Nombre | Tipo | Description |
---|---|---|
agentBasedDeployment |
string |
|
deploymentGates |
string |
Tipo de fase que contiene tareas que actúan como Gates para que la implementación continúe. |
machineGroupBasedDeployment |
string |
|
runOnServer |
string |
|
undefined |
string |
EnvironmentOptions
Nombre | Tipo | Description |
---|---|---|
autoLinkWorkItems |
boolean |
|
badgeEnabled |
boolean |
|
emailNotificationType |
string |
|
emailRecipients |
string |
|
enableAccessToken |
boolean |
|
publishDeploymentStatus |
boolean |
|
pullRequestDeploymentEnabled |
boolean |
|
skipArtifactsDownload |
boolean |
|
timeoutInMinutes |
integer |
EnvironmentStatus
Obtiene el estado del entorno.
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
queued |
string |
|
rejected |
string |
|
scheduled |
string |
|
succeeded |
string |
|
undefined |
string |
GateStatus
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
inProgress |
string |
|
none |
string |
|
pending |
string |
|
succeeded |
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 |
|
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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo. |
IgnoredGate
Nombre | Tipo | Description |
---|---|---|
lastModifiedOn |
string |
Obtiene la fecha en la que se omite por última vez la puerta. |
name |
string |
Nombre de puerta omitida. |
Issue
Nombre | Tipo | Description |
---|---|---|
data |
object |
|
issueType |
string |
|
message |
string |
ManualIntervention
Nombre | Tipo | Description |
---|---|---|
approver |
Obtiene o establece la identidad que debe aprobar. |
|
comments |
string |
Obtiene o establece comentarios para su aprobación. |
createdOn |
string |
Obtiene la fecha en la que se creó. |
id |
integer |
Obtiene el identificador único para la intervención manual. |
instructions |
string |
Obtiene o establece instrucciones para la aprobación. |
modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
name |
string |
Obtiene o establece el nombre. |
release |
Obtiene releaseReference para la intervención manual. |
|
releaseDefinition |
Obtiene releaseDefinitionReference para la intervención manual. |
|
releaseEnvironment |
Obtiene releaseEnvironmentReference para la intervención manual. |
|
status |
Obtiene o establece el estado de la intervención manual. |
|
taskInstanceId |
string |
Obtiene el identificador de instancia de tarea. |
url |
string |
Obtiene la dirección URL para acceder a la intervención manual. |
ManualInterventionStatus
Obtiene o establece el estado de la intervención manual.
Nombre | Tipo | Description |
---|---|---|
approved |
string |
Se aprueba la intervención manual. |
canceled |
string |
Se cancela la intervención manual. |
pending |
string |
La intervención manual está pendiente. |
rejected |
string |
Se rechaza la intervención manual. |
unknown |
string |
La intervención manual no tiene el estado establecido. |
ProcessParameters
Nombre | Tipo | Description |
---|---|---|
dataSourceBindings |
Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Nombre | Tipo | Description |
---|---|---|
id |
string |
Obtiene el identificador único de este campo. |
name |
string |
Obtiene el nombre del proyecto. |
PropertiesCollection
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) TypeCode != TypeCode.Object
excepto .DBNull
Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como una cadena. Byte[] se esperaba como cadena codificada en base64.
Nombre | Tipo | Description |
---|---|---|
count |
integer |
Recuento de propiedades de la colección. |
item |
object |
|
keys |
string[] |
Conjunto de claves de la colección. |
values |
string[] |
Conjunto de valores de la colección. |
ReferenceLinks
Clase que se va a representar una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
Release
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene vínculos para acceder a la versión. |
|
artifacts |
Artifact[] |
Obtiene o establece la lista de artefactos. |
comment |
string |
Obtiene o establece el comentario. |
createdBy |
Obtiene o establece la identidad que creó. |
|
createdOn |
string |
Obtiene la fecha en la que se creó. |
definitionSnapshotRevision |
integer |
Obtiene el número de revisión de la instantánea de definición. |
description |
string |
Obtiene o establece la descripción de la versión. |
environments |
Obtiene la lista de entornos. |
|
id |
integer |
Obtiene el identificador único de este campo. |
keepForever |
boolean |
Si se va a excluir la versión de las directivas de retención. |
logsContainerUrl |
string |
Obtiene la dirección URL del contenedor de registros. |
modifiedBy |
Obtiene o establece la identidad que modificó. |
|
modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
name |
string |
Obtiene el nombre. |
poolName |
string |
Obtiene el nombre del grupo. |
projectReference |
Obtiene o establece la referencia del proyecto. |
|
properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) |
|
reason |
Obtiene el motivo de la versión. |
|
releaseDefinition |
Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta versión. |
|
releaseNameFormat |
string |
Obtiene el formato de nombre de versión. |
status |
Obtiene el estado. |
|
tags |
string[] |
Obtiene o establece la lista de etiquetas. |
triggeringArtifactAlias |
string |
|
variableGroups |
Obtiene la lista de grupos de variables. |
|
variables |
<string,
Configuration |
Obtiene o establece el diccionario de variables. |
ReleaseApproval
Nombre | Tipo | Description |
---|---|---|
approvalType |
Obtiene o establece el tipo de aprobación. |
|
approvedBy |
Obtiene la identidad que ha aprobado. |
|
approver |
Obtiene o establece la identidad que debe aprobar. |
|
attempt |
integer |
Obtiene o establece el intento que especifica el intento de implementación al que pertenece. |
comments |
string |
Obtiene o establece comentarios para su aprobación. |
createdOn |
string |
Obtiene la fecha en la que se creó. |
history |
Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación. |
|
id |
integer |
Obtiene el identificador único de este campo. |
isAutomated |
boolean |
Obtiene o establece como aprobación automatizada o no. |
isNotificationOn |
boolean |
|
modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
rank |
integer |
Obtiene o establece la clasificación que especifica el orden de la aprobación. Por ejemplo, la misma clasificación denota la aprobación en paralelo. |
release |
Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación. |
|
releaseDefinition |
Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta aprobación. |
|
releaseEnvironment |
Obtiene releaseEnvironmentReference, que especifica la referencia del entorno de versión al que está asociada esta aprobación. |
|
revision |
integer |
Obtiene el número de revisión. |
status |
Obtiene o establece el estado de la aprobación. |
|
trialNumber |
integer |
|
url |
string |
Obtiene la dirección URL para acceder a la aprobación. |
ReleaseApprovalHistory
Nombre | Tipo | Description |
---|---|---|
approver | ||
changedBy | ||
comments |
string |
|
createdOn |
string |
|
modifiedOn |
string |
|
revision |
integer |
ReleaseCondition
Nombre | Tipo | Description |
---|---|---|
conditionType |
Obtiene o establece el tipo de condición. |
|
name |
string |
Obtiene o establece el nombre de la condición. Por ejemplo, "ReleaseStarted". |
result |
boolean |
|
value |
string |
Obtiene o establece el valor de la condición. |
ReleaseDefinitionApprovals
Nombre | Tipo | Description |
---|---|---|
approvalOptions | ||
approvals |
ReleaseDefinitionApprovalStep
Nombre | Tipo | Description |
---|---|---|
approver | ||
id |
integer |
|
isAutomated |
boolean |
|
isNotificationOn |
boolean |
|
rank |
integer |
ReleaseDefinitionGate
Nombre | Tipo | Description |
---|---|---|
tasks |
ReleaseDefinitionGatesOptions
Nombre | Tipo | Description |
---|---|---|
isEnabled |
boolean |
|
minimumSuccessDuration |
integer |
|
samplingInterval |
integer |
|
stabilizationTime |
integer |
|
timeout |
integer |
ReleaseDefinitionGatesStep
Nombre | Tipo | Description |
---|---|---|
gates | ||
gatesOptions | ||
id |
integer |
ReleaseDefinitionShallowReference
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión. |
|
id |
integer |
Obtiene el identificador único de la definición de versión. |
name |
string |
Obtiene o establece el nombre de la definición de versión. |
path |
string |
Obtiene o establece la ruta de acceso de la definición de versión. |
projectReference |
Obtiene o establece la referencia del proyecto. |
|
url |
string |
Obtiene la dirección URL de la API REST para acceder a la definición de versión. |
ReleaseDeployPhase
Nombre | Tipo | Description |
---|---|---|
deploymentJobs | ||
errorLog |
string |
|
id |
integer |
|
manualInterventions | ||
name |
string |
|
phaseId |
string |
|
phaseType | ||
rank |
integer |
|
runPlanId |
string |
|
startedOn |
string |
Hora de inicio de fase |
status |
ReleaseEnvironment
Nombre | Tipo | Description |
---|---|---|
conditions |
Obtiene la lista de condiciones. |
|
createdOn |
string |
Obtiene la fecha en la que se creó. |
definitionEnvironmentId |
integer |
Obtiene el identificador de entorno de definición. |
demands |
Demand[] |
Obtiene las demandas. |
deployPhasesSnapshot |
Obtiene la lista de instantáneas de fases de implementación. |
|
deploySteps |
Obtiene los pasos de implementación. |
|
environmentOptions |
Obtiene las opciones de entorno. |
|
id |
integer |
Obtiene el identificador único de este campo. |
modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
name |
string |
Obtiene el nombre. |
nextScheduledUtcTime |
string |
Obtiene la siguiente hora UTC programada. |
owner |
Obtiene la identidad que es propietaria del entorno de versión. |
|
postApprovalsSnapshot |
Obtiene la lista de instantáneas posteriores a la implementación. |
|
postDeployApprovals |
Obtiene la lista de aprobaciones posteriores a la implementación. |
|
postDeploymentGatesSnapshot | ||
preApprovalsSnapshot |
Obtiene la lista de instantáneas de aprobaciones de implementación previa. |
|
preDeployApprovals |
Obtiene la lista de aprobaciones de implementación previa. |
|
preDeploymentGatesSnapshot | ||
processParameters |
Obtiene parámetros de proceso. |
|
queueId |
integer |
Obtiene el identificador de cola. |
rank |
integer |
Obtiene la clasificación. |
release |
Obtiene la referencia de versión que especifica la referencia de la versión a la que está asociado este entorno de versión. |
|
releaseCreatedBy |
Obtiene la identidad que creó la versión. |
|
releaseDefinition |
Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociado este entorno de versión. |
|
releaseDescription |
string |
Obtiene la descripción de la versión. |
releaseId |
integer |
Obtiene el identificador de versión. |
scheduledDeploymentTime |
string |
Obtiene la hora de implementación de la programación del entorno de versión. |
schedules |
Obtiene la lista de programaciones. |
|
status |
Obtiene el estado del entorno. |
|
timeToDeploy |
number |
Obtiene el tiempo de implementación. |
triggerReason |
string |
Obtiene el motivo del desencadenador. |
variableGroups |
Obtiene la lista de grupos de variables. |
|
variables |
<string,
Configuration |
Obtiene el diccionario de variables. |
workflowTasks |
Obtiene la lista de tareas de flujo de trabajo. |
ReleaseEnvironmentShallowReference
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión. |
|
id |
integer |
Obtiene el identificador único del entorno de versión. |
name |
string |
Obtiene o establece el nombre del entorno de versión. |
url |
string |
Obtiene la dirección URL de la API rest para acceder al entorno de versión. |
ReleaseGates
Nombre | Tipo | Description |
---|---|---|
deploymentJobs | ||
id |
integer |
|
ignoredGates | ||
lastModifiedOn |
string |
|
runPlanId |
string |
|
stabilizationCompletedOn |
string |
|
startedOn |
string |
|
status | ||
succeedingSince |
string |
ReleaseReason
Obtiene el motivo de la versión.
Nombre | Tipo | Description |
---|---|---|
continuousIntegration |
string |
|
manual |
string |
|
none |
string |
|
pullRequest |
string |
|
schedule |
string |
ReleaseSchedule
Nombre | Tipo | Description |
---|---|---|
daysToRelease |
Días de la semana que se van a publicar |
|
jobId |
string |
Identificador de trabajo de definición de trabajo de Team Foundation |
startHours |
integer |
Hora de zona horaria local para iniciarse |
startMinutes |
integer |
Minuto de zona horaria local para empezar |
timeZoneId |
string |
Identificador de zona horaria de la programación de lanzamiento, como "UTC" |
ReleaseShallowReference
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene los vínculos a recursos, API y vistas relacionados para la versión. |
|
id |
integer |
Obtiene el identificador único de la versión. |
name |
string |
Obtiene o establece el nombre de la versión. |
url |
string |
Obtiene la dirección URL de la API rest para acceder a la versión. |
ReleaseStartEnvironmentMetadata
Nombre | Tipo | Description |
---|---|---|
definitionEnvironmentId |
integer |
Establece el identificador del entorno de definición de versión. |
variables |
<string,
Configuration |
Establece la lista de variables de entorno que se reemplazarán en el momento de la implementación. |
ReleaseStartMetadata
Nombre | Tipo | Description |
---|---|---|
artifacts |
Establece la lista de artefactos para crear una versión. |
|
definitionId |
integer |
Establece el identificador de definición para crear una versión. |
description |
string |
Establece la descripción para crear una versión. |
environmentsMetadata |
Establece la lista de metadatos de entornos. |
|
isDraft |
boolean |
Establece "true" para crear una versión en modo borrador; en caso contrario, "false". |
manualEnvironments |
string[] |
Establece la lista de entornos en manual como condición. |
properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con ) |
|
reason |
Establece el motivo para crear una versión. |
|
variables |
<string,
Configuration |
Establece la lista de variables de versión que se van a invalidar en el momento de la implementación. |
ReleaseStatus
Obtiene el estado.
Nombre | Tipo | Description |
---|---|---|
abandoned |
string |
|
active |
string |
|
draft |
string |
|
undefined |
string |
ReleaseTask
Nombre | Tipo | Description |
---|---|---|
agentName |
string |
|
finishTime |
string |
|
id |
integer |
|
issues |
Issue[] |
|
lineCount |
integer |
|
logUrl |
string |
|
name |
string |
|
percentComplete |
integer |
|
rank |
integer |
|
resultCode |
string |
|
startTime |
string |
|
status | ||
task | ||
timelineRecordId |
string |
ScheduleDays
Días de la semana que se van a publicar
Nombre | Tipo | Description |
---|---|---|
all |
string |
|
friday |
string |
|
monday |
string |
|
none |
string |
|
saturday |
string |
|
sunday |
string |
|
thursday |
string |
|
tuesday |
string |
|
wednesday |
string |
SourcePullRequestVersion
Nombre | Tipo | Description |
---|---|---|
pullRequestId |
string |
Identificador de solicitud de incorporación de cambios para el que la versión publicará el estado |
pullRequestMergedAt |
string |
|
sourceBranchCommitId |
string |
Identificador de confirmación de la rama de origen de la solicitud de incorporación de cambios para la que la versión publicará el estado |
TaskInputDefinitionBase
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 |
TaskSourceDefinitionBase
Nombre | Tipo | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
failure |
string |
|
inProgress |
string |
|
partiallySucceeded |
string |
|
pending |
string |
|
skipped |
string |
|
succeeded |
string |
|
success |
string |
|
unknown |
string |
VariableGroup
Nombre | Tipo | Description |
---|---|---|
createdBy |
Obtiene o establece la identidad que creó. |
|
createdOn |
string |
Obtiene la fecha en la que se creó. |
description |
string |
Obtiene o establece la descripción. |
id |
integer |
Obtiene el identificador único de este campo. |
isShared |
boolean |
Indica si un grupo de variables se comparte con otro proyecto o no. |
modifiedBy |
Obtiene o establece la identidad que modificó. |
|
modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
name |
string |
Obtiene o establece el nombre. |
providerData |
Obtiene o establece los datos del proveedor. |
|
type |
string |
Obtiene o establece el tipo. |
variables |
<string,
Variable |
VariableGroupProviderData
VariableValue
Nombre | Tipo | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |
WorkflowTask
Nombre | Tipo | Description |
---|---|---|
alwaysRun |
boolean |
|
condition |
string |
|
continueOnError |
boolean |
|
definitionType |
string |
|
enabled |
boolean |
|
environment |
object |
|
inputs |
object |
|
name |
string |
|
overrideInputs |
object |
|
refName |
string |
|
taskId |
string |
|
timeoutInMinutes |
integer |
|
version |
string |
WorkflowTaskReference
Nombre | Tipo | Description |
---|---|---|
id |
string |
|
name |
string |
|
version |
string |