通过

Releases - Create

  • 参考
Service:
Release
API Version:
5.0

创建发布。

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=5.0

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
project
 path True

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 应将其设置为“5.0”才能使用此版本的 API。

请求正文

名称 类型 说明
artifacts

ArtifactMetadata[]

设置项目列表以创建发布。
definitionId

integer

设置定义 ID 以创建发布。
description

string

设置说明以创建发布。
environmentsMetadata

ReleaseStartEnvironmentMetadata[]

设置环境元数据的列表。
isDraft

boolean

设置“true”以在草稿模式下创建发布，否则设置“false”。
manualEnvironments

string[]

将环境列表设置为手动作为条件。
properties

PropertiesCollection

类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
reason

ReleaseReason

设置创建发布的原因。
variables

<string,  ConfigurationVariableValue>

设置在部署时要重写的发布变量的列表。

响应

名称 类型 说明
200 OK

Release

成功的操作

安全性

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

名称 说明
vso.release_execute 授予读取和更新发布项目（包括发布、发布定义和发布部署）的能力，以及将新版本排队的能力。

示例

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

Status code:
200 
{
  "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": {}
}

定义

名称 说明
ApprovalExecutionOrder
ApprovalOptions
ApprovalStatus

获取或设置审批的状态。
ApprovalType

获取或设置审批的类型。
Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
ConditionType

获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase

表示服务终结点请求的数据源绑定。
Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

获取部署的操作状态。
DeploymentReason

获取部署原因。
DeploymentStatus

获取部署的状态。
DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus

获取环境状态。
GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

获取或设置手动干预的状态。
ProcessParameters
ProjectReference
PropertiesCollection

类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
ReferenceLinks

表示 REST 引用链接集合的类。
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason

获取发布原因。
ReleaseSchedule
ReleaseShallowReference
ReleaseStartEnvironmentMetadata
ReleaseStartMetadata
ReleaseStatus

获取状态。
ReleaseTask
ScheduleDays

要发布的星期数
SourcePullRequestVersion
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

名称 类型 说明
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalOptions

名称 类型 说明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

ApprovalStatus

获取或设置审批的状态。

名称 类型 说明
approved

string

canceled

string

pending

string

reassigned

string

rejected

string

skipped

string

undefined

string

ApprovalType

获取或设置审批的类型。

名称 类型 说明
all

string

postDeploy

string

preDeploy

string

undefined

string

Artifact

名称 类型 说明
alias

string

获取或设置别名。
definitionReference

<string,  ArtifactSourceReference>

获取或设置定义引用。 例如{“project”：{“id”：“fed755ea-49c5-4399-acea-fd5b5aa90a6c”，“name”：“myProject”}，“definition”：{“id”：“1”，“name”：“mybuildDefinition”}，“connection”：{“id”：“1”，“name”：“myConnection”}}
isPrimary

boolean

获取或设置项目是否为主要项目。
isRetained

boolean

type

string

获取或设置类型。 其值可以是“Build”、“Jenkins”、“GitHub”、“Nuget”、“Team Build (external) ”、“ExternalTFSBuild”、“Git”、“TFVC”、“ExternalTfsXamlBuild”。

ArtifactMetadata

名称 类型 说明
alias

string

设置项目的别名。
instanceReference

BuildVersion

设置项目的实例引用。 例如，对于生成项目，它是内部版本号。

ArtifactSourceReference

名称 类型 说明
id

string

name

string

AuthorizationHeader

名称 类型 说明
name

string

value

string

BuildVersion

名称 类型 说明
commitMessage

string

definitionId

string

definitionName

string

id

string

isMultiDefinitionType

boolean

name

string

sourceBranch

string

sourcePullRequestVersion

SourcePullRequestVersion

sourceRepositoryId

string

sourceRepositoryType

string

sourceVersion

string

ConditionType

获取或设置条件类型。

名称 类型 说明
artifact

string

条件类型为项目。
environmentState

string

条件类型为环境状态。
event

string

条件类型为事件。
undefined

string

条件类型未定义。

ConfigurationVariableValue

名称 类型 说明
allowOverride

boolean

