Releases - Update Release Resource
Atualize algumas propriedades de uma versão.
PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1-preview.8
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
project
|
path | True |
string |
ID do projeto ou nome do projeto |
release
|
path | True |
integer int32 |
ID da versão a ser atualizada. |
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1-preview.8' para usar essa versão da API. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
comment |
string |
Define o comentário para versão. |
keepForever |
boolean |
Defina 'true' para excluir a versão das políticas de retenção. |
manualEnvironments |
string[] |
Define a lista de ambientes manuais. |
name |
string |
Define o nome da versão. |
status |
Define status da versão. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
operação bem-sucedida |
Segurança
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
Nome | Description |
---|---|
vso.release_execute | Concede a capacidade de ler e atualizar artefatos de versão, incluindo pastas, versões, definições de versão e ambiente de lançamento e a capacidade de enfileirar uma nova versão. |
Exemplos
Abandoning an active release
Sample Request
PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=7.1-preview.8
{
"status": "abandoned",
"manualEnvironments": null,
"comment": "Abandon the release"
}
Sample Response
{
"id": 21,
"name": "Release-21",
"status": "abandoned",
"createdOn": "2017-06-16T01:53:35.667Z",
"modifiedOn": "2017-06-16T01:53:36.37Z",
"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": 81,
"releaseId": 21,
"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": 21,
"name": "Release-21",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
}
}
},
"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": 82,
"releaseId": 21,
"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": 21,
"name": "Release-21",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
}
}
},
"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": 83,
"releaseId": 21,
"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": 21,
"name": "Release-21",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
}
}
},
"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": 84,
"releaseId": 21,
"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": 21,
"name": "Release-21",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
}
}
},
"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": "2"
},
"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": ""
},
"branch": {
"id": "refs/heads/master",
"name": "refs/heads/master"
}
},
"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/21/logs",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
}
},
"tags": [],
"projectReference": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": null
},
"properties": {}
}
Definições
Nome | Description |
---|---|
Approval |
Ordem de execução de aprovações. |
Approval |
|
Approval |
Obtém ou define o status da aprovação. |
Approval |
Obtém ou define o tipo de aprovação. |
Artifact | |
Artifact |
|
Authorization |
|
Condition |
Obtém ou define o tipo de condição. |
Configuration |
|
Data |
Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço. |
Deployment |
|
Deployment |
|
Deployment |
Obtém status de operação da implantação. |
Deployment |
Obtém o motivo da implantação. |
Deployment |
Obtém status da implantação. |
Deploy |
|
Deploy |
Status da fase. |
Deploy |
Indica o tipo de fase de implantação. |
Environment |
|
Environment |
Obtém status de ambiente. |
Gate |
Status dos portões de liberação. |
Identity |
|
Ignored |
|
Issue | |
Manual |
|
Manual |
Obtém ou define o status da intervenção manual. |
Process |
|
Project |
|
Properties |
A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um |
Reference |
A classe para representar uma coleção de links de referência REST. |
Release | |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Obtém o motivo da versão. |
Release |
|
Release |
|
Release |
Obtém status. |
Release |
|
Release |
|
Schedule |
Dias da semana para lançamento. |
Task |
|
Task |
|
Task |
|
Task |
Status da tarefa de lançamento. |
Variable |
|
Variable |
Uma referência de grupo de variáveis é uma referência superficial ao grupo de variáveis. |
Variable |
|
Variable |
|
Workflow |
|
Workflow |
ApprovalExecutionOrder
Ordem de execução de aprovações.
Nome | Tipo | Description |
---|---|---|
afterGatesAlways |
string |
Aprovações mostradas sempre após a execução de portões. |
afterSuccessfulGates |
string |
Aprovações mostradas após a execução bem-sucedida de portões. |
beforeGates |
string |
Aprovações mostradas antes dos portões. |
ApprovalOptions
Nome | Tipo | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Especifique se a aprovação poderá ser ignorada se o mesmo aprovador aprovar o estágio anterior. |
enforceIdentityRevalidation |
boolean |
Especifique se revalidar a identidade do aprovador antes de concluir a aprovação. |
executionOrder |
Aprova a ordem de execução. |
|
releaseCreatorCanBeApprover |
boolean |
Especifique se o usuário que solicita uma versão ou implantação deve permitir o aprovador. |
requiredApproverCount |
integer |
O número de aprovações necessárias para avançar a versão. "0" significa todas as aprovações necessárias. |
timeoutInMinutes |
integer |
Tempo limite de aprovação. O tempo limite padrão de aprovação é de 30 dias. O tempo limite máximo permitido é de 365 dias. '0' significa tempo limite padrão, ou seja, 30 dias. |
ApprovalStatus
Obtém ou define o status da aprovação.
Nome | Tipo | Description |
---|---|---|
approved |
string |
Indica que a aprovação foi aprovada. |
canceled |
string |
Indica que a aprovação foi cancelada. |
pending |
string |
Indica que a aprovação está pendente. |
reassigned |
string |
Indica que a aprovação foi reatribuída. |
rejected |
string |
Indica que a aprovação foi rejeitada. |
skipped |
string |
Indica que a aprovação foi ignorada. |
undefined |
string |
Indica que a aprovação não tem o status definido. |
ApprovalType
Obtém ou define o tipo de aprovação.
Nome | Tipo | Description |
---|---|---|
all |
string |
Indica todas as aprovações. |
postDeploy |
string |
Indica as aprovações executadas após a implantação. |
preDeploy |
string |
Indica as aprovações executadas antes da implantação. |
undefined |
string |
Indica que o tipo de aprovação não é definido. |
Artifact
Nome | Tipo | Description |
---|---|---|
alias |
string |
Obtém ou define o alias. |
definitionReference |
<string,
Artifact |
Obtém ou define a referência de definição. por exemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aaa90a6c", "name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}. |
isPrimary |
boolean |
Indica se o artefato é primário ou não. |
isRetained |
boolean |
Indica se o artefato é retido por versão ou não. |
type |
string |
Obtém ou define o tipo. Ele pode ter valor como 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (externo)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'. |
ArtifactSourceReference
Nome | Tipo | Description |
---|---|---|
id |
string |
ID da origem do artefato. |
name |
string |
Nome da origem do artefato. |
AuthorizationHeader
Nome | Tipo | Description |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Obtém ou define o tipo de condição.
Nome | Tipo | Description |
---|---|---|
artifact |
string |
O tipo de condição é artefato. |
environmentState |
string |
O tipo de condição é o estado do ambiente. |
event |
string |
O tipo de condição é event. |
undefined |
string |
O tipo de condição é indefinido. |
ConfigurationVariableValue
Nome | Tipo | Description |
---|---|---|
allowOverride |
boolean |
Obtém e define se uma variável pode ser substituída no momento da implantação ou não. |
isSecret |
boolean |
Obtém ou define como variável é segredo ou não. |
value |
string |
Obtém e define o valor da variável de configuração. |
DataSourceBindingBase
Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço.
Nome | Tipo | Description |
---|---|---|
callbackContextTemplate |
string |
Formato de paginação compatível com essa fonte de dados (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Chamadas subsequentes necessárias? |
dataSourceName |
string |
Obtém ou define o nome da fonte de dados. |
endpointId |
string |
Obtém ou define a ID do ponto de extremidade. |
endpointUrl |
string |
Obtém ou define a URL do ponto de extremidade de serviço. |
headers |
Obtém ou define os cabeçalhos de autorização. |
|
initialContextTemplate |
string |
Define o valor inicial dos parâmetros de consulta |
parameters |
object |
Obtém ou define os parâmetros para a fonte de dados. |
requestContent |
string |
Obtém ou define o corpo da solicitação http |
requestVerb |
string |
Obtém ou define o verbo de solicitação http |
resultSelector |
string |
Obtém ou define o seletor de resultados. |
resultTemplate |
string |
Obtém ou define o modelo de resultado. |
target |
string |
Obtém ou define o destino da fonte de dados. |
DeploymentAttempt
Nome | Tipo | Description |
---|---|---|
attempt |
integer |
Tentativa de implantação. |
deploymentId |
integer |
ID da implantação. |
hasStarted |
boolean |
Especifica se a implantação foi iniciada ou não. |
id |
integer |
ID da implantação. |
issues |
Issue[] |
Todos os problemas relacionados à implantação. |
lastModifiedBy |
Identidade que modificou essa implantação pela última vez. |
|
lastModifiedOn |
string |
Hora em que essa implantação foi modificada pela última vez. |
operationStatus |
Status de operação de implantação. |
|
postDeploymentGates |
Post deployment gates that executed in this deployment. |
|
preDeploymentGates |
Portões de pré-implantação executados nesta implantação. |
|
queuedOn |
string |
Quando essa implantação está na fila. |
reason |
Motivo da implantação. |
|
releaseDeployPhases |
Lista de implantações de versão executadas nesta implantação. |
|
requestedBy |
Identidade que solicitou essa implantação. |
|
requestedFor |
Identidade para essa implantação solicitada. |
|
status |
status da implantação. |
DeploymentJob
Nome | Tipo | Description |
---|---|---|
job |
Tarefa pai de todas as tarefas executadas. |
|
tasks |
Lista de tarefas executadas com no trabalho. |
DeploymentOperationStatus
Obtém status de operação da implantação.
Nome | Tipo | Description |
---|---|---|
all |
string |
A operação de implantação status é tudo. |
approved |
string |
A operação de implantação status é aprovada. |
canceled |
string |
A operação de implantação status é cancelada. |
cancelling |
string |
A operação de implantação status está sendo cancelada. |
deferred |
string |
A operação de implantação status é adiada. |
evaluatingGates |
string |
A operação de implantação status é EvaluatingGates. |
gateFailed |
string |
A operação de implantação status é GateFailed. |
manualInterventionPending |
string |
A operação de implantação status está pendente manualmente. |
pending |
string |
A operação de implantação status está pendente. |
phaseCanceled |
string |
A operação de implantação status é cancelada em fase. |
phaseFailed |
string |
Falha na fase status da operação de implantação. |
phaseInProgress |
string |
A operação de implantação status está em fase em andamento. |
phasePartiallySucceeded |
string |
A operação de implantação status é parcialmente bem-sucedida. |
phaseSucceeded |
string |
A operação de implantação status foi bem-sucedida. |
queued |
string |
A operação de implantação status está na fila. |
queuedForAgent |
string |
A operação de implantação status está na fila do agente. |
queuedForPipeline |
string |
A operação de implantação status está na fila para pipeline. |
rejected |
string |
A operação de implantação status é rejeitada. |
scheduled |
string |
A operação de implantação status está agendada. |
undefined |
string |
A operação de implantação status é indefinida. |
DeploymentReason
Obtém o motivo da implantação.
Nome | Tipo | Description |
---|---|---|
automated |
string |
O motivo da implantação é automatizado. |
manual |
string |
O motivo da implantação é manual. |
none |
string |
O motivo da implantação é nenhum. |
redeployTrigger |
string |
O motivo da implantação é ReimplantarTrigger. |
scheduled |
string |
O motivo da implantação está agendado. |
DeploymentStatus
Obtém status da implantação.
Nome | Tipo | Description |
---|---|---|
all |
string |
O status de implantação é tudo. |
failed |
string |
Falha no status de implantação. |
inProgress |
string |
O status de implantação está em andamento. |
notDeployed |
string |
O status de implantação não está implantado. |
partiallySucceeded |
string |
A status de implantação é parcialmente certificada. |
succeeded |
string |
O status de implantação foi bem-sucedido. |
undefined |
string |
O status de implantação é indefinido. |
DeployPhase
Nome | Tipo | Description |
---|---|---|
name |
string |
Obtém e define o nome da fase de implantação. |
phaseType |
Indica o tipo de fase de implantação. |
|
rank |
integer |
Obtém e define a classificação da fase de implantação. |
refName |
string |
Obtém e define o nome de referência da fase de implantação. |
workflowTasks |
Obtém e define as tarefas de fluxo de trabalho para a fase de implantação. |
DeployPhaseStatus
Status da fase.
Nome | Tipo | Description |
---|---|---|
canceled |
string |
Execução de fase cancelada. |
cancelling |
string |
A fase está no estado de cancelamento. |
failed |
string |
Falha na execução da fase. |
inProgress |
string |
Execução de fase em andamento. |
notStarted |
string |
Execução de fase não iniciada. |
partiallySucceeded |
string |
Execução de fase parcialmente bem-sucedida. |
skipped |
string |
Execução de fase ignorada. |
succeeded |
string |
Execução de fase bem-sucedida. |
undefined |
string |
A fase não status definida. |
DeployPhaseTypes
Indica o tipo de fase de implantação.
Nome | Tipo | Description |
---|---|---|
agentBasedDeployment |
string |
Tipo de fase que contém tarefas executadas no agente. |
deploymentGates |
string |
Tipo de fase que contém tarefas que atuam como Portões para que a implantação avance. |
machineGroupBasedDeployment |
string |
Tipo de fase que contém tarefas executadas em computadores de grupo de implantação. |
runOnServer |
string |
Tipo de fase que contém tarefas executadas pelo servidor. |
undefined |
string |
Tipo de fase não definido. Não use isso. |
EnvironmentOptions
Nome | Tipo | Description |
---|---|---|
autoLinkWorkItems |
boolean |
Obtém e define como os workitems de link automático ou não. |
badgeEnabled |
boolean |
Obtém e define como o selo habilitado ou não. |
publishDeploymentStatus |
boolean |
Obtém e define como a implantação de publicação status ou não. |
pullRequestDeploymentEnabled |
boolean |
Obtém e define como a implantação.pull request habilitada ou não. |
EnvironmentStatus
Obtém status de ambiente.
Nome | Tipo | Description |
---|---|---|
canceled |
string |
O ambiente está no estado cancelado. |
inProgress |
string |
O ambiente está em andamento. |
notStarted |
string |
O ambiente não está no estado iniciado. |
partiallySucceeded |
string |
O ambiente está em estado parcialmente bem-sucedido. |
queued |
string |
O ambiente está em estado de fila. |
rejected |
string |
O ambiente está no estado rejeitado. |
scheduled |
string |
O ambiente está no estado agendado. |
succeeded |
string |
O ambiente está no estado bem-sucedido. |
undefined |
string |
O ambiente não status definido. |
GateStatus
Status dos portões de liberação.
Nome | Tipo | Description |
---|---|---|
canceled |
string |
A execução do portão foi cancelada. |
failed |
string |
Falha na execução do portão. |
inProgress |
string |
O portão está em andamento no momento. |
none |
string |
O portão não tem o status definido. |
pending |
string |
O portão está em estado pendente. |
succeeded |
string |
O portão foi concluído com êxito. |
IdentityRef
Nome | Tipo | Description |
---|---|---|
_links |
Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo. |
|
descriptor |
string |
O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações. |
directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links" |
displayName |
string |
Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem. |
id |
string |
|
imageUrl |
string |
Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links" |
inactive |
boolean |
Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser |
isAadIdentity |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef |
uniqueName |
string |
Preterido – use Domain+PrincipalName em vez disso |
url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
IgnoredGate
Nome | Tipo | Description |
---|---|---|
lastModifiedOn |
string |
Obtém a data em que o portão é ignorado pela última vez. |
name |
string |
Nome do portão ignorado. |
Issue
Nome | Tipo | Description |
---|---|---|
data |
object |
Emitir dados. |
issueType |
string |
Tipo de problema, por exemplo, erro, aviso ou informações. |
message |
string |
Mensagem de problema. |
ManualIntervention
Nome | Tipo | Description |
---|---|---|
approver |
Obtém ou define a identidade que deve aprovar. |
|
comments |
string |
Obtém ou define comentários para aprovação. |
createdOn |
string |
Obtém a data em que ela foi criada. |
id |
integer |
Obtém o identificador exclusivo para intervenção manual. |
instructions |
string |
Obtém ou define instruções para aprovação. |
modifiedOn |
string |
Obtém a data em que ela foi modificada. |
name |
string |
Obtém ou define o nome. |
release |
Obtém releaseReference para intervenção manual. |
|
releaseDefinition |
Obtém releaseDefinitionReference para intervenção manual. |
|
releaseEnvironment |
Obtém releaseEnvironmentReference para intervenção manual. |
|
status |
Obtém ou define o status da intervenção manual. |
|
taskInstanceId |
string |
Obter o identificador da instância de tarefa. |
url |
string |
Obtém a URL para acessar a intervenção manual. |
ManualInterventionStatus
Obtém ou define o status da intervenção manual.
Nome | Tipo | Description |
---|---|---|
approved |
string |
A intervenção manual é aprovada. |
canceled |
string |
A intervenção manual é cancelada. |
pending |
string |
A intervenção manual está pendente. |
rejected |
string |
A intervenção manual é rejeitada. |
unknown |
string |
A intervenção manual não tem o status definido. |
ProcessParameters
Nome | Tipo | Description |
---|---|---|
dataSourceBindings |
Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Nome | Tipo | Description |
---|---|---|
id |
string |
Obtém o identificador exclusivo desse campo. |
name |
string |
Obtém o nome do projeto. |
PropertiesCollection
A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object
) exceto para DBNull
são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
Nome | Tipo | Description |
---|---|---|
count |
integer |
A contagem de propriedades na coleção. |
item |
object |
|
keys |
string[] |
O conjunto de chaves na coleção. |
values |
string[] |
O conjunto de valores na coleção. |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
Nome | Tipo | Description |
---|---|---|
links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
Release
Nome | Tipo | Description |
---|---|---|
_links |
Obtém links para acessar a versão. |
|
artifacts |
Artifact[] |
Obtém ou define a lista de artefatos. |
comment |
string |
Obtém ou define o comentário. |
createdBy |
Obtém ou define a identidade que criou. |
|
createdFor |
Obtém ou define a identidade para quem a versão foi criada. |
|
createdOn |
string |
Obtém a data em que ela foi criada. |
definitionSnapshotRevision |
integer |
Obtém o número de revisão de instantâneo de definição. |
description |
string |
Obtém ou define a descrição da versão. |
environments |
Obtém a lista de ambientes. |
|
id |
integer |
Obtém o identificador exclusivo desse campo. |
keepForever |
boolean |
Se deseja excluir a versão das políticas de retenção. |
logsContainerUrl |
string |
Obtém a URL do contêiner de logs. |
modifiedBy |
Obtém ou define a identidade que modificou. |
|
modifiedOn |
string |
Obtém a data em que ela foi modificada. |
name |
string |
Obtém o nome. |
poolName |
string |
Obtém o nome do pool. |
projectReference |
Obtém ou define a referência do projeto. |
|
properties |
A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um |
|
reason |
Obtém o motivo da liberação. |
|
releaseDefinition |
Obtém releaseDefinitionReference que especifica a referência da definição de versão à qual esta versão está associada. |
|
releaseDefinitionRevision |
integer |
Obtém ou define a revisão de definição de versão. |
releaseNameFormat |
string |
Obtém o formato do nome da versão. |
status |
Obtém status. |
|
tags |
string[] |
Obtém ou define a lista de marcas. |
triggeringArtifactAlias |
string |
|
variableGroups |
Obtém a lista de grupos de variáveis. |
|
variables |
<string,
Configuration |
Obtém ou define o dicionário de variáveis. |
ReleaseApproval
Nome | Tipo | Description |
---|---|---|
approvalType |
Obtém ou define o tipo de aprovação. |
|
approvedBy |
Obtém a identidade que aprovou. |
|
approver |
Obtém ou define a identidade que deve aprovar. |
|
attempt |
integer |
Obtém ou define a tentativa que especifica como qual tentativa de implantação pertence. |
comments |
string |
Obtém ou define comentários para aprovação. |
createdOn |
string |
Obtém a data em que ela foi criada. |
history |
Obtém o histórico que especifica todas as aprovações associadas a essa aprovação. |
|
id |
integer |
Obtém o identificador exclusivo desse campo. |
isAutomated |
boolean |
Obtém ou define como a aprovação é automatizada ou não. |
modifiedOn |
string |
Obtém a data em que ela foi modificada. |
rank |
integer |
Obtém ou define a classificação que especifica a ordem da aprovação. Por exemplo, a mesma classificação indica aprovação paralela. |
release |
Obtém releaseReference que especifica a referência da versão à qual essa aprovação está associada. |
|
releaseDefinition |
Obtém releaseDefinitionReference que especifica a referência da definição de versão à qual essa aprovação está associada. |
|
releaseEnvironment |
Obtém releaseEnvironmentReference, que especifica a referência do ambiente de versão ao qual essa aprovação está associada. |
|
revision |
integer |
Obtém o número de revisão. |
status |
Obtém ou define o status da aprovação. |
|
url |
string |
Obtém a URL para acessar a aprovação. |
ReleaseApprovalHistory
Nome | Tipo | Description |
---|---|---|
approver |
Identidade do aprovador. |
|
changedBy |
Identidade do objeto que alterou a aprovação. |
|
comments |
string |
Comentários do histórico de aprovação. |
createdOn |
string |
Hora em que essa aprovação foi criada. |
modifiedOn |
string |
Hora em que essa aprovação foi modificada. |
revision |
integer |
Revisão do histórico de aprovação. |
ReleaseCondition
Nome | Tipo | Description |
---|---|---|
conditionType |
Obtém ou define o tipo de condição. |
|
name |
string |
Obtém ou define o nome da condição. por exemplo, 'ReleaseStarted'. |
result |
boolean |
O resultado da condição de liberação. |
value |
string |
Obtém ou define o valor da condição. |
ReleaseDefinitionApprovals
Nome | Tipo | Description |
---|---|---|
approvalOptions |
Obtém ou define as opções de aprovação. |
|
approvals |
Obtém ou define as aprovações. |
ReleaseDefinitionApprovalStep
Nome | Tipo | Description |
---|---|---|
approver |
Obtém e define o aprovador. |
|
id |
integer |
ID da etapa de aprovação ou implantação. |
isAutomated |
boolean |
Indica se a aprovação foi automatizada. |
isNotificationOn |
boolean |
Indica se o conjunto de notificação de aprovação. |
rank |
integer |
Obtém ou define a classificação da etapa de aprovação. |
ReleaseDefinitionGate
Nome | Tipo | Description |
---|---|---|
tasks |
Obtém ou define o fluxo de trabalho de portões. |
ReleaseDefinitionGatesOptions
Nome | Tipo | Description |
---|---|---|
isEnabled |
boolean |
Obtém ou define como os portões habilitados ou não. |
minimumSuccessDuration |
integer |
Obtém ou define a duração mínima para resultados estáveis após uma avaliação bem-sucedida de portões. |
samplingInterval |
integer |
Obtém ou define o tempo entre a reavaliação dos portões. |
stabilizationTime |
integer |
Obtém ou define o atraso antes da avaliação. |
timeout |
integer |
Obtém ou define o tempo limite após o qual os portões falham. |
ReleaseDefinitionGatesStep
Nome | Tipo | Description |
---|---|---|
gates |
Obtém ou define os portões. |
|
gatesOptions |
Obtém ou define as opções de portão. |
|
id |
integer |
ID do ReleaseDefinitionGateStep. |
ReleaseDefinitionShallowReference
Nome | Tipo | Description |
---|---|---|
_links |
Obtém os links para recursos, APIs e exibições relacionados para a definição de versão. |
|
id |
integer |
Obtém o identificador exclusivo da definição de versão. |
name |
string |
Obtém ou define o nome da definição de versão. |
path |
string |
Obtém ou define o caminho da definição de versão. |
projectReference |
Obtém ou define a referência do projeto. |
|
url |
string |
Obtém a URL da API REST para acessar a definição de versão. |
ReleaseDeployPhase
Nome | Tipo | Description |
---|---|---|
deploymentJobs |
Trabalhos de implantação da fase. |
|
errorLog |
string |
Logs de erro de execução de fase. |
manualInterventions |
Lista de informações de execução de tarefas de intervenção manual em fase. |
|
name |
string |
Nome da fase. |
phaseId |
string |
ID da fase. |
phaseType |
Tipo da fase. |
|
rank |
integer |
Classificação da fase. |
runPlanId |
string |
Execute a ID do Plano da fase. |
startedOn |
string |
Hora de início da fase. |
status |
Status da fase. |
ReleaseEnvironment
Nome | Tipo | Description |
---|---|---|
conditions |
Obtém a lista de condições. |
|
createdOn |
string |
Obtém a data em que ela foi criada. |
definitionEnvironmentId |
integer |
Obtém a ID do ambiente de definição. |
deployPhasesSnapshot |
Obtém a lista de fases de implantação instantâneo. |
|
deploySteps |
Obtém as etapas de implantação. |
|
environmentOptions |
Obtém opções de ambiente. |
|
id |
integer |
Obtém o identificador exclusivo desse campo. |
modifiedOn |
string |
Obtém a data em que ela foi modificada. |
name |
string |
Obtém o nome. |
nextScheduledUtcTime |
string |
Obtém a próxima hora UTC agendada. |
owner |
Obtém a identidade que é proprietário do ambiente de lançamento. |
|
postApprovalsSnapshot |
Obtém a lista de aprovações pós-implantação instantâneo. |
|
postDeployApprovals |
Obtém a lista de aprovações pós-implantação. |
|
postDeploymentGatesSnapshot |
Os portões pós-implantação instantâneo dados. |
|
preApprovalsSnapshot |
Obtém a lista de aprovações de pré-implantação instantâneo. |
|
preDeployApprovals |
Obtém a lista de aprovações de pré-implantação. |
|
preDeploymentGatesSnapshot |
Os portões de pré-implantação instantâneo dados. |
|
processParameters |
Obtém parâmetros de processo. |
|
rank |
integer |
Obtém classificação. |
release |
Obtém a referência de versão que especifica a referência da versão à qual esse ambiente de versão está associado. |
|
releaseCreatedBy |
Obtém a identidade que criou a versão. |
|
releaseDefinition |
Obtém releaseDefinitionReference, que especifica a referência da definição de versão à qual esse ambiente de versão está associado. |
|
releaseId |
integer |
Obtém a ID da versão. |
scheduledDeploymentTime |
string |
Obtém o tempo de implantação agendado do ambiente de lançamento. |
schedules |
Obtém a lista de agendas. |
|
status |
Obtém status de ambiente. |
|
timeToDeploy |
number |
Obtém tempo para implantar. |
triggerReason |
string |
Obtém o motivo do gatilho. |
variableGroups |
Obtém a lista de grupos de variáveis. |
|
variables |
<string,
Configuration |
Obtém o dicionário de variáveis. |
ReleaseEnvironmentShallowReference
Nome | Tipo | Description |
---|---|---|
_links |
Obtém os links para recursos, APIs e exibições relacionados para o ambiente de lançamento. |
|
id |
integer |
Obtém o identificador exclusivo do ambiente de versão. |
name |
string |
Obtém ou define o nome do ambiente de versão. |
url |
string |
Obtém a URL da API REST para acessar o ambiente de versão. |
ReleaseGates
Nome | Tipo | Description |
---|---|---|
deploymentJobs |
Contém os detalhes do trabalho de portões de cada avaliação. |
|
id |
integer |
ID dos portões de liberação. |
ignoredGates |
Lista de portões ignorados. |
|
lastModifiedOn |
string |
Hora da última modificação dos portões. |
runPlanId |
string |
Execute a ID do plano dos portões. |
stabilizationCompletedOn |
string |
A estabilização dos portões concluiu a data e a hora. |
startedOn |
string |
Hora de início da avaliação dos portões. |
status |
Status dos portões de lançamento. |
|
succeedingSince |
string |
Data e hora em que todos os portões foram executados com êxito. |
ReleaseReason
Obtém o motivo da versão.
Nome | Tipo | Description |
---|---|---|
continuousIntegration |
string |
Indica a versão disparada pela integração contínua. |
manual |
string |
Indica a versão disparada manualmente. |
none |
string |
Indica o motivo disparado pela versão não definido. |
pullRequest |
string |
Indica a versão disparada por PullRequest. |
schedule |
string |
Indica a versão disparada pelo agendamento. |
ReleaseSchedule
Nome | Tipo | Description |
---|---|---|
daysToRelease |
Dias da semana a serem lançados. |
|
jobId |
string |
ID do trabalho de definição de trabalho do Team Foundation. |
scheduleOnlyWithChanges |
boolean |
Sinalizador para determinar se esse agendamento só deve ser liberado se o artefato associado tiver sido alterado ou a definição de versão alterada. |
startHours |
integer |
Hora de fuso horário local para iniciar. |
startMinutes |
integer |
Minuto de fuso horário local para iniciar. |
timeZoneId |
string |
ID de fuso horário do agendamento de lançamento, como 'UTC'. |
ReleaseShallowReference
Nome | Tipo | Description |
---|---|---|
_links |
Obtém os links para recursos, APIs e exibições relacionados para a versão. |
|
id |
integer |
Obtém o identificador exclusivo da versão. |
name |
string |
Obtém ou define o nome da versão. |
url |
string |
Obtém a URL da API REST para acessar a versão. |
ReleaseStatus
Obtém status.
Nome | Tipo | Description |
---|---|---|
abandoned |
string |
A versão status está abandonada. |
active |
string |
A versão status está ativa. |
draft |
string |
A versão está em estado de rascunho. |
undefined |
string |
A versão não status definida. |
ReleaseTask
Nome | Tipo | Description |
---|---|---|
agentName |
string |
Nome do agente no qual a tarefa foi executada. |
finishTime |
string |
Hora de término da tarefa de lançamento. |
id |
integer |
ID da tarefa de lançamento. |
issues |
Issue[] |
A lista de problemas ocorreu durante a execução da tarefa. |
lineCount |
integer |
Número de linhas que a tarefa de liberação de log tem. |
logUrl |
string |
URL de log da tarefa. |
name |
string |
Nome da tarefa. |
percentComplete |
integer |
Precent da execução da tarefa. |
rank |
integer |
Classificação da tarefa de lançamento. |
resultCode |
string |
Código de resultado da tarefa. |
startTime |
string |
ID da tarefa de lançamento. |
status |
Status da tarefa de lançamento. |
|
task |
Referência de tarefa de fluxo de trabalho. |
|
timelineRecordId |
string |
ID do registro da linha do tempo da tarefa de lançamento. |
ReleaseUpdateMetadata
Nome | Tipo | Description |
---|---|---|
comment |
string |
Define o comentário para versão. |
keepForever |
boolean |
Defina 'true' para excluir a versão das políticas de retenção. |
manualEnvironments |
string[] |
Define a lista de ambientes manuais. |
name |
string |
Define o nome da versão. |
status |
Define status da versão. |
ScheduleDays
Dias da semana para lançamento.
Nome | Tipo | Description |
---|---|---|
all |
string |
Agendado em todos os dias da semana. |
friday |
string |
Agendado para sexta-feira. |
monday |
string |
Agendado para segunda-feira. |
none |
string |
Dia agendado não definido. |
saturday |
string |
Agendado para sábado. |
sunday |
string |
Agendado para domingo. |
thursday |
string |
Marcado para quinta-feira. |
tuesday |
string |
Agendado para terça-feira. |
wednesday |
string |
Marcado para quarta-feira. |
TaskInputDefinitionBase
Nome | Tipo | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Nome | Tipo | Description |
---|---|---|
expression |
string |
Expressões condicionais |
message |
string |
Mensagem explicando como o usuário pode corrigir se a validação falhar |
TaskSourceDefinitionBase
Nome | Tipo | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Status da tarefa de lançamento.
Nome | Tipo | Description |
---|---|---|
canceled |
string |
A execução da tarefa foi cancelada. |
failed |
string |
Falha na execução da tarefa. |
failure |
string |
Falha na execução da tarefa. |
inProgress |
string |
A tarefa está em andamento no momento. |
partiallySucceeded |
string |
A execução da tarefa foi parcialmente bem-sucedida. |
pending |
string |
A tarefa está em status pendente. |
skipped |
string |
A execução da tarefa foi ignorada. |
succeeded |
string |
A tarefa foi concluída com êxito. |
success |
string |
A tarefa foi concluída com êxito. |
unknown |
string |
A tarefa não tem o status definido. |
VariableGroup
Nome | Tipo | Description |
---|---|---|
createdBy |
Obtém ou define a identidade que criou. |
|
createdOn |
string |
Obtém a data em que ela foi criada. |
description |
string |
Obtém ou define a descrição. |
id |
integer |
Obtém o identificador exclusivo desse campo. |
isShared |
boolean |
Indica se um grupo de variáveis é compartilhado com outro projeto ou não. |
modifiedBy |
Obtém ou define a identidade que modificou. |
|
modifiedOn |
string |
Obtém a data em que ela foi modificada. |
name |
string |
Obtém ou define o nome. |
providerData |
Obtém ou define dados do provedor. |
|
type |
string |
Obtém ou define o tipo. |
variableGroupProjectReferences |
todas as referências de projeto em que o grupo de variáveis é compartilhado com outros projetos. |
|
variables |
<string,
Variable |
Obtém e define o dicionário de variáveis. |
VariableGroupProjectReference
Uma referência de grupo de variáveis é uma referência superficial ao grupo de variáveis.
Nome | Tipo | Description |
---|---|---|
description |
string |
Obtém ou define a descrição do grupo de variáveis. |
name |
string |
Obtém ou define o nome do grupo de variáveis. |
projectReference |
Obtém ou define a referência de projeto do grupo de variáveis. |
VariableGroupProviderData
VariableValue
Nome | Tipo | Description |
---|---|---|
isReadOnly |
boolean |
Obtém ou define se a variável é somente leitura ou não. |
isSecret |
boolean |
Obtém ou define como a variável é secreta ou não. |
value |
string |
Obtém ou define o valor. |
WorkflowTask
Nome | Tipo | Description |
---|---|---|
alwaysRun |
boolean |
Obtém ou define como a tarefa sempre é executada ou não. |
condition |
string |
Obtém ou define a condição da tarefa. |
continueOnError |
boolean |
Obtém ou define como a tarefa continua sendo executada com erro ou não. |
definitionType |
string |
Obtém ou define o tipo de definição de tarefa. Exemplo:- 'Agent', DeploymentGroup', 'Server' ou 'ServerGate'. |
enabled |
boolean |
Obtém ou define como a tarefa habilitada ou não. |
environment |
object |
Obtém ou define as variáveis de ambiente de tarefa. |
inputs |
object |
Obtém ou define as entradas da tarefa. |
name |
string |
Obtém ou define o nome da tarefa. |
overrideInputs |
object |
Obtém ou define as entradas de substituição da tarefa. |
refName |
string |
Obtém ou define o nome de referência da tarefa. |
retryCountOnTaskFailure |
integer |
Obtém ou define a tarefa retryCount. |
taskId |
string |
Obtém ou define a ID da tarefa. |
timeoutInMinutes |
integer |
Obtém ou define o tempo limite da tarefa. |
version |
string |
Obtém ou define a versão da tarefa. |
WorkflowTaskReference
Nome | Tipo | Description |
---|---|---|
id |
string |
Identificador de tarefa. |
name |
string |
Nome da tarefa. |
version |
string |
Versão da tarefa. |