Compartir a través de


Releases - Create

Cree una versión.

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?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

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.

Cuerpo de la solicitud

Nombre Tipo Description
artifacts

ArtifactMetadata[]

Establece la lista de artefactos para crear una versión.

definitionId

integer (int32)

Establece el identificador de definición para crear una versión.

description

string

Establece la descripción para crear una versión.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

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

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 un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

reason

ReleaseReason

Establece el motivo para crear una versión.

variables

<string,  ConfigurationVariableValue>

Establece la lista de variables de versión que se van a invalidar en el momento de la implementación.

Respuestas

Nombre Tipo Description
200 OK

Release

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.release_execute Concede la capacidad de leer y actualizar artefactos de versión, incluidas carpetas, versiones, definiciones de versión y entorno de versión, y la capacidad de poner en cola una nueva versión.

Ejemplos

Solicitud de ejemplo

POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=7.1

{
  "definitionId": 1,
  "description": "Creating Sample release",
  "artifacts": [
    {
      "alias": "Fabrikam.CI",
      "instanceReference": {
        "id": "2",
        "name": null
      }
    }
  ],
  "isDraft": false,
  "reason": "none",
  "manualEnvironments": null
}

Respuesta de muestra

{
  "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://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-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://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-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

Nombre Description
ApprovalExecutionOrder

Orden de ejecución de aprobaciones.

ApprovalOptions
ApprovalStatus

Obtiene o establece el estado de la aprobación.

ApprovalType

Obtiene o establece el tipo de aprobación.

Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
ConditionType

Obtiene o establece el tipo de condición.

ConfigurationVariableValue
DataSourceBindingBase

Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.

DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

Obtiene el estado de la operación de la implementación.

DeploymentReason

Obtiene el motivo de la implementación.

DeploymentStatus

Obtiene el estado de la implementación.

DeployPhase
DeployPhaseStatus

Estado de la fase.

DeployPhaseTypes

Indica el tipo de fase de implementación.

EnvironmentOptions
EnvironmentStatus

Obtiene el estado del entorno.

GateStatus

Estado de las puertas de liberación.

IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

Obtiene o establece el estado de la intervención manual.

ProcessParameters
ProjectReference
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 un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

ReferenceLinks

Clase que representa una colección de vínculos de referencia rest.

Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason

Obtiene el motivo de la versión.

ReleaseSchedule
ReleaseShallowReference
ReleaseStartEnvironmentMetadata
ReleaseStartMetadata
ReleaseStatus

Obtiene el estado.

ReleaseTask
ScheduleDays

Días de la semana que se van a publicar.

SourcePullRequestVersion
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus

Estado de la tarea de versión.

VariableGroup
VariableGroupProjectReference

Una referencia de grupo de variables es una referencia superficial al grupo de variables.

VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Orden de ejecución de aprobaciones.

Valor Description
afterGatesAlways

Las aprobaciones siempre se muestran después de la ejecución de puertas.

afterSuccessfulGates

Aprobaciones mostradas después de la ejecución correcta de puertas.

beforeGates

Aprobaciones mostradas antes de las puertas.

ApprovalOptions

Nombre Tipo Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

Especifique si la aprobación se puede omitir si el mismo aprobador aprobó la fase anterior.

enforceIdentityRevalidation

boolean

Especifique si vuelve a validar la identidad del aprobador antes de completar la aprobación.

executionOrder

ApprovalExecutionOrder

Orden de ejecución de aprobaciones.

releaseCreatorCanBeApprover

boolean

Especifique si el usuario que solicita una versión o una implementación debe permitir el aprobador.

requiredApproverCount

integer (int32)

Número de aprobaciones necesarias para avanzar la versión. '0' significa todas las aprobaciones necesarias.

timeoutInMinutes

integer (int32)

Tiempo de espera de aprobación. El tiempo de espera predeterminado de aprobación es de 30 días. El tiempo de espera máximo permitido es de 365 días. '0' significa tiempo de espera predeterminado, es decir, 30 días.

ApprovalStatus

Obtiene o establece el estado de la aprobación.

Valor Description
approved

Indica que se aprueba la aprobación.

canceled

Indica que se cancela la aprobación.

pending

Indica que la aprobación está pendiente.

reassigned

Indica que la aprobación se reasigna.

rejected

Indica que se rechaza la aprobación.

skipped

Indica que se omite la aprobación.

undefined

Indica que la aprobación no tiene establecido el estado.

ApprovalType

Obtiene o establece el tipo de aprobación.

Valor Description
all

Indica todas las aprobaciones.

postDeploy

Indica las aprobaciones que se ejecutaron después de la implementación.

preDeploy

Indica las aprobaciones que se ejecutaron antes de la implementación.

undefined

Indica que el tipo de aprobación no se establece.

Artifact

Nombre Tipo Description
alias

string

Obtiene o establece alias.

definitionReference

<string,  ArtifactSourceReference>

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

Indica si el artefacto es principal o no.

isRetained

boolean

Indica si el artefacto se conserva por versión o no.

type

string

Obtiene o establece el tipo. Puede tener un valor como "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild".

ArtifactMetadata

Nombre Tipo Description
alias

string

Establece el alias del artefacto.

instanceReference

BuildVersion

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

Identificador del origen del artefacto.

name

string

Nombre del origen del artefacto.

AuthorizationHeader

Nombre Tipo Description
name

string

value

string

BuildVersion

Nombre Tipo Description
commitMessage

string

Obtiene o establece el mensaje de confirmación del artefacto.

definitionId

string

Obtiene o establece el identificador de definición.

definitionName

string

Obtiene o establece el nombre de la definición.

id

string

Obtiene o establece el identificador de compilación.

isMultiDefinitionType

boolean

Obtiene o establece si el artefacto admite varias definiciones.

name

string

Obtiene o establece el número de compilación.

sourceBranch

string

Obtiene o establece la rama de origen del artefacto.

sourcePullRequestVersion

SourcePullRequestVersion

Obtiene o establece la versión de solicitud de incorporación de cambios de origen para el artefacto.

sourceRepositoryId

string

Obtiene o establece el identificador del repositorio para el artefacto.

sourceRepositoryType

string

Obtiene o establece el tipo de repositorio para el artefacto.

sourceVersion

string

Obtiene o establece la versión de origen del artefacto.

ConditionType

Obtiene o establece el tipo de condición.

Valor Description
artifact

El tipo de condición es artifact.

environmentState

El tipo de condición es el estado del entorno.

event

El tipo de condición es event.

undefined

El tipo de condición no está definido.

ConfigurationVariableValue

Nombre Tipo Description
allowOverride

boolean

Obtiene y establece si se puede invalidar una variable en el momento de la implementación o no.

isSecret

boolean

Obtiene o establece como variable es secreta o no.

value

string

Obtiene y 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 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

AuthorizationHeader[]

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.

DeploymentAttempt

Nombre Tipo Description
attempt

integer (int32)

Intento de implementación.

deploymentId

integer (int32)

Identificador de la implementación.

hasStarted

boolean

Especifica si la implementación se ha iniciado o no.

id

integer (int32)

Id. de implementación.

issues

Issue[]

Todos los problemas relacionados con la implementación.

lastModifiedBy

IdentityRef

Identidad que modificó esta implementación por última vez.

lastModifiedOn

string (date-time)

Hora a la que se modificó por última vez esta implementación.

operationStatus

DeploymentOperationStatus

Estado de la operación de implementación.

postDeploymentGates

ReleaseGates

Después de las puertas de implementación que se ejecutaron en esta implementación.

preDeploymentGates

ReleaseGates

Puertas de implementación previas que se ejecutaron en esta implementación.

queuedOn

string (date-time)

Cuando esta implementación se pone en cola.

reason

DeploymentReason

Motivo de la implementación.

releaseDeployPhases

ReleaseDeployPhase[]

Lista de implementaciones de versión ejecutadas en esta implementación.

requestedBy

IdentityRef

Identidad que solicitó esta implementación.

requestedFor

IdentityRef

Identidad de esta implementación solicitada.

status

DeploymentStatus

estado de la implementación.

DeploymentJob

Nombre Tipo Description
job

ReleaseTask

Tarea primaria de todas las tareas ejecutadas.

tasks

ReleaseTask[]

Lista de tareas ejecutadas con en el trabajo.

DeploymentOperationStatus

Obtiene el estado de la operación de la implementación.

Valor Description
all

El estado de la operación de implementación es todo.

approved

Se aprueba el estado de la operación de implementación.

canceled

El estado de la operación de implementación se cancela.

cancelling

El estado de la operación de implementación se está cancelando.

deferred

El estado de la operación de implementación se aplaza.

evaluatingGates

El estado de la operación de implementación es EvaluarGates.

gateFailed

El estado de la operación de implementación es GateFailed.

manualInterventionPending

El estado de la operación de implementación es manualintervention pendiente.

pending

El estado de la operación de implementación está pendiente.

phaseCanceled

El estado de la operación de implementación se cancela por fases.

phaseFailed

Error en el estado de la operación de implementación.

phaseInProgress

El estado de la operación de implementación está en curso.

phasePartiallySucceeded

El estado de la operación de implementación es la fase parcialmente correcta.

phaseSucceeded

El estado de la operación de implementación es la fase correcta.

queued

El estado de la operación de implementación está en cola.

queuedForAgent

El estado de la operación de implementación se pone en cola para el agente.

queuedForPipeline

El estado de la operación de implementación se pone en cola para la canalización.

rejected

Se rechaza el estado de la operación de implementación.

scheduled

El estado de la operación de implementación está programado.

undefined

El estado de la operación de implementación no está definido.

DeploymentReason

Obtiene el motivo de la implementación.

Valor Description
automated

El motivo de implementación está automatizado.

manual

El motivo de implementación es manual.

none

El motivo de implementación no es ninguno.

redeployTrigger

El motivo de implementación es RedeployTrigger.

scheduled

El motivo de implementación está programado.

DeploymentStatus

Obtiene el estado de la implementación.

Valor Description
all

El estado de implementación es todo.

failed

Error en el estado de implementación.

inProgress

El estado de implementación está en curso.

notDeployed

El estado de implementación no se implementa.

partiallySucceeded

El estado de implementación se realiza parcialmente.

succeeded

El estado de implementación se realiza correctamente.

undefined

El estado de implementación no está definido.

DeployPhase

Nombre Tipo Description
name

string

Obtiene y establece el nombre de la fase de implementación.

phaseType

DeployPhaseTypes

Indica el tipo de fase de implementación.

rank

integer (int32)

Obtiene y establece la clasificación de la fase de implementación.

refName

string

Obtiene y establece el nombre de referencia de la fase de implementación.

workflowTasks

WorkflowTask[]

Obtiene y establece las tareas de flujo de trabajo para la fase de implementación.

DeployPhaseStatus

Estado de la fase.

Valor Description
canceled

Ejecución de fase cancelada.

cancelling

La fase está en estado de cancelación.

failed

Error de ejecución de fase.

inProgress

Ejecución de fase en curso.

notStarted

No se inició la ejecución de fases.

partiallySucceeded

La ejecución de fases se realizó parcialmente correctamente.

skipped

Ejecución de fase omitida.

succeeded

La ejecución de fases se realizó correctamente.

undefined

Estado de fase no establecido.

DeployPhaseTypes

Indica el tipo de fase de implementación.

Valor Description
agentBasedDeployment

Tipo de fase que contiene tareas ejecutadas en el agente.

deploymentGates

Tipo de fase que contiene tareas que actúan como Puertas para que la implementación avance.

machineGroupBasedDeployment

Tipo de fase que contiene las tareas ejecutadas en las máquinas del grupo de implementación.

runOnServer

Tipo de fase que contiene las tareas ejecutadas por el servidor.

undefined

Tipo de fase no definido. No lo uses.

EnvironmentOptions

Nombre Tipo Description
autoLinkWorkItems

boolean

Obtiene y establece como elementos de trabajo de vínculo automático o no.

badgeEnabled

boolean

Obtiene y establece como distintivo habilitado o no.

publishDeploymentStatus

boolean

Obtiene y establece como estado de implementación de publicación o no.

pullRequestDeploymentEnabled

boolean

Obtiene y establece como la implementación de la solicitud de incorporación de cambios habilitada o no.

EnvironmentStatus

Obtiene el estado del entorno.

Valor Description
canceled

El entorno está en estado cancelado.

inProgress

El entorno está en curso.

notStarted

El entorno no está en estado iniciado.

partiallySucceeded

El entorno está en estado parcialmente correcto.

queued

El entorno está en estado en cola.

rejected

El entorno está en estado rechazado.

scheduled

El entorno está en estado programado.

succeeded

El entorno está en estado correcto.

undefined

Estado del entorno no establecido.

GateStatus

Estado de las puertas de liberación.

Valor Description
canceled

Se canceló la ejecución de la puerta.

failed

Error en la ejecución de la puerta.

inProgress

La puerta está actualmente en curso.

none

La puerta no tiene el estado establecido.

pending

La puerta está en estado pendiente.

succeeded

La puerta se completó correctamente.

IdentityRef

Nombre Tipo Description
_links

ReferenceLinks

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.

IgnoredGate

Nombre Tipo Description
lastModifiedOn

string (date-time)

Obtiene la fecha en la que se omite por última vez la puerta.

name

string

Nombre de la puerta omitida.

Issue

Nombre Tipo Description
data

object

Datos del problema.

issueType

string

Tipo de problema, por ejemplo, error, advertencia o información.

message

string

Mensaje de problema.

ManualIntervention

Nombre Tipo Description
approver

IdentityRef

Obtiene o establece la identidad que debe aprobar.

comments

string

Obtiene o establece comentarios para su aprobación.

createdOn

string (date-time)

Obtiene la fecha en la que se creó.

id

integer (int32)

Obtiene el identificador único para la intervención manual.

instructions

string

Obtiene o establece instrucciones para la aprobación.

modifiedOn

string (date-time)

Obtiene la fecha en la que se modificó.

name

string

Obtiene o establece el nombre.

release

ReleaseShallowReference

Obtiene releaseReference para la intervención manual.

releaseDefinition

ReleaseDefinitionShallowReference

Obtiene releaseDefinitionReference para la intervención manual.

releaseEnvironment

ReleaseEnvironmentShallowReference

Obtiene releaseEnvironmentReference para la intervención manual.

status

ManualInterventionStatus

Obtiene o establece el estado de la intervención manual.

taskInstanceId

string (uuid)

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.

Valor Description
approved

Se aprueba la intervención manual.

canceled

Se cancela la intervención manual.

pending

La intervención manual está pendiente.

rejected

Se rechaza la intervención manual.

unknown

La intervención manual no tiene el estado establecido.

ProcessParameters

Nombre Tipo Description
dataSourceBindings

DataSourceBindingBase[]

Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Nombre Tipo Description
id

string (uuid)

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 un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

Nombre Tipo Description
count

integer (int32)

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.

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.

Release

Nombre Tipo Description
_links

ReferenceLinks

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

IdentityRef

Obtiene o establece la identidad que creó.

createdFor

IdentityRef

Obtiene o establece la identidad para la que se creó la versión.

createdOn

string (date-time)

Obtiene la fecha en la que se creó.

definitionSnapshotRevision

integer (int32)

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

ReleaseEnvironment[]

Obtiene la lista de entornos.

id

integer (int32)

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

IdentityRef

Obtiene o establece la identidad que modificó.

modifiedOn

string (date-time)

Obtiene la fecha en la que se modificó.

name

string

Obtiene el nombre.

poolName

string

Obtiene el nombre del grupo.

projectReference

ProjectReference

Obtiene o establece la referencia del proyecto.

properties

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 un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

reason

ReleaseReason

Obtiene el motivo de la versión.

releaseDefinition

ReleaseDefinitionShallowReference

Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta versión.

releaseDefinitionRevision

integer (int32)

Obtiene o establece la revisión de definición de versión.

releaseNameFormat

string

Obtiene el formato de nombre de versión.

status

ReleaseStatus

Obtiene el estado.

tags

string[]

Obtiene o establece la lista de etiquetas.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Obtiene la lista de grupos de variables.

variables

<string,  ConfigurationVariableValue>

Obtiene o establece el diccionario de variables.

ReleaseApproval

Nombre Tipo Description
approvalType

ApprovalType

Obtiene o establece el tipo de aprobación.

approvedBy

IdentityRef

Obtiene la identidad que ha aprobado.

approver

IdentityRef

Obtiene o establece la identidad que debe aprobar.

attempt

integer (int32)

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 (date-time)

Obtiene la fecha en la que se creó.

history

ReleaseApprovalHistory[]

Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación.

id

integer (int32)

Obtiene el identificador único de este campo.

isAutomated

boolean

Obtiene o establece como aprobación automatizada o no.

modifiedOn

string (date-time)

Obtiene la fecha en la que se modificó.

rank

integer (int32)

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

ReleaseShallowReference

Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación.

releaseDefinition

ReleaseDefinitionShallowReference

Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta aprobación.

releaseEnvironment

ReleaseEnvironmentShallowReference

Obtiene releaseEnvironmentReference que especifica la referencia del entorno de versión al que está asociada esta aprobación.

revision

integer (int32)

Obtiene el número de revisión.

status

ApprovalStatus

Obtiene o establece el estado de la aprobación.

url

string

Obtiene la dirección URL para acceder a la aprobación.

ReleaseApprovalHistory

Nombre Tipo Description
approver

IdentityRef

Identidad del aprobador.

changedBy

IdentityRef

Identidad del objeto que cambió la aprobación.

comments

string

Comentarios del historial de aprobación.

createdOn

string (date-time)

Hora a la que se creó esta aprobación.

modifiedOn

string (date-time)

Hora a la que se modificó esta aprobación.

revision

integer (int32)

Revisión del historial de aprobación.

ReleaseCondition

Nombre Tipo Description
conditionType

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

Resultado de la condición de versión.

value

string

Obtiene o establece el valor de la condición.

ReleaseDefinitionApprovals

Nombre Tipo Description
approvalOptions

ApprovalOptions

Obtiene o establece las opciones de aprobación.

approvals

ReleaseDefinitionApprovalStep[]

Obtiene o establece las aprobaciones.

ReleaseDefinitionApprovalStep

Nombre Tipo Description
approver

IdentityRef

Obtiene y establece el aprobador.

id

integer (int32)

Identificador del paso de aprobación o implementación.

isAutomated

boolean

Indica si la aprobación está automatizada.

isNotificationOn

boolean

Indica si el conjunto de notificaciones de aprobación.

rank

integer (int32)

Obtiene o establece el rango del paso de aprobación.

ReleaseDefinitionGate

Nombre Tipo Description
tasks

WorkflowTask[]

Obtiene o establece el flujo de trabajo de puertas.

ReleaseDefinitionGatesOptions

Nombre Tipo Description
isEnabled

boolean

Obtiene o establece como puertas habilitadas o no.

minimumSuccessDuration

integer (int32)

Obtiene o establece la duración mínima de los resultados estables después de una evaluación correcta de las puertas.

samplingInterval

integer (int32)

Obtiene o establece el tiempo entre la reevaluación de las puertas.

stabilizationTime

integer (int32)

Obtiene o establece el retraso antes de la evaluación.

timeout

integer (int32)

Obtiene o establece el tiempo de espera después del cual se produce un error en las puertas.

ReleaseDefinitionGatesStep

Nombre Tipo Description
gates

ReleaseDefinitionGate[]

Obtiene o establece las puertas.

gatesOptions

ReleaseDefinitionGatesOptions

Obtiene o establece las opciones de puerta.

id

integer (int32)

Identificador de ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Nombre Tipo Description
_links

ReferenceLinks

Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión.

id

integer (int32)

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

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

DeploymentJob[]

Trabajos de implementación de la fase.

errorLog

string

Registros de errores de ejecución de fases.

manualInterventions

ManualIntervention[]

Lista de información de ejecución de tareas de intervención manual en fase.

name

string

Nombre de la fase.

phaseId

string

Identificador de la fase.

phaseType

DeployPhaseTypes

Tipo de la fase.

rank

integer (int32)

Rango de la fase.

runPlanId

string (uuid)

Identificador de plan de ejecución de la fase.

startedOn

string (date-time)

Hora de inicio de la fase.

status

DeployPhaseStatus

Estado de la fase.

ReleaseEnvironment

Nombre Tipo Description
conditions

ReleaseCondition[]

Obtiene la lista de condiciones.

createdOn

string (date-time)

Obtiene la fecha en la que se creó.

definitionEnvironmentId

integer (int32)

Obtiene el identificador del entorno de definición.

deployPhasesSnapshot

DeployPhase[]

Obtiene la lista de instantáneas de implementación de fases.

deploySteps

DeploymentAttempt[]

Obtiene los pasos de implementación.

environmentOptions

EnvironmentOptions

Obtiene las opciones de entorno.

id

integer (int32)

Obtiene el identificador único de este campo.

modifiedOn

string (date-time)

Obtiene la fecha en la que se modificó.

name

string

Obtiene el nombre.

nextScheduledUtcTime

string (date-time)

Obtiene la hora UTC programada siguiente.

owner

IdentityRef

Obtiene la identidad que es propietario del entorno de versión.

postApprovalsSnapshot

ReleaseDefinitionApprovals

Obtiene la lista de instantáneas posteriores a la implementación.

postDeployApprovals

ReleaseApproval[]

Obtiene la lista de aprobaciones posteriores a la implementación.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Después de la implementación, se han cerrado los datos de instantáneas.

preApprovalsSnapshot

ReleaseDefinitionApprovals

Obtiene la lista de instantáneas de aprobaciones de implementación previa.

preDeployApprovals

ReleaseApproval[]

Obtiene la lista de aprobaciones de implementación previa.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Los datos de instantáneas anteriores a la implementación.

processParameters

ProcessParameters

Obtiene los parámetros de proceso.

rank

integer (int32)

Obtiene la clasificación.

release

ReleaseShallowReference

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

IdentityRef

Obtiene la identidad que creó la versión.

releaseDefinition

ReleaseDefinitionShallowReference

Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociado este entorno de versión.

releaseId

integer (int32)

Obtiene el identificador de versión.

scheduledDeploymentTime

string (date-time)

Obtiene la hora de implementación de la programación del entorno de lanzamiento.

schedules

ReleaseSchedule[]

Obtiene la lista de programaciones.

status

EnvironmentStatus

Obtiene el estado del entorno.

timeToDeploy

number (double)

Obtiene el tiempo de implementación.

triggerReason

string

Obtiene el motivo del desencadenador.

variableGroups

VariableGroup[]

Obtiene la lista de grupos de variables.

variables

<string,  ConfigurationVariableValue>

Obtiene el diccionario de variables.

ReleaseEnvironmentShallowReference

Nombre Tipo Description
_links

ReferenceLinks

Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión.

id

integer (int32)

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

DeploymentJob[]

Contiene los detalles del trabajo de puertas de cada evaluación.

id

integer (int32)

Identificador de las puertas de liberación.

ignoredGates

IgnoredGate[]

Lista de puertas ignoradas.

lastModifiedOn

string (date-time)

Hora de la última modificación de Las puertas.

runPlanId

string (uuid)

Identificador del plan de ejecución de las puertas.

stabilizationCompletedOn

string (date-time)

Estabilización de puertas completada fecha y hora.

startedOn

string (date-time)

Hora de inicio de la evaluación de Puertas.

status

GateStatus

Estado de las puertas de liberación.

succeedingSince

string (date-time)

Fecha y hora en la que todas las puertas se ejecutaron correctamente.

ReleaseReason

Obtiene el motivo de la versión.

Valor Description
continuousIntegration

Indica la versión desencadenada por la integración continua.

manual

Indica la versión desencadenada manualmente.

none

Indica el motivo desencadenado por la versión que no se ha establecido.

pullRequest

Indica la versión desencadenada por PullRequest.

schedule

Indica la versión desencadenada por programación.

ReleaseSchedule

Nombre Tipo Description
daysToRelease

ScheduleDays

Días de la semana que se van a publicar.

jobId

string (uuid)

Id. de trabajo de definición de trabajo de Team Foundation.

scheduleOnlyWithChanges

boolean

Marca para determinar si esta programación solo debe liberarse si se ha cambiado el artefacto asociado o se ha cambiado la definición de versión.

startHours

integer (int32)

Hora de zona horaria local que se va a iniciar.

startMinutes

integer (int32)

Minuto de zona horaria local que se va a iniciar.

timeZoneId

string

Identificador de zona horaria de la programación de lanzamiento, como "UTC".

ReleaseShallowReference

Nombre Tipo Description
_links

ReferenceLinks

Obtiene los vínculos a recursos, API y vistas relacionados para la versión.

id

integer (int32)

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 (int32)

Establece el identificador del entorno de definición de versión.

variables

<string,  ConfigurationVariableValue>

Establece la lista de variables de entorno que se van a invalidar en el momento de la implementación.

ReleaseStartMetadata

Nombre Tipo Description
artifacts

ArtifactMetadata[]

Establece la lista de artefactos para crear una versión.

definitionId

integer (int32)

Establece el identificador de definición para crear una versión.

description

string

Establece la descripción para crear una versión.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

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

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 un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

reason

ReleaseReason

Establece el motivo para crear una versión.

variables

<string,  ConfigurationVariableValue>

Establece la lista de variables de versión que se van a invalidar en el momento de la implementación.

ReleaseStatus

Obtiene el estado.

Valor Description
abandoned

El estado de la versión está en abandono.

active

El estado de la versión está activo.

draft

La versión está en estado de borrador.

undefined

Estado de la versión no establecido.

ReleaseTask

Nombre Tipo Description
agentName

string

Nombre del agente en el que se ejecutó la tarea.

finishTime

string (date-time)

Hora de finalización de la tarea de versión.

id

integer (int32)

Id. de la tarea de versión.

issues

Issue[]

Lista de problemas que se produjeron durante la ejecución de la tarea.

lineCount

integer (int64)

Número de líneas que tiene la tarea de liberación del registro.

logUrl

string

Dirección URL de registro de la tarea.

name

string

Nombre de la tarea.

percentComplete

integer (int32)

Precente de ejecución de tareas.

rank

integer (int32)

Rango de la tarea de versión.

resultCode

string

Código de resultado de la tarea.

startTime

string (date-time)

Id. de la tarea de versión.

status

TaskStatus

Estado de la tarea de versión.

task

WorkflowTaskReference

Referencia de tareas de flujo de trabajo.

timelineRecordId

string (uuid)

Id. de registro de escala de tiempo de la tarea de versión.

ScheduleDays

Días de la semana que se van a publicar.

Valor Description
all

Programado en todos los días de la semana.

friday

Programado el viernes.

monday

Programado el lunes.

none

Día programado no establecido.

saturday

Programado el sábado.

sunday

Programado el domingo.

thursday

Programado el jueves.

tuesday

Programado el martes.

wednesday

Programado el miércoles.

SourcePullRequestVersion

Nombre Tipo Description
iterationId

string

Identificador de iteración de solicitud de incorporación de cambios para el que la versión publicará el estado.

pullRequestId

string

Identificador de solicitud de incorporación de cambios para el que la versión publicará el estado.

pullRequestMergedAt

string (date-time)

Fecha y hora de la creación de la combinación de solicitudes de incorporación de cambios. Es necesario mantener el registro de escala de tiempo de las versiones creadas por la solicitud de incorporación de cambios.

sourceBranch

string

Rama de origen de la solicitud de incorporación de cambios.

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.

targetBranch

string

Rama de destino de la solicitud de incorporación de cambios.

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

TaskInputValidation

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

Estado de la tarea de versión.

Valor Description
canceled

Se canceló la ejecución de la tarea.

failed

Error en la ejecución de la tarea.

failure

Error en la ejecución de la tarea.

inProgress

La tarea está actualmente en curso.

partiallySucceeded

La ejecución de la tarea se realizó parcialmente correctamente.

pending

La tarea está en estado pendiente.

skipped

Se omitió la ejecución de la tarea.

succeeded

La tarea se completó correctamente.

success

La tarea se completó correctamente.

unknown

La tarea no tiene establecido el estado.

VariableGroup

Nombre Tipo Description
createdBy

IdentityRef

Obtiene o establece la identidad que creó.

createdOn

string (date-time)

Obtiene la fecha en la que se creó.

description

string

Obtiene o establece la descripción.

id

integer (int32)

Obtiene el identificador único de este campo.

isShared

boolean

Indica si un grupo de variables se comparte con otro proyecto o no.

modifiedBy

IdentityRef

Obtiene o establece la identidad que modificó.

modifiedOn

string (date-time)

Obtiene la fecha en la que se modificó.

name

string

Obtiene o establece el nombre.

providerData

VariableGroupProviderData

Obtiene o establece los datos del proveedor.

type

string

Obtiene o establece el tipo.

variableGroupProjectReferences

VariableGroupProjectReference[]

todas las referencias de proyecto en las que el grupo de variables se comparte con otros proyectos.

variables

<string,  VariableValue>

Obtiene y establece el diccionario de variables.

VariableGroupProjectReference

Una referencia de grupo de variables es una referencia superficial al grupo de variables.

Nombre Tipo Description
description

string

Obtiene o establece la descripción del grupo de variables.

name

string

Obtiene o establece el nombre del grupo de variables.

projectReference

ProjectReference

Obtiene o establece la referencia de proyecto del grupo de variables.

VariableGroupProviderData

VariableValue

Nombre Tipo Description
isReadOnly

boolean

Obtiene o establece si la variable es de solo lectura o no.

isSecret

boolean

Obtiene o establece como la variable es secreta o no.

value

string

Obtiene o establece el valor.

WorkflowTask

Nombre Tipo Description
alwaysRun

boolean

Obtiene o establece como la tarea siempre se ejecuta o no.

condition

string

Obtiene o establece la condición de tarea.

continueOnError

boolean

Obtiene o establece cuando la tarea continúa ejecutándose en caso de error o no.

definitionType

string

Obtiene o establece el tipo de definición de tarea. Ejemplo: 'Agente', DeploymentGroup', 'Server' o 'ServerGate'.

enabled

boolean

Obtiene o establece como la tarea habilitada o no.

environment

object

Obtiene o establece las variables de entorno de tareas.

inputs

object

Obtiene o establece las entradas de la tarea.

name

string

Obtiene o establece el nombre de la tarea.

overrideInputs

object

Obtiene o establece las entradas de invalidación de la tarea.

refName

string

Obtiene o establece el nombre de referencia de la tarea.

retryCountOnTaskFailure

integer (int32)

Obtiene o establece el retryCount de la tarea.

taskId

string (uuid)

Obtiene o establece el identificador de la tarea.

timeoutInMinutes

integer (int32)

Obtiene o establece el tiempo de espera de la tarea.

version

string

Obtiene o establece la versión de la tarea.

WorkflowTaskReference

Nombre Tipo Description
id

string (uuid)

Identificador de tarea.

name

string

Nombre de la tarea.

version

string

Versión de la tarea.