获取或设置是否可以在部署时重写变量。
isSecret

boolean

获取或设置变量是否为机密。
value

string

获取或设置配置变量的值。

DataSourceBindingBase

表示服务终结点请求的数据源绑定。

名称 类型 说明
callbackContextTemplate

string

此数据源支持的分页格式 (ContinuationToken/SkipTop) 。
callbackRequiredTemplate

string

需要后续调用？
dataSourceName

string

获取或设置数据源的名称。
endpointId

string

获取或设置终结点 ID。
endpointUrl

string

获取或设置服务终结点的 URL。
headers

AuthorizationHeader[]

获取或设置授权标头。
initialContextTemplate

string

定义查询参数的初始值
parameters

object

获取或设置数据源的参数。
resultSelector

string

获取或设置结果选择器。
resultTemplate

string

获取或设置结果模板。
target

string

获取或设置数据源的目标。

Demand

名称 类型 说明
name

string

value

string

DeploymentAttempt

名称 类型 说明
attempt

integer

deploymentId

integer

hasStarted

boolean

指定部署是否已启动
id

integer

issues

Issue[]

与部署相关的所有问题
job

ReleaseTask

lastModifiedBy

IdentityRef

lastModifiedOn

string

operationStatus

DeploymentOperationStatus

postDeploymentGates

ReleaseGates

preDeploymentGates

ReleaseGates

queuedOn

string

reason

DeploymentReason

releaseDeployPhases

ReleaseDeployPhase[]

requestedBy

IdentityRef

requestedFor

IdentityRef

runPlanId

string

status

DeploymentStatus

tasks

ReleaseTask[]

DeploymentJob

名称 类型 说明
job

ReleaseTask

tasks

ReleaseTask[]

DeploymentOperationStatus

获取部署的操作状态。

名称 类型 说明
all

string

部署操作状态为全部。
approved

string

部署操作状态已批准。
canceled

string

部署操作状态已取消。
cancelling

string

部署操作状态正在取消。
deferred

string

部署操作状态延迟。
evaluatingGates

string

部署操作状态为 EvaluatingGates。
gateFailed

string

部署操作状态为 GateFailed。
manualInterventionPending

string

部署操作状态为手动交互挂起。
pending

string

部署操作状态为挂起。
phaseCanceled

string

部署操作状态为阶段取消。
phaseFailed

string

部署操作状态为阶段失败。
phaseInProgress

string

部署操作状态为分阶段执行。
phasePartiallySucceeded

string

部署操作状态为阶段部分成功。
phaseSucceeded

string

部署操作状态为阶段成功。
queued

string

部署操作状态已排队。
queuedForAgent

string

代理的部署操作状态已排队。
queuedForPipeline

string

部署操作状态已排队等待管道。
rejected

string

部署操作状态被拒绝。
scheduled

string

部署操作状态已计划。
undefined

string

部署操作状态未定义。

DeploymentReason

获取部署原因。

名称 类型 说明
automated

string

部署原因是自动化的。
manual

string

部署原因为手动。
none

string

部署原因无。
redeployTrigger

string

部署原因是重新部署Trigger。
scheduled

string

已计划部署原因。

DeploymentStatus

获取部署的状态。

名称 类型 说明
all

string

部署状态为 all。
failed

string

部署状态为“失败”。
inProgress

string

部署状态为“正在进行”。
notDeployed

string

部署状态未部署。
partiallySucceeded

string

部署状态部分成功。
succeeded

string

部署状态为成功。
undefined

string

部署状态未定义。

DeployPhase

名称 类型 说明
name

string

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseStatus

名称 类型 说明
canceled

string

cancelling

string

failed

string

inProgress

string

notStarted

string

partiallySucceeded

string

skipped

string

succeeded

string

undefined

string

DeployPhaseTypes

名称 类型 说明
agentBasedDeployment

string

deploymentGates

string

阶段类型，它包含充当要进行部署的入口的任务。
machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentOptions

名称 类型 说明
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentStatus

获取环境状态。

名称 类型 说明
canceled

string

inProgress

string

notStarted

string

partiallySucceeded

string

queued

string

rejected

string

scheduled

string

succeeded

