Releases - Update Release
Обновите полный объект выпуска.
PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1-preview.8Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Название организации Azure DevOps. |
|
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
|
release
|
path | True |
integer int32 |
Идентификатор выпуска для обновления. |
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.8. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| _links |
Получает ссылки для доступа к выпуску. |
|
| artifacts |
Artifact[] |
Возвращает или задает список артефактов. |
| comment |
string |
Возвращает или задает комментарий. |
| createdBy |
Возвращает или задает созданное удостоверение. |
|
| createdFor |
Возвращает или задает удостоверение, для которого был создан выпуск. |
|
| createdOn |
string |
Возвращает дату создания. |
| definitionSnapshotRevision |
integer |
Возвращает номер редакции snapshot определения. |
| description |
string |
Возвращает или задает описание выпуска. |
| environments |
Возвращает список сред. |
|
| id |
integer |
Возвращает уникальный идентификатор этого поля. |
| keepForever |
boolean |
Следует ли исключить выпуск из политик хранения. |
| logsContainerUrl |
string |
Возвращает URL-адрес контейнера журналов. |
| modifiedBy |
Возвращает или задает удостоверение, изменяющее. |
|
| modifiedOn |
string |
Возвращает дату изменения. |
| name |
string |
Возвращает имя. |
| poolName |
string |
Возвращает имя пула. |
| projectReference |
Возвращает или задает ссылку на проект. |
|
| properties |
Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с |
|
| reason |
Возвращает причину выпуска. |
|
| releaseDefinition |
Возвращает releaseDefinitionReference, указывающий ссылку на определение выпуска, с которым связан этот выпуск. |
|
| releaseDefinitionRevision |
integer |
Возвращает или задает редакцию определения выпуска. |
| releaseNameFormat |
string |
Возвращает формат имени выпуска. |
| status |
Возвращает состояние. |
|
| tags |
string[] |
Возвращает или задает список тегов. |
| triggeringArtifactAlias |
string |
|
| variableGroups |
Возвращает список групп переменных. |
|
| variables |
<string,
Configuration |
Возвращает или задает словарь переменных. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
успешная операция |
Безопасность
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 | Предоставляет возможность чтения и обновления артефактов выпуска, включая папки, выпуски, определения выпусков и среду выпуска, а также возможность ставить новый выпуск в очередь. |
Примеры
Update the release
Sample Request
PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1-preview.8
{
"id": 39,
"name": "Release-1",
"status": "active",
"createdOn": "2018-12-10T12:43:34.223Z",
"modifiedOn": "2018-12-10T12:43:34.223Z",
"modifiedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"createdBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"environments": [
{
"id": 39,
"releaseId": 39,
"name": "PROD",
"status": "notStarted",
"variables": {},
"variableGroups": [],
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMinutes": 0,
"executionOrder": "beforeGates"
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 21,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false,
"badgeEnabled": false,
"autoLinkWorkItems": false,
"pullRequestDeploymentEnabled": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {
"downloadInputs": []
},
"queueId": 0,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": []
}
],
"owner": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"schedules": [],
"release": {
"id": 39,
"name": "Release-1",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
}
}
},
"releaseDefinition": {
"id": 21,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
}
}
},
"releaseCreatedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"triggerReason": "Manual",
"preDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
}
}
],
"variables": {
"NonSecretVariable": {
"value": "NonSecretValue"
},
"System.Debug": {
"value": "false",
"allowOverride": true
}
},
"variableGroups": [],
"artifacts": [],
"releaseDefinition": {
"id": 21,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
},
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(Rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 1,
"logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
},
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
}
},
"tags": [],
"triggeringArtifactAlias": null,
"projectReference": {
"id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
"name": null
},
"properties": {}
}
Sample Response
{
"id": 39,
"name": "Release-1",
"status": "active",
"createdOn": "2018-12-10T12:43:34.223Z",
"modifiedOn": "2018-12-10T12:43:36.537Z",
"modifiedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"createdBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"environments": [
{
"id": 39,
"releaseId": 39,
"name": "PROD",
"status": "notStarted",
"variables": {},
"variableGroups": [],
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMinutes": 0,
"executionOrder": "beforeGates"
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 21,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false,
"badgeEnabled": false,
"autoLinkWorkItems": false,
"pullRequestDeploymentEnabled": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {
"downloadInputs": []
},
"queueId": 0,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"refName": null,
"workflowTasks": []
}
],
"owner": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"schedules": [],
"release": {
"id": 39,
"name": "Release-1",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
}
}
},
"releaseDefinition": {
"id": 21,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
}
}
},
"releaseCreatedBy": {
"displayName": "Chuck Reinhart",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
}
},
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
"uniqueName": "fabfiber@outlook.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
"descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
},
"triggerReason": "Manual",
"preDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGatesSnapshot": {
"id": 0,
"gatesOptions": null,
"gates": []
}
}
],
"variables": {
"NonSecretVariable": {
"value": "NonSecretValue"
},
"System.Debug": {
"value": "false",
"allowOverride": true
}
},
"variableGroups": [],
"artifacts": [],
"releaseDefinition": {
"id": 21,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
},
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(Rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 2,
"logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
},
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
}
},
"tags": [],
"triggeringArtifactAlias": null,
"projectReference": {
"id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
"name": null
},
"properties": {}
}Определения
| Имя | Описание |
|---|---|
|
Approval |
Порядок выполнения утверждений. |
|
Approval |
|
|
Approval |
Возвращает или задает состояние утверждения. |
|
Approval |
Возвращает или задает тип утверждения. |
| Artifact | |
|
Artifact |
|
|
Authorization |
|
|
Condition |
Возвращает или задает тип условия. |
|
Configuration |
|
|
Data |
Представляет привязку источника данных для запроса конечной точки службы. |
|
Deployment |
|
|
Deployment |
|
|
Deployment |
Возвращает состояние операции развертывания. |
|
Deployment |
Возвращает причину развертывания. |
|
Deployment |
Возвращает состояние развертывания. |
|
Deploy |
|
|
Deploy |
Состояние этапа. |
|
Deploy |
Указывает тип этапа развертывания. |
|
Environment |
|
|
Environment |
Возвращает состояние среды. |
|
Gate |
Состояние шлюзов выпуска. |
|
Identity |
|
|
Ignored |
|
| Issue | |
|
Manual |
|
|
Manual |
Возвращает или задает состояние ручного вмешательства. |
|
Process |
|
|
Project |
|
|
Properties |
Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с |
|
Reference |
Класс, представляющий коллекцию ссылок REST. |
| Release | |
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
Возвращает причину выпуска. |
|
Release |
|
|
Release |
|
|
Release |
Возвращает состояние. |
|
Release |
|
|
Schedule |
Дни недели для выпуска. |
|
Task |
|
|
Task |
|
|
Task |
|
|
Task |
Состояние задачи выпуска. |
|
Variable |
|
|
Variable |
Ссылка на группу переменных — это неглубокая ссылка на группу переменных. |
|
Variable |
|
|
Variable |
|
|
Workflow |
|
|
Workflow |
ApprovalExecutionOrder
Порядок выполнения утверждений.
| Имя | Тип | Описание |
|---|---|---|
| afterGatesAlways |
string |
Утверждения отображаются всегда после выполнения шлюзов. |
| afterSuccessfulGates |
string |
Утверждения, отображаемые после успешного выполнения шлюзов. |
| beforeGates |
string |
Утверждения, отображаемые перед шлюзами. |
ApprovalOptions
| Имя | Тип | Описание |
|---|---|---|
| autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Укажите, можно ли пропустить утверждение, если тот же утверждающий одобрил предыдущий этап. |
| enforceIdentityRevalidation |
boolean |
Укажите, следует ли повторно проверить удостоверение утверждающего перед завершением утверждения. |
| executionOrder |
Порядок выполнения утверждений. |
|
| 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,
Artifact |
Возвращает или задает ссылку на определение. Например, {"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". |
ArtifactSourceReference
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор источника артефакта. |
| name |
string |
Имя источника артефакта. |
AuthorizationHeader
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
|
| value |
string |
ConditionType
Возвращает или задает тип условия.
| Имя | Тип | Описание |
|---|---|---|
| artifact |
string |
Тип условия — artifact. |
| environmentState |
string |
Тип условия — состояние среды. |
| event |
string |
Тип условия — event. |
| undefined |
string |
Тип условия не определен. |
ConfigurationVariableValue
| Имя | Тип | Описание |
|---|---|---|
| allowOverride |
boolean |
Возвращает и задает значение , если переменную можно переопределить во время развертывания. |
| isSecret |
boolean |
Возвращает или задает значение , так как переменная является секретной или нет. |
| value |
string |
Возвращает и задает значение переменной конфигурации. |
DataSourceBindingBase
Представляет привязку источника данных для запроса конечной точки службы.
| Имя | Тип | Описание |
|---|---|---|
| callbackContextTemplate |
string |
Формат разбиения на страницы, поддерживаемый этим источником данных (ContinuationToken/SkipTop). |
| callbackRequiredTemplate |
string |
Нужны последующие звонки? |
| dataSourceName |
string |
Возвращает или задает имя источника данных. |
| endpointId |
string |
Возвращает или задает идентификатор конечной точки. |
| endpointUrl |
string |
Возвращает или задает URL-адрес конечной точки службы. |
| headers |
Возвращает или задает заголовки авторизации. |
|
| initialContextTemplate |
string |
Определяет начальное значение параметров запроса. |
| parameters |
object |
Возвращает или задает параметры для источника данных. |
| requestContent |
string |
Возвращает или задает текст HTTP-запроса. |
| requestVerb |
string |
Возвращает или задает команду HTTP-запроса. |
| resultSelector |
string |
Возвращает или задает селектор результатов. |
| resultTemplate |
string |
Возвращает или задает шаблон результата. |
| target |
string |
Возвращает или задает целевой объект источника данных. |
DeploymentAttempt
| Имя | Тип | Описание |
|---|---|---|
| attempt |
integer |
Попытка развертывания. |
| deploymentId |
integer |
Идентификатор развертывания. |
| hasStarted |
boolean |
Указывает, было ли запущено развертывание. |
| id |
integer |
Идентификатор развертывания. |
| issues |
Issue[] |
Все проблемы, связанные с развертыванием. |
| lastModifiedBy |
Идентификатор, который последним изменял это развертывание. |
|
| lastModifiedOn |
string |
Время последнего изменения этого развертывания. |
| operationStatus |
Состояние операции развертывания. |
|
| postDeploymentGates |
Шлюзы после развертывания, выполненные в этом развертывании. |
|
| preDeploymentGates |
Шлюзы перед развертыванием, выполненные в этом развертывании. |
|
| queuedOn |
string |
Когда это развертывание поставлено в очередь. |
| reason |
Причина развертывания. |
|
| releaseDeployPhases |
Список фаз развертывания выпуска, выполняемых в этом развертывании. |
|
| requestedBy |
Идентификатор, запрашивавший это развертывание. |
|
| requestedFor |
Запрошено удостоверение для этого развертывания. |
|
| status |
состояние развертывания. |
DeploymentJob
| Имя | Тип | Описание |
|---|---|---|
| job |
Родительская задача всех выполненных задач. |
|
| tasks |
Список выполненных задач с параметром в задании. |
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 |
Причина развертывания — DeploymentTrigger. |
| scheduled |
string |
Причина развертывания запланирована. |
DeploymentStatus
Возвращает состояние развертывания.
| Имя | Тип | Описание |
|---|---|---|
| all |
string |
Состояние развертывания — все. |
| failed |
string |
Состояние развертывания не выполнено. |
| inProgress |
string |
Состояние развертывания выполняется. |
| notDeployed |
string |
Состояние развертывания не развернуто. |
| partiallySucceeded |
string |
Состояние развертывания частично задано. |
| succeeded |
string |
Состояние развертывания выполнено успешно. |
| undefined |
string |
Состояние развертывания не определено. |
DeployPhase
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Возвращает и задает имя этапа развертывания. |
| phaseType |
Указывает тип этапа развертывания. |
|
| rank |
integer |
Возвращает и задает ранг этапа развертывания. |
| refName |
string |
Возвращает и задает имя ссылки этапа развертывания. |
| workflowTasks |
Возвращает и задает задачи рабочего процесса для этапа развертывания. |
DeployPhaseStatus
Состояние этапа.
| Имя | Тип | Описание |
|---|---|---|
| canceled |
string |
Выполнение этапа отменено. |
| cancelling |
string |
Этап находится в состоянии отмены. |
| failed |
string |
Сбой выполнения этапа. |
| inProgress |
string |
Выполняется этап. |
| notStarted |
string |
Этап выполнения не запущен. |
| partiallySucceeded |
string |
Выполнение этапа частично выполнено. |
| skipped |
string |
Этап выполнения пропущен. |
| succeeded |
string |
Этап выполнения выполнен успешно. |
| undefined |
string |
Состояние фазы не задано. |
DeployPhaseTypes
Указывает тип этапа развертывания.
| Имя | Тип | Описание |
|---|---|---|
| agentBasedDeployment |
string |
Тип Phase, содержащий задачи, выполняемые в агенте. |
| deploymentGates |
string |
Тип этапа, содержащий задачи, которые действуют как шлюзы для развертывания, чтобы идти вперед. |
| machineGroupBasedDeployment |
string |
Тип Phase, содержащий задачи, выполняемые на компьютерах группы развертывания. |
| runOnServer |
string |
Тип Phase, содержащий задачи, выполняемые сервером. |
| 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 |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
| descriptor |
string |
Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях. |
| directoryAlias |
string |
Нерекомендуемый — можно получить, запросив пользователя Graph, на который ссылается запись self словаря IdentityRef _links. |
| displayName |
string |
Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника. |
| id |
string |
|
| imageUrl |
string |
Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links" |
| inactive |
boolean |
Не рекомендуется — можно получить, запросив состояние членства Graph, указанное в записи membershipState словаря GraphUser _links. |
| isAadIdentity |
boolean |
Не рекомендуется — может выводиться из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType). |
| isContainer |
boolean |
Не рекомендуется — может выводиться из типа субъекта дескриптора (Descriptor.IsGroupType). |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Нерекомендуемый — не используется в большинстве уже существовающих реализаций ToIdentityRef. |
| uniqueName |
string |
Нерекомендуемый — используйте вместо этого домен+имя_субъекта |
| url |
string |
Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа. |
IgnoredGate
| Имя | Тип | Описание |
|---|---|---|
| lastModifiedOn |
string |
Возвращает дату последнего пропуска шлюза. |
| name |
string |
Имя шлюза игнорируется. |
Issue
| Имя | Тип | Описание |
|---|---|---|
| data |
object |
Данные о проблемах. |
| issueType |
string |
Тип проблемы, например ошибка, предупреждение или сведения. |
| message |
string |
Сообщение о проблеме. |
ManualIntervention
| Имя | Тип | Описание |
|---|---|---|
| approver |
Возвращает или задает удостоверение, для которого необходимо утвердить. |
|
| comments |
string |
Возвращает или задает комментарии для утверждения. |
| createdOn |
string |
Возвращает дату создания. |
| id |
integer |
Возвращает уникальный идентификатор для ручного вмешательства. |
| instructions |
string |
Возвращает или задает инструкции для утверждения. |
| modifiedOn |
string |
Возвращает дату изменения. |
| name |
string |
Возвращает или задает имя. |
| release |
Возвращает releaseReference для ручного вмешательства. |
|
| releaseDefinition |
Возвращает releaseDefinitionReference для ручного вмешательства. |
|
| releaseEnvironment |
Возвращает releaseEnvironmentReference для ручного вмешательства. |
|
| status |
Возвращает или задает состояние ручного вмешательства. |
|
| taskInstanceId |
string |
Получение идентификатора экземпляра задачи. |
| url |
string |
Возвращает URL-адрес для доступа к ручному вмешательству. |
ManualInterventionStatus
Возвращает или задает состояние ручного вмешательства.
| Имя | Тип | Описание |
|---|---|---|
| approved |
string |
Ручное вмешательство утверждено. |
| canceled |
string |
Ручное вмешательство отменяется. |
| pending |
string |
Ручное вмешательство ожидается. |
| rejected |
string |
Ручное вмешательство отклоняется. |
| unknown |
string |
Для ручного вмешательства не задано состояние. |
ProcessParameters
| Имя | Тип | Описание |
|---|---|---|
| dataSourceBindings |
Представляет привязку источника данных для запроса конечной точки службы. |
|
| inputs | ||
| sourceDefinitions |
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 |
Получает ссылки для доступа к выпуску. |
|
| artifacts |
Artifact[] |
Возвращает или задает список артефактов. |
| comment |
string |
Возвращает или задает комментарий. |
| createdBy |
Возвращает или задает созданное удостоверение. |
|
| createdFor |
Возвращает или задает удостоверение, для которого был создан выпуск. |
|
| createdOn |
string |
Возвращает дату создания. |
| definitionSnapshotRevision |
integer |
Возвращает номер редакции snapshot определения. |
| description |
string |
Возвращает или задает описание выпуска. |
| environments |
Возвращает список сред. |
|
| id |
integer |
Возвращает уникальный идентификатор этого поля. |
| keepForever |
boolean |
Следует ли исключить выпуск из политик хранения. |
| logsContainerUrl |
string |
Возвращает URL-адрес контейнера журналов. |
| modifiedBy |
Возвращает или задает удостоверение, изменяющее. |
|
| modifiedOn |
string |
Возвращает дату изменения. |
| name |
string |
Возвращает имя. |
| poolName |
string |
Возвращает имя пула. |
| projectReference |
Возвращает или задает ссылку на проект. |
|
| properties |
Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с |
|
| reason |
Возвращает причину выпуска. |
|
| releaseDefinition |
Возвращает releaseDefinitionReference, указывающий ссылку на определение выпуска, с которым связан этот выпуск. |
|
| releaseDefinitionRevision |
integer |
Возвращает или задает редакцию определения выпуска. |
| releaseNameFormat |
string |
Возвращает формат имени выпуска. |
| status |
Возвращает состояние. |
|
| tags |
string[] |
Возвращает или задает список тегов. |
| triggeringArtifactAlias |
string |
|
| variableGroups |
Возвращает список групп переменных. |
|
| variables |
<string,
Configuration |
Возвращает или задает словарь переменных. |
ReleaseApproval
| Имя | Тип | Описание |
|---|---|---|
| approvalType |
Возвращает или задает тип утверждения. |
|
| approvedBy |
Возвращает удостоверение, утверждающее. |
|
| approver |
Возвращает или задает удостоверение, для которого необходимо утвердить. |
|
| attempt |
integer |
Возвращает или задает попытку, которая указывает, к какой попытке развертывания она относится. |
| comments |
string |
Возвращает или задает комментарии для утверждения. |
| createdOn |
string |
Возвращает дату создания. |
| history |
Возвращает журнал, в котором указываются все утверждения, связанные с этим утверждением. |
|
| id |
integer |
Возвращает уникальный идентификатор этого поля. |
| isAutomated |
boolean |
Возвращает или задает значение , так как утверждение автоматизировано или нет. |
| modifiedOn |
string |
Возвращает дату изменения. |
| rank |
integer |
Возвращает или задает ранг, указывающий порядок утверждения. Например, один и тот же ранг обозначает параллельное утверждение. |
| release |
Возвращает releaseReference, указывающий ссылку на выпуск, с которым связано это утверждение. |
|
| releaseDefinition |
Возвращает releaseDefinitionReference, задающий ссылку на определение выпуска, с которым связано это утверждение. |
|
| releaseEnvironment |
Возвращает releaseEnvironmentReference, указывающую ссылку на среду выпуска, с которой связано это утверждение. |
|
| revision |
integer |
Возвращает номер редакции. |
| status |
Возвращает или задает состояние утверждения. |
|
| url |
string |
Возвращает URL-адрес для доступа к утверждению. |
ReleaseApprovalHistory
| Имя | Тип | Описание |
|---|---|---|
| approver |
Удостоверение утверждающего. |
|
| changedBy |
Удостоверение объекта, изменившего утверждение. |
|
| comments |
string |
Комментарии к журналу утверждений. |
| createdOn |
string |
Время создания утверждения. |
| modifiedOn |
string |
Время изменения утверждения. |
| revision |
integer |
Редакция журнала утверждений. |
ReleaseCondition
| Имя | Тип | Описание |
|---|---|---|
| conditionType |
Возвращает или задает тип условия. |
|
| name |
string |
Возвращает или задает имя условия. Например, ReleaseStarted. |
| result |
boolean |
Результат условия выпуска. |
| value |
string |
Возвращает или задает значение условия. |
ReleaseDefinitionApprovals
| Имя | Тип | Описание |
|---|---|---|
| approvalOptions |
Возвращает или задает параметры утверждения. |
|
| approvals |
Возвращает или задает утверждения. |
ReleaseDefinitionApprovalStep
| Имя | Тип | Описание |
|---|---|---|
| approver |
Возвращает и задает утверждающего. |
|
| id |
integer |
Идентификатор шага утверждения или развертывания. |
| isAutomated |
boolean |
Указывает, автоматизировано ли утверждение. |
| isNotificationOn |
boolean |
Указывает, задан ли набор уведомлений об утверждении. |
| rank |
integer |
Возвращает или задает ранг шага утверждения. |
ReleaseDefinitionGate
| Имя | Тип | Описание |
|---|---|---|
| tasks |
Возвращает или задает рабочий процесс шлюзов. |
ReleaseDefinitionGatesOptions
| Имя | Тип | Описание |
|---|---|---|
| isEnabled |
boolean |
Возвращает или задает в качестве вентили, включенные или нет. |
| minimumSuccessDuration |
integer |
Возвращает или задает минимальную продолжительность для устойчивых результатов после успешной оценки шлюзов. |
| samplingInterval |
integer |
Возвращает или задает время между повторной оценкой вентилей. |
| stabilizationTime |
integer |
Возвращает или задает задержку перед вычислением. |
| timeout |
integer |
Возвращает или задает время ожидания, после которого шлюзы завершаются ошибкой. |
ReleaseDefinitionGatesStep
| Имя | Тип | Описание |
|---|---|---|
| gates |
Возвращает или задает шлюзы. |
|
| gatesOptions |
Возвращает или задает параметры шлюза. |
|
| id |
integer |
Идентификатор шага ReleaseDefinitionGateStep. |
ReleaseDefinitionShallowReference
| Имя | Тип | Описание |
|---|---|---|
| _links |
Возвращает ссылки на связанные ресурсы, API и представления для определения выпуска. |
|
| id |
integer |
Возвращает уникальный идентификатор определения выпуска. |
| name |
string |
Возвращает или задает имя определения выпуска. |
| path |
string |
Возвращает или задает путь к определению выпуска. |
| projectReference |
Возвращает или задает ссылку на проект. |
|
| url |
string |
Возвращает URL-адрес REST API для доступа к определению выпуска. |
ReleaseDeployPhase
| Имя | Тип | Описание |
|---|---|---|
| deploymentJobs |
Задания развертывания этапа. |
|
| errorLog |
string |
Журналы ошибок выполнения этапа. |
| manualInterventions |
Список сведений о выполнении задач ручного вмешательства в поэтапном режиме. |
|
| name |
string |
Имя этапа. |
| phaseId |
string |
Идентификатор этапа. |
| phaseType |
Тип этапа. |
|
| rank |
integer |
Ранг этапа. |
| runPlanId |
string |
Идентификатор плана запуска этапа. |
| startedOn |
string |
Время начала этапа. |
| status |
Состояние этапа. |
ReleaseEnvironment
| Имя | Тип | Описание |
|---|---|---|
| conditions |
Возвращает список условий. |
|
| createdOn |
string |
Возвращает дату создания. |
| definitionEnvironmentId |
integer |
Возвращает идентификатор среды определения. |
| deployPhasesSnapshot |
Возвращает список этапов развертывания snapshot. |
|
| deploySteps |
Возвращает шаги развертывания. |
|
| environmentOptions |
Возвращает параметры среды. |
|
| id |
integer |
Возвращает уникальный идентификатор этого поля. |
| modifiedOn |
string |
Возвращает дату изменения. |
| name |
string |
Возвращает имя. |
| nextScheduledUtcTime |
string |
Возвращает следующее запланированное время в формате UTC. |
| owner |
Возвращает удостоверение, являющееся владельцем среды выпуска. |
|
| postApprovalsSnapshot |
Возвращает список утверждений после развертывания snapshot. |
|
| postDeployApprovals |
Возвращает список утверждений после развертывания. |
|
| postDeploymentGatesSnapshot |
Шлюзы после развертывания snapshot данные. |
|
| preApprovalsSnapshot |
Возвращает список snapshot утверждений перед развертыванием. |
|
| preDeployApprovals |
Возвращает список утверждений перед развертыванием. |
|
| preDeploymentGatesSnapshot |
Шлюзы перед развертыванием snapshot данные. |
|
| processParameters |
Возвращает параметры процесса. |
|
| rank |
integer |
Возвращает ранг. |
| release |
Возвращает ссылку на выпуск, которая указывает ссылку на выпуск, с которым связана эта среда выпуска. |
|
| releaseCreatedBy |
Возвращает удостоверение, создавшего выпуск. |
|
| releaseDefinition |
Возвращает releaseDefinitionReference, задающий ссылку на определение выпуска, с которым связана эта среда выпуска. |
|
| releaseId |
integer |
Возвращает идентификатор выпуска. |
| scheduledDeploymentTime |
string |
Возвращает время запланированного развертывания среды выпуска. |
| schedules |
Возвращает список расписаний. |
|
| status |
Возвращает состояние среды. |
|
| timeToDeploy |
number |
Возвращает время развертывания. |
| triggerReason |
string |
Возвращает причину триггера. |
| variableGroups |
Возвращает список групп переменных. |
|
| variables |
<string,
Configuration |
Возвращает словарь переменных. |
ReleaseEnvironmentShallowReference
| Имя | Тип | Описание |
|---|---|---|
| _links |
Возвращает ссылки на связанные ресурсы, API и представления для среды выпуска. |
|
| id |
integer |
Возвращает уникальный идентификатор среды выпуска. |
| name |
string |
Возвращает или задает имя среды выпуска. |
| url |
string |
Возвращает URL-адрес REST API для доступа к среде выпуска. |
ReleaseGates
| Имя | Тип | Описание |
|---|---|---|
| deploymentJobs |
Содержит сведения о задании шлюзов для каждой оценки. |
|
| id |
integer |
Идентификатор шлюзов выпуска. |
| ignoredGates |
Список игнорируемых шлюзов. |
|
| lastModifiedOn |
string |
Время последнего изменения шлюзов. |
| runPlanId |
string |
Идентификатор плана запуска шлюзов. |
| stabilizationCompletedOn |
string |
Дата и время завершения стабилизации шлюзов. |
| startedOn |
string |
Время начала оценки Гейтса. |
| status |
Состояние шлюзов выпуска. |
|
| succeedingSince |
string |
Дата и время успешного выполнения всех шлюзов. |
ReleaseReason
Возвращает причину выпуска.
| Имя | Тип | Описание |
|---|---|---|
| continuousIntegration |
string |
Указывает выпуск, активироваемый непрерывной интеграцией. |
| manual |
string |
Указывает, что выпуск активируется вручную. |
| none |
string |
Указывает, что причина, активироваемая выпуском, не задана. |
| pullRequest |
string |
Указывает выпуск, активироваемый PullRequest. |
| schedule |
string |
Указывает выпуск, активироваемый по расписанию. |
ReleaseSchedule
| Имя | Тип | Описание |
|---|---|---|
| daysToRelease |
Дни недели для выпуска. |
|
| jobId |
string |
Идентификатор задания определения задания Team Foundation. |
| scheduleOnlyWithChanges |
boolean |
Флаг, чтобы определить, следует ли выпускать это расписание, только если связанный артефакт был изменен или определение выпуска изменено. |
| startHours |
integer |
Время начала работы местного часового пояса. |
| startMinutes |
integer |
Местный часовой пояс минуты для начала. |
| timeZoneId |
string |
Идентификатор часового пояса расписания выпуска, например "UTC". |
ReleaseShallowReference
| Имя | Тип | Описание |
|---|---|---|
| _links |
Возвращает ссылки на связанные ресурсы, API и представления для выпуска. |
|
| id |
integer |
Возвращает уникальный идентификатор выпуска. |
| name |
string |
Возвращает или задает имя выпуска. |
| url |
string |
Возвращает URL-адрес REST API для доступа к выпуску. |
ReleaseStatus
Возвращает состояние.
| Имя | Тип | Описание |
|---|---|---|
| abandoned |
string |
Состояние выпуска — отменено. |
| active |
string |
Состояние выпуска активно. |
| draft |
string |
Выпуск находится в состоянии черновика. |
| undefined |
string |
Состояние выпуска не задано. |
ReleaseTask
| Имя | Тип | Описание |
|---|---|---|
| agentName |
string |
Имя агента, для которого выполнена задача. |
| finishTime |
string |
Время окончания задачи выпуска. |
| id |
integer |
Идентификатор задачи выпуска. |
| issues |
Issue[] |
Список проблем, возникших во время выполнения задачи. |
| lineCount |
integer |
Количество строк, которое имеет задача выпуска журнала. |
| logUrl |
string |
URL-адрес журнала задачи. |
| name |
string |
Имя задачи. |
| percentComplete |
integer |
Предварительная подготовка к выполнению задачи. |
| rank |
integer |
Ранг задачи выпуска. |
| resultCode |
string |
Код результата задачи. |
| startTime |
string |
Идентификатор задачи выпуска. |
| status |
Состояние задачи выпуска. |
|
| task |
Справочник по задачам рабочего процесса. |
|
| timelineRecordId |
string |
Идентификатор записи временной шкалы задачи выпуска. |
ScheduleDays
Дни недели для выпуска.
| Имя | Тип | Описание |
|---|---|---|
| all |
string |
Запланировано на все дни недели. |
| friday |
string |
Запланировано на пятницу. |
| monday |
string |
Запланировано на понедельник. |
| none |
string |
Запланированный день не задан. |
| saturday |
string |
Запланировано на субботу. |
| sunday |
string |
Запланировано на воскресенье. |
| thursday |
string |
Запланировано на четверг. |
| tuesday |
string |
Запланировано на вторник. |
| wednesday |
string |
Запланировано на среду. |
TaskInputDefinitionBase
| Имя | Тип | Описание |
|---|---|---|
| aliases |
string[] |
|
| defaultValue |
string |
|
| groupName |
string |
|
| helpMarkDown |
string |
|
| label |
string |
|
| name |
string |
|
| options |
object |
|
| properties |
object |
|
| required |
boolean |
|
| type |
string |
|
| validation | ||
| 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 |
Возвращает или задает созданное удостоверение. |
|
| createdOn |
string |
Возвращает дату создания. |
| description |
string |
Возвращает или задает описание. |
| id |
integer |
Возвращает уникальный идентификатор этого поля. |
| isShared |
boolean |
Указывает, используется ли группа переменных совместно с другим проектом. |
| modifiedBy |
Возвращает или задает удостоверение, изменяющее. |
|
| modifiedOn |
string |
Возвращает дату изменения. |
| name |
string |
Возвращает или задает имя. |
| providerData |
Возвращает или задает данные поставщика. |
|
| type |
string |
Возвращает или задает тип. |
| variableGroupProjectReferences |
все ссылки на проекты, в которых группа переменных используется совместно с другими проектами. |
|
| variables |
<string,
Variable |
Возвращает и задает словарь переменных. |
VariableGroupProjectReference
Ссылка на группу переменных — это неглубокая ссылка на группу переменных.
| Имя | Тип | Описание |
|---|---|---|
| description |
string |
Возвращает или задает описание группы переменных. |
| name |
string |
Возвращает или задает имя группы переменных. |
| projectReference |
Возвращает или задает ссылку на проект группы переменных. |
VariableGroupProviderData
VariableValue
| Имя | Тип | Описание |
|---|---|---|
| isReadOnly |
boolean |
Возвращает или задает значение , если переменная доступна только для чтения или нет. |
| isSecret |
boolean |
Возвращает или задает значение , так как переменная является секретной или нет. |
| value |
string |
Получает или задает значение. |
WorkflowTask
| Имя | Тип | Описание |
|---|---|---|
| alwaysRun |
boolean |
Возвращает или задает, как задача всегда выполняется или не выполняется. |
| condition |
string |
Возвращает или задает условие задачи. |
| continueOnError |
boolean |
Получает или задает, как задача продолжает выполняться при ошибке или нет. |
| definitionType |
string |
Возвращает или задает тип определения задачи. Пример: "Агент", DeploymentGroup", "Server" или "ServerGate". |
| enabled |
boolean |
Возвращает или задает как включенную или не включенную задачу. |
| environment |
object |
Возвращает или задает переменные среды задачи. |
| inputs |
object |
Возвращает или задает входные данные задачи. |
| name |
string |
Возвращает или задает имя задачи. |
| overrideInputs |
object |
Возвращает или задает переопределение входных данных задачи. |
| refName |
string |
Возвращает или задает имя ссылки задачи. |
| retryCountOnTaskFailure |
integer |
Возвращает или задает значение retryCount задачи. |
| taskId |
string |
Возвращает или задает идентификатор задачи. |
| timeoutInMinutes |
integer |
Возвращает или задает время ожидания задачи. |
| version |
string |
Возвращает или задает версию задачи. |
WorkflowTaskReference
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор задачи. |
| name |
string |
Имя задачи. |
| version |
string |
Версия задачи. |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по