Releases - Update Release
Actualice un objeto de versión completo.
PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1-preview.8Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
|
project
|
path | True |
string |
Id. de proyecto o nombre del proyecto |
|
release
|
path | True |
integer int32 |
Identificador de la versión que se va a actualizar. |
|
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.8" para usar esta versión de la API. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Obtiene vínculos para acceder a la versión. |
|
| artifacts |
Artifact[] |
Obtiene o establece la lista de artefactos. |
| comment |
string |
Obtiene o establece el comentario. |
| createdBy |
Obtiene o establece la identidad que creó. |
|
| createdFor |
Obtiene o establece la identidad para la que se creó la versión. |
|
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| definitionSnapshotRevision |
integer |
Obtiene el número de revisión de la instantánea de definición. |
| description |
string |
Obtiene o establece la descripción de la versión. |
| environments |
Obtiene la lista de entornos. |
|
| id |
integer |
Obtiene el identificador único de este campo. |
| keepForever |
boolean |
Si se va a excluir la versión de las directivas de retención. |
| logsContainerUrl |
string |
Obtiene la dirección URL del contenedor de registros. |
| modifiedBy |
Obtiene o establece la identidad que modificó. |
|
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| name |
string |
Obtiene el nombre. |
| poolName |
string |
Obtiene el nombre del grupo. |
| projectReference |
Obtiene o establece la referencia del proyecto. |
|
| properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un |
|
| reason |
Obtiene el motivo de la versión. |
|
| releaseDefinition |
Obtiene releaseDefinitionReference, que especifica la referencia de la definición de versión a la que está asociada esta versión. |
|
| releaseDefinitionRevision |
integer |
Obtiene o establece la revisión de definición de versión. |
| releaseNameFormat |
string |
Obtiene el formato de nombre de versión. |
| status |
Obtiene el estado. |
|
| tags |
string[] |
Obtiene o establece la lista de etiquetas. |
| triggeringArtifactAlias |
string |
|
| variableGroups |
Obtiene la lista de grupos de variables. |
|
| variables |
<string,
Configuration |
Obtiene o establece el diccionario de variables. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
operación correcta |
Seguridad
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
| Nombre | Description |
|---|---|
| vso.release_execute | Concede la capacidad de leer y actualizar artefactos de versión, incluidas carpetas, versiones, definiciones de versión y entorno de versión, y la capacidad de poner en cola una nueva versión. |
Ejemplos
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": {}
}Definiciones
| Nombre | Description |
|---|---|
|
Approval |
Orden de ejecución de aprobaciones. |
|
Approval |
|
|
Approval |
Obtiene o establece el estado de la aprobación. |
|
Approval |
Obtiene o establece el tipo de aprobación. |
| Artifact | |
|
Artifact |
|
|
Authorization |
|
|
Condition |
Obtiene o establece el tipo de condición. |
|
Configuration |
|
|
Data |
Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio. |
|
Deployment |
|
|
Deployment |
|
|
Deployment |
Obtiene el estado de operación de la implementación. |
|
Deployment |
Obtiene el motivo de la implementación. |
|
Deployment |
Obtiene el estado de la implementación. |
|
Deploy |
|
|
Deploy |
Estado de la fase. |
|
Deploy |
Indica el tipo de fase de implementación. |
|
Environment |
|
|
Environment |
Obtiene el estado del entorno. |
|
Gate |
Estado de las puertas de liberación. |
|
Identity |
|
|
Ignored |
|
| Issue | |
|
Manual |
|
|
Manual |
Obtiene o establece el estado de la intervención manual. |
|
Process |
|
|
Project |
|
|
Properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un |
|
Reference |
Clase que representa una colección de vínculos de referencia de REST. |
| Release | |
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
Obtiene el motivo de la versión. |
|
Release |
|
|
Release |
|
|
Release |
Obtiene el estado. |
|
Release |
|
|
Schedule |
Días de la semana que se van a publicar. |
|
Task |
|
|
Task |
|
|
Task |
|
|
Task |
Estado de la tarea de versión. |
|
Variable |
|
|
Variable |
Una referencia de grupo de variables es una referencia superficial al grupo de variables. |
|
Variable |
|
|
Variable |
|
|
Workflow |
|
|
Workflow |
ApprovalExecutionOrder
Orden de ejecución de aprobaciones.
| Nombre | Tipo | Description |
|---|---|---|
| afterGatesAlways |
string |
Las aprobaciones que se muestran siempre después de la ejecución de puertas. |
| afterSuccessfulGates |
string |
Aprobaciones que se muestran después de la ejecución correcta de puertas. |
| beforeGates |
string |
Aprobaciones mostradas antes de las puertas. |
ApprovalOptions
| Nombre | Tipo | Description |
|---|---|---|
| autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Especifique si la aprobación se puede omitir si el mismo aprobador aprobó la fase anterior. |
| enforceIdentityRevalidation |
boolean |
Especifique si vuelve a validar la identidad del aprobador antes de completar la aprobación. |
| executionOrder |
Orden de ejecución de aprobaciones. |
|
| releaseCreatorCanBeApprover |
boolean |
Especifique si el usuario que solicita una versión o una implementación debe permitir el aprobador. |
| requiredApproverCount |
integer |
Número de aprobaciones necesarias para avanzar la versión. '0' significa todas las aprobaciones necesarias. |
| timeoutInMinutes |
integer |
Tiempo de espera de aprobación. El tiempo de espera predeterminado de aprobación es de 30 días. El tiempo de espera máximo permitido es de 365 días. "0" significa tiempo de espera predeterminado, es decir, 30 días. |
ApprovalStatus
Obtiene o establece el estado de la aprobación.
| Nombre | Tipo | Description |
|---|---|---|
| approved |
string |
Indica que se aprueba la aprobación. |
| canceled |
string |
Indica que se cancela la aprobación. |
| pending |
string |
Indica que la aprobación está pendiente. |
| reassigned |
string |
Indica que se reasigna la aprobación. |
| rejected |
string |
Indica que se rechaza la aprobación. |
| skipped |
string |
Indica que se omite la aprobación. |
| undefined |
string |
Indica que la aprobación no tiene establecido el estado. |
ApprovalType
Obtiene o establece el tipo de aprobación.
| Nombre | Tipo | Description |
|---|---|---|
| all |
string |
Indica todas las aprobaciones. |
| postDeploy |
string |
Indica las aprobaciones que se ejecutaron después de la implementación. |
| preDeploy |
string |
Indica las aprobaciones que se ejecutaron antes de la implementación. |
| undefined |
string |
Indica que el tipo de aprobación no se establece. |
Artifact
| Nombre | Tipo | Description |
|---|---|---|
| alias |
string |
Obtiene o establece alias. |
| definitionReference |
<string,
Artifact |
Obtiene o establece la referencia de definición. Por ejemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}. |
| isPrimary |
boolean |
Indica si el artefacto es principal o no. |
| isRetained |
boolean |
Indica si el artefacto se conserva por versión o no. |
| type |
string |
Obtiene o establece el tipo. Puede tener el valor "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild". |
ArtifactSourceReference
| Nombre | Tipo | Description |
|---|---|---|
| id |
string |
Identificador del origen del artefacto. |
| name |
string |
Nombre del origen del artefacto. |
AuthorizationHeader
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
|
| value |
string |
ConditionType
Obtiene o establece el tipo de condición.
| Nombre | Tipo | Description |
|---|---|---|
| artifact |
string |
El tipo de condición es artifact. |
| environmentState |
string |
El tipo de condición es el estado del entorno. |
| event |
string |
El tipo de condición es event. |
| undefined |
string |
El tipo de condición no está definido. |
ConfigurationVariableValue
| Nombre | Tipo | Description |
|---|---|---|
| allowOverride |
boolean |
Obtiene y establece si se puede invalidar una variable en el momento de la implementación o no. |
| isSecret |
boolean |
Obtiene o establece como variable es secreta o no. |
| value |
string |
Obtiene y establece el valor de la variable de configuración. |
DataSourceBindingBase
Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.
| Nombre | Tipo | Description |
|---|---|---|
| callbackContextTemplate |
string |
Formato de paginación admitido por este origen de datos(ContinuationToken/SkipTop). |
| callbackRequiredTemplate |
string |
¿Se necesitan llamadas subsiguientes? |
| dataSourceName |
string |
Obtiene o establece el nombre del origen de datos. |
| endpointId |
string |
Obtiene o establece el identificador del punto de conexión. |
| endpointUrl |
string |
Obtiene o establece la dirección URL del punto de conexión de servicio. |
| headers |
Obtiene o establece los encabezados de autorización. |
|
| initialContextTemplate |
string |
Define el valor inicial de los parámetros de consulta. |
| parameters |
object |
Obtiene o establece los parámetros del origen de datos. |
| requestContent |
string |
Obtiene o establece el cuerpo de la solicitud HTTP. |
| requestVerb |
string |
Obtiene o establece el verbo de solicitud http. |
| resultSelector |
string |
Obtiene o establece el selector de resultados. |
| resultTemplate |
string |
Obtiene o establece la plantilla de resultado. |
| target |
string |
Obtiene o establece el destino del origen de datos. |
DeploymentAttempt
| Nombre | Tipo | Description |
|---|---|---|
| attempt |
integer |
Intento de implementación. |
| deploymentId |
integer |
Identificador de la implementación. |
| hasStarted |
boolean |
Especifica si la implementación se ha iniciado o no. |
| id |
integer |
Id. de implementación. |
| issues |
Issue[] |
Todos los problemas relacionados con la implementación. |
| lastModifiedBy |
Identidad que modificó esta implementación por última vez. |
|
| lastModifiedOn |
string |
Hora a la que se modificó por última vez esta implementación. |
| operationStatus |
Estado de la operación de implementación. |
|
| postDeploymentGates |
Después de las puertas de implementación que se ejecutaron en esta implementación. |
|
| preDeploymentGates |
Puertas de implementación previas que se ejecutaron en esta implementación. |
|
| queuedOn |
string |
Cuando esta implementación se pone en cola. |
| reason |
Motivo de la implementación. |
|
| releaseDeployPhases |
Lista de implementaciones de versión ejecutadas en esta implementación. |
|
| requestedBy |
Identidad que solicitó esta implementación. |
|
| requestedFor |
Identidad de esta implementación solicitada. |
|
| status |
estado de la implementación. |
DeploymentJob
| Nombre | Tipo | Description |
|---|---|---|
| job |
Tarea primaria de todas las tareas ejecutadas. |
|
| tasks |
Lista de tareas ejecutadas con en el trabajo. |
DeploymentOperationStatus
Obtiene el estado de operación de la implementación.
| Nombre | Tipo | Description |
|---|---|---|
| all |
string |
El estado de la operación de implementación es todo. |
| approved |
string |
Se aprueba el estado de la operación de implementación. |
| canceled |
string |
El estado de la operación de implementación se cancela. |
| cancelling |
string |
El estado de la operación de implementación se cancela. |
| deferred |
string |
El estado de la operación de implementación se aplaza. |
| evaluatingGates |
string |
El estado de la operación de implementación es EvaluatingGates. |
| gateFailed |
string |
El estado de la operación de implementación es GateFailed. |
| manualInterventionPending |
string |
El estado de la operación de implementación es manualintervention pendiente. |
| pending |
string |
El estado de la operación de implementación está pendiente. |
| phaseCanceled |
string |
El estado de la operación de implementación se cancela por fase. |
| phaseFailed |
string |
Error en el estado de la operación de implementación. |
| phaseInProgress |
string |
El estado de la operación de implementación está en curso. |
| phasePartiallySucceeded |
string |
El estado de la operación de implementación es la fase parcialmente correcta. |
| phaseSucceeded |
string |
El estado de la operación de implementación es la fase correcta. |
| queued |
string |
El estado de la operación de implementación está en cola. |
| queuedForAgent |
string |
El estado de la operación de implementación se pone en cola para el agente. |
| queuedForPipeline |
string |
El estado de la operación de implementación se pone en cola para la canalización. |
| rejected |
string |
Se rechaza el estado de la operación de implementación. |
| scheduled |
string |
El estado de la operación de implementación está programado. |
| undefined |
string |
El estado de la operación de implementación no está definido. |
DeploymentReason
Obtiene el motivo de la implementación.
| Nombre | Tipo | Description |
|---|---|---|
| automated |
string |
El motivo de implementación está automatizado. |
| manual |
string |
El motivo de implementación es manual. |
| none |
string |
El motivo de la implementación no es ninguno. |
| redeployTrigger |
string |
El motivo de implementación es RedeployTrigger. |
| scheduled |
string |
El motivo de implementación está programado. |
DeploymentStatus
Obtiene el estado de la implementación.
| Nombre | Tipo | Description |
|---|---|---|
| all |
string |
El estado de implementación es todo. |
| failed |
string |
Error en el estado de implementación. |
| inProgress |
string |
El estado de implementación está en curso. |
| notDeployed |
string |
El estado de implementación no se implementa. |
| partiallySucceeded |
string |
El estado de implementación se aplica parcialmente. |
| succeeded |
string |
El estado de implementación se realiza correctamente. |
| undefined |
string |
El estado de implementación no está definido. |
DeployPhase
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Obtiene y establece el nombre de la fase de implementación. |
| phaseType |
Indica el tipo de fase de implementación. |
|
| rank |
integer |
Obtiene y establece la clasificación de la fase de implementación. |
| refName |
string |
Obtiene y establece el nombre de referencia de la fase de implementación. |
| workflowTasks |
Obtiene y establece las tareas de flujo de trabajo para la fase de implementación. |
DeployPhaseStatus
Estado de la fase.
| Nombre | Tipo | Description |
|---|---|---|
| canceled |
string |
Ejecución de fase cancelada. |
| cancelling |
string |
La fase está en estado de cancelación. |
| failed |
string |
Error de ejecución de fase. |
| inProgress |
string |
Ejecución de fases en curso. |
| notStarted |
string |
No se inició la ejecución de fases. |
| partiallySucceeded |
string |
La ejecución de fase se realizó parcialmente correctamente. |
| skipped |
string |
Ejecución de fase omitida. |
| succeeded |
string |
La ejecución de fase se realizó correctamente. |
| undefined |
string |
Estado de fase no establecido. |
DeployPhaseTypes
Indica el tipo de fase de implementación.
| Nombre | Tipo | Description |
|---|---|---|
| agentBasedDeployment |
string |
Tipo de fase que contiene las tareas ejecutadas en el agente. |
| deploymentGates |
string |
Tipo de fase que contiene tareas que actúan como Gates para que la implementación continúe. |
| machineGroupBasedDeployment |
string |
Tipo de fase que contiene tareas ejecutadas en máquinas de grupo de implementación. |
| runOnServer |
string |
Tipo de fase que contiene las tareas ejecutadas por el servidor. |
| undefined |
string |
Tipo de fase no definido. No use este parámetro. |
EnvironmentOptions
| Nombre | Tipo | Description |
|---|---|---|
| autoLinkWorkItems |
boolean |
Obtiene y establece como elementos de trabajo de vínculo automático o no. |
| badgeEnabled |
boolean |
Obtiene y establece como distintivo habilitado o no. |
| publishDeploymentStatus |
boolean |
Obtiene y establece como estado de implementación de publicación o no. |
| pullRequestDeploymentEnabled |
boolean |
Obtiene y establece como la implementación de la solicitud de incorporación de cambios habilitada o no. |
EnvironmentStatus
Obtiene el estado del entorno.
| Nombre | Tipo | Description |
|---|---|---|
| canceled |
string |
El entorno está en estado cancelado. |
| inProgress |
string |
El entorno está en curso. |
| notStarted |
string |
El entorno no está en estado iniciado. |
| partiallySucceeded |
string |
El entorno está en estado parcialmente correcto. |
| queued |
string |
El entorno está en estado en cola. |
| rejected |
string |
El entorno está en estado rechazado. |
| scheduled |
string |
El entorno está en estado programado. |
| succeeded |
string |
El entorno está en estado correcto. |
| undefined |
string |
No se ha establecido el estado del entorno. |
GateStatus
Estado de las puertas de liberación.
| Nombre | Tipo | Description |
|---|---|---|
| canceled |
string |
Se canceló la ejecución de la puerta. |
| failed |
string |
Error en la ejecución de la puerta. |
| inProgress |
string |
La puerta está actualmente en curso. |
| none |
string |
La puerta no tiene establecido el estado. |
| pending |
string |
La puerta está en estado pendiente. |
| succeeded |
string |
La puerta se completó correctamente. |
IdentityRef
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo. |
|
| descriptor |
string |
El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones. |
| directoryAlias |
string |
En desuso: se puede recuperar consultando el usuario de Graph al que se hace referencia en la entrada "self" del diccionario IdentityRef "_links". |
| displayName |
string |
Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen. |
| id |
string |
|
| imageUrl |
string |
En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef |
| inactive |
boolean |
En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links". |
| isAadIdentity |
boolean |
En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef |
| uniqueName |
string |
En desuso: use Domain+PrincipalName en su lugar. |
| url |
string |
Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo. |
IgnoredGate
| Nombre | Tipo | Description |
|---|---|---|
| lastModifiedOn |
string |
Obtiene la fecha en la que se omite por última vez la puerta. |
| name |
string |
Nombre de la puerta omitida. |
Issue
| Nombre | Tipo | Description |
|---|---|---|
| data |
object |
Datos del problema. |
| issueType |
string |
Tipo de problema, por ejemplo, error, advertencia o información. |
| message |
string |
Mensaje de problema. |
ManualIntervention
| Nombre | Tipo | Description |
|---|---|---|
| approver |
Obtiene o establece la identidad que debe aprobar. |
|
| comments |
string |
Obtiene o establece comentarios para su aprobación. |
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| id |
integer |
Obtiene el identificador único para la intervención manual. |
| instructions |
string |
Obtiene o establece instrucciones para la aprobación. |
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| name |
string |
Obtiene o establece el nombre. |
| release |
Obtiene releaseReference para la intervención manual. |
|
| releaseDefinition |
Obtiene releaseDefinitionReference para la intervención manual. |
|
| releaseEnvironment |
Obtiene releaseEnvironmentReference para la intervención manual. |
|
| status |
Obtiene o establece el estado de la intervención manual. |
|
| taskInstanceId |
string |
Obtención del identificador de instancia de tarea. |
| url |
string |
Obtiene la dirección URL para acceder a la intervención manual. |
ManualInterventionStatus
Obtiene o establece el estado de la intervención manual.
| Nombre | Tipo | Description |
|---|---|---|
| approved |
string |
Se aprueba la intervención manual. |
| canceled |
string |
Se cancela la intervención manual. |
| pending |
string |
La intervención manual está pendiente. |
| rejected |
string |
Se rechaza la intervención manual. |
| unknown |
string |
La intervención manual no tiene el estado establecido. |
ProcessParameters
| Nombre | Tipo | Description |
|---|---|---|
| dataSourceBindings |
Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio. |
|
| inputs | ||
| sourceDefinitions |
ProjectReference
| Nombre | Tipo | Description |
|---|---|---|
| id |
string |
Obtiene el identificador único de este campo. |
| name |
string |
Obtiene el nombre del proyecto. |
PropertiesCollection
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object) excepto DBNull . Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
| Nombre | Tipo | Description |
|---|---|---|
| count |
integer |
Recuento de propiedades de la colección. |
| item |
object |
|
| keys |
string[] |
Conjunto de claves de la colección. |
| values |
string[] |
Conjunto de valores de la colección. |
ReferenceLinks
Clase que representa una colección de vínculos de referencia de REST.
| Nombre | Tipo | Description |
|---|---|---|
| links |
object |
Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
Release
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Obtiene vínculos para acceder a la versión. |
|
| artifacts |
Artifact[] |
Obtiene o establece la lista de artefactos. |
| comment |
string |
Obtiene o establece el comentario. |
| createdBy |
Obtiene o establece la identidad que creó. |
|
| createdFor |
Obtiene o establece la identidad para la que se creó la versión. |
|
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| definitionSnapshotRevision |
integer |
Obtiene el número de revisión de la instantánea de definición. |
| description |
string |
Obtiene o establece la descripción de la versión. |
| environments |
Obtiene la lista de entornos. |
|
| id |
integer |
Obtiene el identificador único de este campo. |
| keepForever |
boolean |
Si se va a excluir la versión de las directivas de retención. |
| logsContainerUrl |
string |
Obtiene la dirección URL del contenedor de registros. |
| modifiedBy |
Obtiene o establece la identidad que modificó. |
|
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| name |
string |
Obtiene el nombre. |
| poolName |
string |
Obtiene el nombre del grupo. |
| projectReference |
Obtiene o establece la referencia del proyecto. |
|
| properties |
La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un |
|
| reason |
Obtiene el motivo de la versión. |
|
| releaseDefinition |
Obtiene releaseDefinitionReference, que especifica la referencia de la definición de versión a la que está asociada esta versión. |
|
| releaseDefinitionRevision |
integer |
Obtiene o establece la revisión de definición de versión. |
| releaseNameFormat |
string |
Obtiene el formato de nombre de versión. |
| status |
Obtiene el estado. |
|
| tags |
string[] |
Obtiene o establece la lista de etiquetas. |
| triggeringArtifactAlias |
string |
|
| variableGroups |
Obtiene la lista de grupos de variables. |
|
| variables |
<string,
Configuration |
Obtiene o establece el diccionario de variables. |
ReleaseApproval
| Nombre | Tipo | Description |
|---|---|---|
| approvalType |
Obtiene o establece el tipo de aprobación. |
|
| approvedBy |
Obtiene la identidad que aprobó. |
|
| approver |
Obtiene o establece la identidad que debe aprobar. |
|
| attempt |
integer |
Obtiene o establece el intento que especifica el intento de implementación al que pertenece. |
| comments |
string |
Obtiene o establece comentarios para su aprobación. |
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| history |
Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación. |
|
| id |
integer |
Obtiene el identificador único de este campo. |
| isAutomated |
boolean |
Obtiene o establece como aprobación automatizada o no. |
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| rank |
integer |
Obtiene o establece la clasificación que especifica el orden de la aprobación. Por ejemplo, el mismo rango denota aprobación paralela. |
| release |
Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación. |
|
| releaseDefinition |
Obtiene releaseDefinitionReference, que especifica la referencia de la definición de versión a la que está asociada esta aprobación. |
|
| releaseEnvironment |
Obtiene releaseEnvironmentReference, que especifica la referencia del entorno de versión al que está asociada esta aprobación. |
|
| revision |
integer |
Obtiene el número de revisión. |
| status |
Obtiene o establece el estado de la aprobación. |
|
| url |
string |
Obtiene la dirección URL para acceder a la aprobación. |
ReleaseApprovalHistory
| Nombre | Tipo | Description |
|---|---|---|
| approver |
Identidad del aprobador. |
|
| changedBy |
Identidad del objeto que cambió la aprobación. |
|
| comments |
string |
Comentarios del historial de aprobación. |
| createdOn |
string |
Hora a la que se creó esta aprobación. |
| modifiedOn |
string |
Hora en que se modificó esta aprobación. |
| revision |
integer |
Revisión del historial de aprobación. |
ReleaseCondition
| Nombre | Tipo | Description |
|---|---|---|
| conditionType |
Obtiene o establece el tipo de condición. |
|
| name |
string |
Obtiene o establece el nombre de la condición. Por ejemplo, "ReleaseStarted". |
| result |
boolean |
Resultado de la condición de versión. |
| value |
string |
Obtiene o establece el valor de la condición. |
ReleaseDefinitionApprovals
| Nombre | Tipo | Description |
|---|---|---|
| approvalOptions |
Obtiene o establece las opciones de aprobación. |
|
| approvals |
Obtiene o establece las aprobaciones. |
ReleaseDefinitionApprovalStep
| Nombre | Tipo | Description |
|---|---|---|
| approver |
Obtiene y establece el aprobador. |
|
| id |
integer |
Identificador del paso de aprobación o implementación. |
| isAutomated |
boolean |
Indica si la aprobación está automatizada. |
| isNotificationOn |
boolean |
Indica si el conjunto de notificaciones de aprobación. |
| rank |
integer |
Obtiene o establece el rango del paso de aprobación. |
ReleaseDefinitionGate
| Nombre | Tipo | Description |
|---|---|---|
| tasks |
Obtiene o establece el flujo de trabajo de puertas. |
ReleaseDefinitionGatesOptions
| Nombre | Tipo | Description |
|---|---|---|
| isEnabled |
boolean |
Obtiene o establece como puertas habilitadas o no. |
| minimumSuccessDuration |
integer |
Obtiene o establece la duración mínima de los resultados constantes después de una evaluación correcta de las puertas. |
| samplingInterval |
integer |
Obtiene o establece el tiempo entre la reevaluación de las puertas. |
| stabilizationTime |
integer |
Obtiene o establece el retraso antes de la evaluación. |
| timeout |
integer |
Obtiene o establece el tiempo de espera después del cual se produce un error en las puertas. |
ReleaseDefinitionGatesStep
| Nombre | Tipo | Description |
|---|---|---|
| gates |
Obtiene o establece las puertas. |
|
| gatesOptions |
Obtiene o establece las opciones de puerta. |
|
| id |
integer |
Id. de ReleaseDefinitionGateStep. |
ReleaseDefinitionShallowReference
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión. |
|
| id |
integer |
Obtiene el identificador único de la definición de versión. |
| name |
string |
Obtiene o establece el nombre de la definición de versión. |
| path |
string |
Obtiene o establece la ruta de acceso de la definición de versión. |
| projectReference |
Obtiene o establece la referencia del proyecto. |
|
| url |
string |
Obtiene la dirección URL de la API rest para acceder a la definición de versión. |
ReleaseDeployPhase
| Nombre | Tipo | Description |
|---|---|---|
| deploymentJobs |
Trabajos de implementación de la fase. |
|
| errorLog |
string |
Registros de errores de ejecución de fases. |
| manualInterventions |
Lista de información de ejecución de tareas de intervención manual en fase. |
|
| name |
string |
Nombre de la fase. |
| phaseId |
string |
Identificador de la fase. |
| phaseType |
Tipo de la fase. |
|
| rank |
integer |
Clasificación de la fase. |
| runPlanId |
string |
Ejecute el identificador del plan de la fase. |
| startedOn |
string |
Hora de inicio de la fase. |
| status |
Estado de la fase. |
ReleaseEnvironment
| Nombre | Tipo | Description |
|---|---|---|
| conditions |
Obtiene la lista de condiciones. |
|
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| definitionEnvironmentId |
integer |
Obtiene el identificador de entorno de definición. |
| deployPhasesSnapshot |
Obtiene la lista de instantáneas de fases de implementación. |
|
| deploySteps |
Obtiene los pasos de implementación. |
|
| environmentOptions |
Obtiene las opciones de entorno. |
|
| id |
integer |
Obtiene el identificador único de este campo. |
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| name |
string |
Obtiene el nombre. |
| nextScheduledUtcTime |
string |
Obtiene la siguiente hora UTC programada. |
| owner |
Obtiene la identidad que es propietaria del entorno de versión. |
|
| postApprovalsSnapshot |
Obtiene la lista de instantáneas posteriores a la implementación. |
|
| postDeployApprovals |
Obtiene la lista de aprobaciones posteriores a la implementación. |
|
| postDeploymentGatesSnapshot |
Después de la implementación, se aplican los datos de instantáneas. |
|
| preApprovalsSnapshot |
Obtiene la lista de instantáneas de aprobaciones de implementación previa. |
|
| preDeployApprovals |
Obtiene la lista de aprobaciones de implementación previa. |
|
| preDeploymentGatesSnapshot |
Datos de instantáneas anteriores a la implementación. |
|
| processParameters |
Obtiene los parámetros de proceso. |
|
| rank |
integer |
Obtiene la clasificación. |
| release |
Obtiene la referencia de versión que especifica la referencia de la versión a la que está asociado este entorno de versión. |
|
| releaseCreatedBy |
Obtiene la identidad que creó la versión. |
|
| releaseDefinition |
Obtiene releaseDefinitionReference, que especifica la referencia de la definición de versión a la que está asociado este entorno de versión. |
|
| releaseId |
integer |
Obtiene el identificador de versión. |
| scheduledDeploymentTime |
string |
Obtiene la hora de implementación de la programación del entorno de lanzamiento. |
| schedules |
Obtiene la lista de programaciones. |
|
| status |
Obtiene el estado del entorno. |
|
| timeToDeploy |
number |
Obtiene el tiempo de implementación. |
| triggerReason |
string |
Obtiene el motivo del desencadenador. |
| variableGroups |
Obtiene la lista de grupos de variables. |
|
| variables |
<string,
Configuration |
Obtiene el diccionario de variables. |
ReleaseEnvironmentShallowReference
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión. |
|
| id |
integer |
Obtiene el identificador único del entorno de versión. |
| name |
string |
Obtiene o establece el nombre del entorno de versión. |
| url |
string |
Obtiene la dirección URL de la API rest para acceder al entorno de versión. |
ReleaseGates
| Nombre | Tipo | Description |
|---|---|---|
| deploymentJobs |
Contiene los detalles del trabajo de puertas de cada evaluación. |
|
| id |
integer |
Identificador de las puertas de liberación. |
| ignoredGates |
Lista de puertas ignoradas. |
|
| lastModifiedOn |
string |
Hora de última modificación de Gates. |
| runPlanId |
string |
Identificador del plan de ejecución de las puertas. |
| stabilizationCompletedOn |
string |
La estabilización de puertas completó la fecha y hora. |
| startedOn |
string |
Hora de inicio de la evaluación de Gates. |
| status |
Estado de las puertas de liberación. |
|
| succeedingSince |
string |
Fecha y hora en la que todas las puertas se ejecutaron correctamente. |
ReleaseReason
Obtiene el motivo de la versión.
| Nombre | Tipo | Description |
|---|---|---|
| continuousIntegration |
string |
Indica la versión desencadenada por la integración continua. |
| manual |
string |
Indica la versión desencadenada manualmente. |
| none |
string |
Indica el motivo desencadenado por la versión que no se ha establecido. |
| pullRequest |
string |
Indica la versión desencadenada por PullRequest. |
| schedule |
string |
Indica la versión desencadenada por programación. |
ReleaseSchedule
| Nombre | Tipo | Description |
|---|---|---|
| daysToRelease |
Días de la semana que se van a publicar. |
|
| jobId |
string |
Id. de trabajo de definición de trabajo de Team Foundation. |
| scheduleOnlyWithChanges |
boolean |
Marca para determinar si esta programación solo debe liberarse si se ha cambiado el artefacto asociado o se ha cambiado la definición de versión. |
| startHours |
integer |
Hora de zona horaria local que se va a iniciar. |
| startMinutes |
integer |
Minuto de zona horaria local que se va a iniciar. |
| timeZoneId |
string |
Id. de zona horaria de la programación de versión, como "UTC". |
ReleaseShallowReference
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Obtiene los vínculos a recursos, API y vistas relacionados para la versión. |
|
| id |
integer |
Obtiene el identificador único de la versión. |
| name |
string |
Obtiene o establece el nombre de la versión. |
| url |
string |
Obtiene la dirección URL de la API de REST para acceder a la versión. |
ReleaseStatus
Obtiene el estado.
| Nombre | Tipo | Description |
|---|---|---|
| abandoned |
string |
El estado de la versión está abandonado. |
| active |
string |
El estado de la versión está activo. |
| draft |
string |
La versión está en estado de borrador. |
| undefined |
string |
Estado de versión no establecido. |
ReleaseTask
| Nombre | Tipo | Description |
|---|---|---|
| agentName |
string |
Nombre del agente en el que se ejecutó la tarea. |
| finishTime |
string |
Hora de finalización de la tarea de versión. |
| id |
integer |
Id. de la tarea de versión. |
| issues |
Issue[] |
Lista de problemas que se produjeron durante la ejecución de la tarea. |
| lineCount |
integer |
Número de líneas que tiene la tarea de liberación del registro. |
| logUrl |
string |
Dirección URL de registro de la tarea. |
| name |
string |
Nombre de la tarea. |
| percentComplete |
integer |
La ejecución de la tarea se completó previamente. |
| rank |
integer |
Clasificación de la tarea de versión. |
| resultCode |
string |
Código de resultado de la tarea. |
| startTime |
string |
Id. de la tarea de versión. |
| status |
Estado de la tarea de versión. |
|
| task |
Referencia de tareas de flujo de trabajo. |
|
| timelineRecordId |
string |
Id. de registro de escala de tiempo de la tarea de versión. |
ScheduleDays
Días de la semana que se van a publicar.
| Nombre | Tipo | Description |
|---|---|---|
| all |
string |
Programado en todos los días de la semana. |
| friday |
string |
Programado el viernes. |
| monday |
string |
Programado el lunes. |
| none |
string |
No se ha establecido el día programado. |
| saturday |
string |
Programado el sábado. |
| sunday |
string |
Programado el domingo. |
| thursday |
string |
Programado el jueves. |
| tuesday |
string |
Programado el martes. |
| wednesday |
string |
Programado el miércoles. |
TaskInputDefinitionBase
| Nombre | Tipo | Description |
|---|---|---|
| aliases |
string[] |
|
| defaultValue |
string |
|
| groupName |
string |
|
| helpMarkDown |
string |
|
| label |
string |
|
| name |
string |
|
| options |
object |
|
| properties |
object |
|
| required |
boolean |
|
| type |
string |
|
| validation | ||
| visibleRule |
string |
TaskInputValidation
| Nombre | Tipo | Description |
|---|---|---|
| expression |
string |
Expresión condicional |
| message |
string |
Mensaje que explica cómo el usuario puede corregir si se produce un error en la validación |
TaskSourceDefinitionBase
| Nombre | Tipo | Description |
|---|---|---|
| authKey |
string |
|
| endpoint |
string |
|
| keySelector |
string |
|
| selector |
string |
|
| target |
string |
TaskStatus
Estado de la tarea de versión.
| Nombre | Tipo | Description |
|---|---|---|
| canceled |
string |
La ejecución de la tarea se canceló. |
| failed |
string |
Error en la ejecución de la tarea. |
| failure |
string |
Error en la ejecución de la tarea. |
| inProgress |
string |
La tarea está actualmente en curso. |
| partiallySucceeded |
string |
La ejecución de la tarea se realizó parcialmente correctamente. |
| pending |
string |
La tarea está en estado pendiente. |
| skipped |
string |
Se omitió la ejecución de la tarea. |
| succeeded |
string |
La tarea se completó correctamente. |
| success |
string |
La tarea se completó correctamente. |
| unknown |
string |
La tarea no tiene establecido el estado. |
VariableGroup
| Nombre | Tipo | Description |
|---|---|---|
| createdBy |
Obtiene o establece la identidad que creó. |
|
| createdOn |
string |
Obtiene la fecha en la que se creó. |
| description |
string |
Obtiene o establece la descripción. |
| id |
integer |
Obtiene el identificador único de este campo. |
| isShared |
boolean |
Indica si un grupo de variables se comparte con otro proyecto o no. |
| modifiedBy |
Obtiene o establece la identidad que modificó. |
|
| modifiedOn |
string |
Obtiene la fecha en la que se modificó. |
| name |
string |
Obtiene o establece el nombre. |
| providerData |
Obtiene o establece los datos del proveedor. |
|
| type |
string |
Obtiene o establece el tipo. |
| variableGroupProjectReferences |
todas las referencias de proyecto en las que el grupo de variables se comparte con otros proyectos. |
|
| variables |
<string,
Variable |
Obtiene y establece el diccionario de variables. |
VariableGroupProjectReference
Una referencia de grupo de variables es una referencia superficial al grupo de variables.
| Nombre | Tipo | Description |
|---|---|---|
| description |
string |
Obtiene o establece la descripción del grupo de variables. |
| name |
string |
Obtiene o establece el nombre del grupo de variables. |
| projectReference |
Obtiene o establece la referencia de proyecto del grupo de variables. |
VariableGroupProviderData
VariableValue
| Nombre | Tipo | Description |
|---|---|---|
| isReadOnly |
boolean |
Obtiene o establece si la variable es de solo lectura o no. |
| isSecret |
boolean |
Obtiene o establece como la variable es secreta o no. |
| value |
string |
Obtiene o establece el valor. |
WorkflowTask
| Nombre | Tipo | Description |
|---|---|---|
| alwaysRun |
boolean |
Obtiene o establece como la tarea siempre se ejecuta o no. |
| condition |
string |
Obtiene o establece la condición de tarea. |
| continueOnError |
boolean |
Obtiene o establece cuando la tarea continúa ejecutándose en caso de error o no. |
| definitionType |
string |
Obtiene o establece el tipo de definición de tarea. Ejemplo: 'Agent', DeploymentGroup', 'Server' o 'ServerGate'. |
| enabled |
boolean |
Obtiene o establece como la tarea habilitada o no. |
| environment |
object |
Obtiene o establece las variables de entorno de tareas. |
| inputs |
object |
Obtiene o establece las entradas de la tarea. |
| name |
string |
Obtiene o establece el nombre de la tarea. |
| overrideInputs |
object |
Obtiene o establece las entradas de invalidación de la tarea. |
| refName |
string |
Obtiene o establece el nombre de referencia de la tarea. |
| retryCountOnTaskFailure |
integer |
Obtiene o establece el valor retryCount de la tarea. |
| taskId |
string |
Obtiene o establece el identificador de la tarea. |
| timeoutInMinutes |
integer |
Obtiene o establece el tiempo de espera de la tarea. |
| version |
string |
Obtiene o establece la versión de la tarea. |
WorkflowTaskReference
| Nombre | Tipo | Description |
|---|---|---|
| id |
string |
Identificador de tarea. |
| name |
string |
Nombre de la tarea. |
| version |
string |
Versión de la tarea. |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de