string

undefined

string

GateStatus

名称 类型 说明
canceled

string

failed

string

inProgress

string

none

string

pending

string

succeeded

string

IdentityRef

名称 类型 说明
_links

ReferenceLinks

此字段包含有关图形主题的零个或多个相关链接。 可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor

string

描述符是在系统运行时引用图形主题的主要方式。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias

string

displayName

string

这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

此 URL 是此图主题的源资源的完整路由。

IgnoredGate

名称 类型 说明
lastModifiedOn

string

获取上次忽略门的日期。
name

string

忽略门的名称。

Issue

名称 类型 说明
data

object

issueType

string

message

string

ManualIntervention

名称 类型 说明
approver

IdentityRef

获取或设置应审批的标识。
comments

string

获取或设置要审批的注释。
createdOn

string

获取创建日期。
id

integer

获取手动干预的唯一标识符。
instructions

string

获取或设置审批指令。
modifiedOn

string

获取修改日期。
name

string

获取或设置名称。
release

ReleaseShallowReference

获取手动干预的 releaseReference。
releaseDefinition

ReleaseDefinitionShallowReference

获取用于手动干预的 releaseDefinitionReference。
releaseEnvironment

ReleaseEnvironmentShallowReference

获取用于手动干预的 releaseEnvironmentReference。
status

ManualInterventionStatus

获取或设置手动干预的状态。
taskInstanceId

string

获取任务实例标识符。
url

string

获取用于访问手动干预的 URL。

ManualInterventionStatus

获取或设置手动干预的状态。

名称 类型 说明
approved

string

手动干预已获批准。
canceled

string

取消手动干预。
pending

string

手动干预处于挂起状态。
rejected

string

手动干预被拒绝。
unknown

string

手动干预未设置状态。

ProcessParameters

名称 类型 说明
dataSourceBindings

DataSourceBindingBase[]

表示服务终结点请求的数据源绑定。
inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

名称 类型 说明
id

string

获取此字段的唯一标识符。
name

string

获取项目的名称。

PropertiesCollection

类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。

名称 类型 说明
count

integer

集合中属性的计数。
item

object

keys

string[]

集合中的键集。
values

string[]

集合中的值集。

表示 REST 引用链接集合的类。

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

Release

名称 类型 说明
_links

ReferenceLinks

获取用于访问发布的链接。
artifacts

Artifact[]

获取或设置项目列表。
comment

string

获取或设置注释。
createdBy

IdentityRef

获取或设置创建者的标识。
createdOn

string

获取创建日期。
definitionSnapshotRevision

integer

获取定义快照的修订号。
description

string

获取或设置发布说明。
environments

ReleaseEnvironment[]

获取环境列表。
id

integer

获取此字段的唯一标识符。
keepForever

boolean

是否从保留策略中排除发布。
logsContainerUrl

string

获取日志容器 URL。
modifiedBy

IdentityRef

获取或设置修改的标识。
modifiedOn

string

获取修改日期。
name

string

获取名称。
poolName

string

获取池名称。
projectReference

ProjectReference

获取或设置项目引用。
properties

PropertiesCollection

类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
reason

ReleaseReason

获取发布原因。
releaseDefinition

ReleaseDefinitionShallowReference

获取 releaseDefinitionReference，它指定与此版本关联的发布定义的引用。
releaseNameFormat

string

获取发布名称格式。
status

ReleaseStatus

获取状态。
tags

string[]

获取或设置标记列表。
triggeringArtifactAlias

string

variableGroups

VariableGroup[]

获取变量组的列表。
variables

<string,  ConfigurationVariableValue>

获取或设置变量的字典。

ReleaseApproval

名称 类型 说明
approvalType

ApprovalType

获取或设置审批类型。
approvedBy

IdentityRef

获取批准者的标识。
approver

IdentityRef

获取或设置应批准的标识。
attempt

integer

获取或设置尝试，指定其所属的部署尝试。
comments

string

获取或设置要审批的注释。
createdOn

string

获取创建日期。
history

ReleaseApprovalHistory[]

获取指定与此审批关联的所有审批的历史记录。
id

integer

