Releases - Create

参考

Service:: Release

API Version:: 7.1-preview.8

创建发布。

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.8”才能使用此版本的 API。

请求正文

名称	类型	说明
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>	设置在部署时要重写的发布变量的列表。

响应

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

HTTP

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

{
  "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://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": {}
}

定义

名称	说明
ApprovalExecutionOrder	审批执行顺序。
ApprovalOptions
ApprovalStatus	获取或设置审批的状态。
ApprovalType	获取或设置审批的类型。
Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
ConditionType	获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
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
VariableGroupProjectReference	变量组引用是对变量组的浅表引用。
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

审批执行顺序。

名称	类型	说明
afterGatesAlways	string	执行入口后始终显示审批。
afterSuccessfulGates	string	成功执行入口后显示的审批。
beforeGates	string	在入口前显示的审批。

ApprovalOptions

名称	类型	说明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	指定如果同一审批者批准上一阶段，是否可以跳过审批。
enforceIdentityRevalidation	boolean	指定在完成审批之前是否重新验证审批者的标识。
executionOrder	ApprovalExecutionOrder	审批执行顺序。
releaseCreatorCanBeApprover	boolean	指定请求发布或部署的用户是否应允许审批者。
requiredApproverCount	integer	推进发布所需的审批数。 “0”表示需要的所有审批。
timeoutInMinutes	integer	审批超时。审批默认超时为 30 天。允许的最大超时时间为 365 天。 “0”表示默认超时，即 30 天。

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	项目源的 ID。
name	string	项目源的名称。

AuthorizationHeader

名称	类型	说明
name	string
value	string

BuildVersion

名称	类型	说明
commitMessage	string	获取或设置项目的提交消息。
definitionId	string	获取或设置定义 ID。
definitionName	string	获取或设置定义名称。
id	string	获取或设置生成 ID。
isMultiDefinitionType	boolean	获取或设置项目是否支持多个定义。
name	string	获取或设置内部版本号。
sourceBranch	string	获取或设置项目的源分支。
sourcePullRequestVersion	SourcePullRequestVersion	获取或设置项目的源拉取请求版本。
sourceRepositoryId	string	获取或设置项目的存储库 ID。
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	获取或设置数据源的参数。
requestContent	string	获取或设置 http 请求正文
requestVerb	string	获取或设置 http 请求谓词
resultSelector	string	获取或设置结果选择器。
resultTemplate	string	获取或设置结果模板。
target	string	获取或设置数据源的目标。

DeploymentAttempt

名称	类型	说明
attempt	integer	部署尝试。
deploymentId	integer	部署的 ID。
hasStarted	boolean	指定部署是否已启动。
id	integer	部署的 ID。
issues	Issue[]	与部署相关的所有问题。
lastModifiedBy	IdentityRef	上次修改此部署的标识。
lastModifiedOn	string	上次修改此部署的时间。
operationStatus	DeploymentOperationStatus	部署操作状态。
postDeploymentGates	ReleaseGates	在此部署中执行的部署后入口。
preDeploymentGates	ReleaseGates	在此部署中执行的预部署入口。
queuedOn	string	此部署排队时。
reason	DeploymentReason	部署原因。
releaseDeployPhases	ReleaseDeployPhase[]	在此部署中执行的发布部署阶段的列表。
requestedBy	IdentityRef	请求此部署的标识。
requestedFor	IdentityRef	请求的此部署的标识。
status	DeploymentStatus	部署的状态。

DeploymentJob

名称	类型	说明
job	ReleaseTask	所有已执行任务的父任务。
tasks	ReleaseTask[]	作业中已执行的任务的列表。

DeploymentOperationStatus

获取部署的操作状态。

名称	类型	说明
all	string	部署操作状态为 all。
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	部署原因是 RedeployTrigger。
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	获取并设置为是否启用锁屏提醒。
publishDeploymentStatus	boolean	获取和设置是否为发布部署状态。
pullRequestDeploymentEnabled	boolean	获取并设置为。拉取请求部署是否已启用。

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	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
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[]	集合中的值集。

ReferenceLinks

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

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

Release

名称	类型	说明
_links	ReferenceLinks	获取用于访问发布的链接。
artifacts	Artifact[]	获取或设置项目列表。
comment	string	获取或设置注释。
createdBy	IdentityRef	获取或设置创建者的标识。
createdFor	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，它指定与此版本关联的发布定义的引用。
releaseDefinitionRevision	integer	获取或设置发布定义修订。
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	获取或设置为是否自动审批。
modifiedOn	string	获取修改日期。
rank	integer	获取或设置指定审批顺序的排名。例如，同一排名表示并行审批。
release	ReleaseShallowReference	获取 releaseReference，它指定此审批关联的发布的引用。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定此审批关联的发布定义的引用。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision	integer	获取修订号。
status	ApprovalStatus	获取或设置审批的状态。
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	审批或部署步骤的 ID。
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	ReleaseDefinitionGateStep 的 ID。

ReleaseDefinitionShallowReference

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
id	integer	获取发布定义的唯一标识符。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
url	string	获取用于访问发布定义的 REST API URL。

ReleaseDeployPhase

名称	类型	说明
deploymentJobs	DeploymentJob[]	阶段的部署作业。
errorLog	string	阶段执行错误日志。
manualInterventions	ManualIntervention[]	分阶段手动干预任务执行信息的列表。
name	string	阶段的名称。
phaseId	string	阶段的 ID。
phaseType	DeployPhaseTypes	阶段的类型。
rank	integer	阶段的排名。
runPlanId	string	运行阶段的计划 ID。
startedOn	string	阶段开始时间。
status	DeployPhaseStatus	阶段的状态。

ReleaseEnvironment

名称	类型	说明
conditions	ReleaseCondition[]	获取条件列表。
createdOn	string	获取创建日期。
definitionEnvironmentId	integer	获取定义环境 ID。
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	获取进程参数。
rank	integer	获取排名。
release	ReleaseShallowReference	获取发布引用，该引用指定与此发布环境关联的发布的引用。
releaseCreatedBy	IdentityRef	获取创建发布的标识。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此发布环境关联的发布定义的引用。
releaseId	integer	获取发布 ID。
scheduledDeploymentTime	string	获取发布环境的计划部署时间。
schedules	ReleaseSchedule[]	获取计划列表。
status	EnvironmentStatus	获取环境状态。
timeToDeploy	number	获取部署时间。
triggerReason	string	获取触发器原因。
variableGroups	VariableGroup[]	获取变量组的列表。
variables	<string, ConfigurationVariableValue>	获取变量的字典。

ReleaseEnvironmentShallowReference

名称	类型	说明
_links	ReferenceLinks	获取指向发布环境的相关资源、API 和视图的链接。
id	integer	获取发布环境的唯一标识符。
name	string	获取或设置发布环境的名称。
url	string	获取用于访问发布环境的 REST API URL。

ReleaseGates

名称	类型	说明
deploymentJobs	DeploymentJob[]	包含每个评估的入口作业详细信息。
id	integer	发布入口的 ID。
ignoredGates	IgnoredGate[]	忽略的门的列表。
lastModifiedOn	string	盖茨上次修改时间。
runPlanId	string	运行入口的计划 ID。
stabilizationCompletedOn	string	盖茨稳定完成日期和时间。
startedOn	string	盖茨评估开始时间。
status	GateStatus	发布入口的状态。
succeedingSince	string	成功执行所有门的日期和时间。

ReleaseReason

获取发布原因。

名称	类型	说明
continuousIntegration	string	指示由持续集成触发的发布。
manual	string	指示手动触发的发布。
none	string	指示未设置发布触发的原因。
pullRequest	string	指示 PullRequest 触发的发布。
schedule	string	指示计划触发的发布。

ReleaseSchedule

名称	类型	说明
daysToRelease	ScheduleDays	要发布的星期数。
jobId	string	Team Foundation 作业定义作业 ID。
scheduleOnlyWithChanges	boolean	用于确定此计划是否仅在关联的项目已更改或发布定义发生更改时发布。
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	发布任务的 ID。
issues	Issue[]	执行任务时发生的问题列表。
lineCount	integer	日志发布任务具有的行数。
logUrl	string	任务的日志 URL。
name	string	任务的名称。
percentComplete	integer	任务执行完成准备。
rank	integer	发布任务的排名。
resultCode	string	任务的结果代码。
startTime	string	发布任务的 ID。
status	TaskStatus	发布任务的状态。
task	WorkflowTaskReference	工作流任务参考。
timelineRecordId	string	发布任务的时间线记录 ID。

ScheduleDays

要发布的星期数。

名称	类型	说明
all	string	计划于一周中的所有日期。
friday	string	计划于星期五。
monday	string	计划于星期一。
none	string	未设置计划日期。
saturday	string	计划于星期六。
sunday	string	计划于星期日。
thursday	string	计划于星期四。
tuesday	string	计划于星期二。
wednesday	string	计划于星期三。

SourcePullRequestVersion

名称	类型	说明
iterationId	string	发布将对其发布状态的拉取请求迭代 ID。
pullRequestId	string	发布将对其发布状态的拉取请求 ID。
pullRequestMergedAt	string	创建拉取请求合并的日期和时间。需要保留时间线拉取请求创建的版本的记录。
sourceBranch	string	拉取请求的源分支。
sourceBranchCommitId	string	发布将对其发布状态的拉取请求的源分支提交 ID。
targetBranch	string	拉取请求的目标分支。

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	获取或设置类型。
variableGroupProjectReferences	VariableGroupProjectReference[]	变量组与其他项目共享的所有项目引用。
variables	<string, VariableValue>	获取并设置变量的字典。

VariableGroupProjectReference

变量组引用是对变量组的浅表引用。

名称	类型	说明
description	string	获取或设置变量组的说明。
name	string	获取或设置变量组的名称。
projectReference	ProjectReference	获取或设置变量组的项目引用。

VariableGroupProviderData

VariableValue

名称	类型	说明
isReadOnly	boolean	获取或设置变量是否为只读。
isSecret	boolean	获取或设置变量是否为机密。
value	string	获取或设置值。

WorkflowTask

名称	类型	说明
alwaysRun	boolean	获取或设置为任务始终运行或不运行。
condition	string	获取或设置任务条件。
continueOnError	boolean	获取或设置当任务在出错时是否继续运行。
definitionType	string	获取或设置任务定义类型。示例：- “Agent”、“DeploymentGroup”、“Server”或“ServerGate”。
enabled	boolean	获取或设置为已启用或未启用的任务。
environment	object	获取或设置任务环境变量。
inputs	object	获取或设置任务输入。
name	string	获取或设置任务的名称。
overrideInputs	object	获取或设置任务替代输入。
refName	string	获取或设置任务的引用名称。
retryCountOnTaskFailure	integer	获取或设置任务 retryCount。
taskId	string	获取或设置任务的 ID。
timeoutInMinutes	integer	获取或设置任务超时。
version	string	获取或设置任务的版本。

WorkflowTaskReference

名称	类型	说明
id	string	任务标识符。
name	string	任务的名称。
version	string	任务的版本。

通过