获取此字段的唯一标识符。
isAutomated

boolean

获取或设置，因为审批是否自动。
isNotificationOn

boolean

modifiedOn

string

获取修改日期。
rank

integer

获取或设置指定审批顺序的排名。 例如，同一级别表示并行审批。
release

ReleaseShallowReference

获取 releaseReference，它指定此审批关联的版本的引用。
releaseDefinition

ReleaseDefinitionShallowReference

获取 releaseDefinitionReference，它指定与此审批关联的发布定义的引用。
releaseEnvironment

ReleaseEnvironmentShallowReference

获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision

integer

获取修订号。
status

ApprovalStatus

获取或设置审批的状态。
trialNumber

integer

url

string

获取用于访问审批的 URL。

ReleaseApprovalHistory

名称 类型 说明
approver

IdentityRef

changedBy

IdentityRef

comments

string

createdOn

string

modifiedOn

string

revision

integer

ReleaseCondition

名称 类型 说明
conditionType

ConditionType

获取或设置条件类型。
name

string

获取或设置条件的名称。 例如“ReleaseStarted”。
result

boolean

value

string

获取或设置条件的值。

ReleaseDefinitionApprovals

名称 类型 说明
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

名称 类型 说明
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionGate

名称 类型 说明
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

名称 类型 说明
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

名称 类型 说明
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

ReleaseDefinitionShallowReference

名称 类型 说明
_links

ReferenceLinks

获取指向发布定义的相关资源、API 和视图的链接。
id

integer

获取发布定义的唯一标识符。
name

string

获取或设置发布定义的名称。
path

string

获取或设置发布定义的路径。
projectReference

ProjectReference

获取或设置项目引用。
url

string

获取用于访问发布定义的 REST API URL。

ReleaseDeployPhase

名称 类型 说明
deploymentJobs

DeploymentJob[]

errorLog

string

id

integer

manualInterventions

ManualIntervention[]

name

string

phaseId

string

phaseType

DeployPhaseTypes

rank

integer

runPlanId

string

startedOn

string

阶段开始时间
status

DeployPhaseStatus

ReleaseEnvironment

名称 类型 说明
conditions

ReleaseCondition[]

获取条件列表。
createdOn

string

获取创建日期。
definitionEnvironmentId

integer

获取定义环境 ID。
demands

Demand[]

获取需求。
deployPhasesSnapshot

DeployPhase[]

获取快照部署阶段的列表。
deploySteps

DeploymentAttempt[]

获取部署步骤。
environmentOptions

EnvironmentOptions

获取环境选项。
id

integer

获取此字段的唯一标识符。
modifiedOn

string

获取修改日期。
name

string

获取名称。
nextScheduledUtcTime

string

获取下一个计划的 UTC 时间。
owner

IdentityRef

获取发布环境的所有者标识。
postApprovalsSnapshot

ReleaseDefinitionApprovals

获取快照部署后审批的列表。
postDeployApprovals

ReleaseApproval[]

获取部署后审批的列表。
postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

preApprovalsSnapshot

ReleaseDefinitionApprovals

获取预部署审批快照的列表。
preDeployApprovals

ReleaseApproval[]

获取预部署审批的列表。
preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

获取进程参数。
queueId

integer

获取队列 ID。
rank

integer

获取排名。
release

ReleaseShallowReference

获取发布引用，该引用指定与此发布环境关联的发布的引用。
releaseCreatedBy

IdentityRef

获取创建发布的标识。
releaseDefinition

ReleaseDefinitionShallowReference

获取 releaseDefinitionReference，它指定与此发布环境关联的发布定义的引用。
releaseDescription

string

获取发布说明。
releaseId

integer

获取发布 ID。
scheduledDeploymentTime

string

获取发布环境的计划部署时间。
schedules

ReleaseSchedule[]

获取计划列表。
status

EnvironmentStatus

获取环境状态。
timeToDeploy

number

获取部署时间。
triggerReason

string

获取触发器原因。
variableGroups

VariableGroup[]

获取变量组的列表。
variables

<string,  ConfigurationVariableValue>

获取变量的字典。
workflowTasks

WorkflowTask[]

获取工作流任务的列表。

ReleaseEnvironmentShallowReference

名称 类型 说明
_links

ReferenceLinks

获取指向发布环境的相关资源、API 和视图的链接。
id

integer

获取发布环境的唯一标识符。
name

string

获取或设置发布环境的名称。
url

string

获取用于访问发布环境的 REST API URL。

ReleaseGates

名称 类型 说明
deploymentJobs

DeploymentJob[]

id

integer

ignoredGates

IgnoredGate[]

lastModifiedOn

string

runPlanId

string

stabilizationCompletedOn

string

startedOn

string

status

GateStatus

succeedingSince

string

ReleaseReason

获取发布原因。

名称 类型 说明
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseSchedule

名称 类型 说明
daysToRelease

ScheduleDays

要发布的一周中的天数
jobId

string

Team Foundation 作业定义作业 ID
startHours

integer

要开始的本地时区小时数
startMinutes

integer

要开始的本地时区分钟数
timeZoneId

string

发布计划的时区 ID，例如“UTC”

ReleaseShallowReference

名称 类型 说明
_links

ReferenceLinks

获取指向发布的相关资源、API 和视图的链接。
id

integer

获取发布的唯一标识符。
name

string

获取或设置发布的名称。
url

string

获取用于访问发布的 REST API URL。

ReleaseStartEnvironmentMetadata

名称 类型 说明
definitionEnvironmentId

integer

设置发布定义环境 ID。
variables

<string,  ConfigurationVariableValue>

设置在部署时要重写的环境变量的列表。

ReleaseStartMetadata

名称 类型 说明
artifacts

ArtifactMetadata[]

设置项目列表以创建发布。
definitionId

integer

设置定义 ID 以创建发布。
description

string

设置说明以创建发布。
environmentsMetadata

ReleaseStartEnvironmentMetadata[]

设置环境元数据的列表。
isDraft

boolean

设置“true”以在草稿模式下创建发布，否则为“false”。
manualEnvironments

string[]

将环境列表设置为手动作为条件。
properties

PropertiesCollection

类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
reason

ReleaseReason

设置创建发布的原因。
variables

<string,  ConfigurationVariableValue>

设置在部署时要重写的发布变量的列表。

ReleaseStatus

获取状态。

名称 类型 说明
abandoned

string

active

string

draft

string

undefined

string

ReleaseTask

名称 类型 说明
agentName

string

finishTime

string

id

integer

issues

Issue[]

lineCount

integer

logUrl

string

name

string

percentComplete

integer

rank

integer

resultCode

string

startTime

string

status

TaskStatus

task

WorkflowTaskReference

timelineRecordId

string

ScheduleDays

要发布的星期数

名称 类型 说明
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

SourcePullRequestVersion

名称 类型 说明
pullRequestId

string

发布将发布状态的拉取请求 ID
pullRequestMergedAt

string

sourceBranchCommitId

string

发布将对其发布状态的拉取请求的源分支提交 ID

TaskInputDefinitionBase

名称 类型 说明
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

名称 类型 说明
expression

string

条件表达式
message

string

说明用户在验证失败时如何更正的消息

TaskSourceDefinitionBase

名称 类型 说明
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

TaskStatus

名称 类型 说明
canceled

string

failed

string

failure

string

inProgress

string

partiallySucceeded

string

pending

string

skipped

string

succeeded

string

success

string

unknown

string

VariableGroup

名称 类型 说明
createdBy

IdentityRef

获取或设置创建者的标识。
createdOn

string

获取创建日期。
description

string

获取或设置说明。
id

integer

获取此字段的唯一标识符。
isShared

boolean

表示变量组是否与其他项目共享。
modifiedBy

IdentityRef

获取或设置修改的标识。
modifiedOn

string

获取修改日期。
name

string

获取或设置名称。
providerData

VariableGroupProviderData

获取或设置提供程序数据。
type

string

获取或设置类型。
variables

<string,  VariableValue>

VariableGroupProviderData

VariableValue

名称 类型 说明
isSecret

boolean

value

string

WorkflowTask

名称 类型 说明
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

名称 类型 说明
id

string

name

string

version

string