Definitions - Create
Creación de una definición de versión
POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4
Pará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 |
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.4" para usar esta versión de la API. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene los vínculos a recursos, API y vistas relacionados para la definición de 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ó. |
|
createdOn |
string |
Obtiene la fecha en la que se creó. |
description |
string |
Obtiene o establece la descripción. |
environments |
Obtiene o establece la lista de entornos. |
|
id |
integer |
Obtiene el identificador único de la definición de versión. |
isDeleted |
boolean |
Si se elimina la definición de versión. |
lastRelease |
Obtiene la referencia de la última versión. |
|
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 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. |
|
properties |
Obtiene o establece propiedades. |
|
releaseNameFormat |
string |
Obtiene o establece el formato de nombre de versión. |
revision |
integer |
Obtiene el número de revisión. |
source |
Obtiene o establece el origen de la definición de versión. |
|
tags |
string[] |
Obtiene o establece la lista de etiquetas. |
triggers |
Obtiene o establece la lista de desencadenadores. |
|
url |
string |
Obtiene la dirección URL de la API rest para acceder a la definición de versión. |
variableGroups |
integer[] |
Obtiene o establece 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
Create release definition
Sample Request
POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4
{
"source": "undefined",
"revision": 1,
"description": null,
"createdBy": null,
"createdOn": "0001-01-01T00:00:00",
"modifiedBy": null,
"modifiedOn": "0001-01-01T00:00:00",
"isDeleted": false,
"variables": {},
"variableGroups": [],
"environments": [
{
"id": 0,
"name": "PROD",
"variables": {},
"variableGroups": [],
"preDeployApprovals": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"displayName": null,
"id": "aeb95c63-4fac-4948-84ce-711b0a9dda97"
},
"id": 0
}
]
},
"postDeployApprovals": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deployPhases": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {},
"queueId": 15,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": []
}
],
"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": [],
"executionPolicy": {
"concurrencyCount": 0,
"queueDepthCount": 0
},
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
},
"properties": {},
"preDeploymentGates": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGates": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"environmentTriggers": []
}
],
"artifacts": [],
"triggers": [],
"releaseNameFormat": null,
"tags": [],
"properties": {},
"id": 0,
"name": "Fabrikam-web",
"projectReference": null,
"_links": {}
}
Sample Response
{
"source": "restApi",
"revision": 1,
"description": null,
"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"
},
"createdOn": "2018-12-11T04:56:42.237Z",
"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"
},
"modifiedOn": "2018-12-11T04:56:42.237Z",
"isDeleted": false,
"variables": {},
"variableGroups": [],
"environments": [
{
"id": 42,
"name": "PROD",
"rank": 1,
"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"
},
"variables": {},
"variableGroups": [],
"preDeployApprovals": {
"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": 124
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMinutes": 0,
"executionOrder": "beforeGates"
}
},
"deployStep": {
"id": 125
},
"postDeployApprovals": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 126
}
]
},
"deployPhases": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"artifactsDownloadInput": {
"downloadInputs": []
},
"queueId": 15,
"demands": [],
"enableAccessToken": false,
"timeoutInMinutes": 0,
"jobCancelTimeoutInMinutes": 1,
"condition": "succeeded()",
"overrideInputs": {}
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"refName": null,
"workflowTasks": []
}
],
"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": [],
"executionPolicy": {
"concurrencyCount": 0,
"queueDepthCount": 0
},
"schedules": [],
"currentRelease": {
"id": 0,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
"_links": {}
},
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
},
"properties": {},
"preDeploymentGates": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"postDeploymentGates": {
"id": 0,
"gatesOptions": null,
"gates": []
},
"environmentTriggers": [],
"badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/42/42"
}
],
"artifacts": [],
"triggers": [],
"releaseNameFormat": "",
"tags": [],
"properties": {},
"id": 42,
"name": "Fabrikam-web",
"path": "\\",
"projectReference": null,
"url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42",
"_links": {
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42"
},
"web": {
"href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=42"
}
}
}
Definiciones
Nombre | Description |
---|---|
Approval |
Orden de ejecución de aprobaciones. |
Approval |
|
Artifact | |
Artifact |
|
Authorization |
|
Condition | |
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. |
Demand | |
Deploy |
|
Deploy |
Indica el tipo de fase de implementación. |
Environment |
Define la directiva en cola del entorno en Release Management cola lateral. Enviaremos al ejecutor del entorno [creación de implementación previa y otros pasos] solo cuando se cumplan las directivas mencionadas. |
Environment |
|
Environment |
|
Environment |
|
Environment |
Obtiene o establece el tipo de desencadenador. |
Identity |
|
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 ) |
Reference |
Clase que se va a representar una colección de vínculos de referencia de REST. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Obtiene o establece el origen de la definición de versión. |
Release |
Obtiene el motivo de la versión. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Tipo de desencadenador de versión. |
Schedule |
Días de la semana que se van a publicar. |
Task |
|
Task |
|
Task |
|
Workflow |
ApprovalExecutionOrder
Orden de ejecución de aprobaciones.
Nombre | Tipo | Description |
---|---|---|
afterGatesAlways |
string |
Las aprobaciones siempre se muestran después de la ejecución de puertas. |
afterSuccessfulGates |
string |
Aprobaciones mostradas 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. |
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 mediante la 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 |
Condition
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". |
value |
string |
Obtiene o establece el valor de la condición. |
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 una variable se puede invalidar 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 compatible con este origen de datos (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
¿Se necesitan llamadas posteriores? |
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. |
Demand
Nombre | Tipo | Description |
---|---|---|
name |
string |
Obtiene y establece el nombre de la demanda. |
value |
string |
Obtiene y establece el valor de la demanda. |
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. |
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 Puertas para que la implementación avance. |
machineGroupBasedDeployment |
string |
Tipo de fase que contiene las tareas ejecutadas en las máquinas del 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. |
EnvironmentExecutionPolicy
Define la directiva en cola del entorno en Release Management cola lateral. Enviaremos al ejecutor del entorno [creación de implementación previa y otros pasos] solo cuando se cumplan las directivas mencionadas.
Nombre | Tipo | Description |
---|---|---|
concurrencyCount |
integer |
Esta directiva decide cuántos entornos serían con El ejecutor del entorno. |
queueDepthCount |
integer |
Profundidad de la cola en la tabla EnvironmentQueue, esta tabla mantiene las entradas de entorno hasta que Environment Runner esté libre [según la directiva] para tomar otro entorno para su ejecución. |
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. |
EnvironmentRetentionPolicy
Nombre | Tipo | Description |
---|---|---|
daysToKeep |
integer |
Obtiene y establece el número de días que se conservará el entorno. |
releasesToKeep |
integer |
Obtiene y establece el número de versiones que se van a conservar. |
retainBuild |
boolean |
Obtiene y establece como la compilación que se va a conservar o no. |
EnvironmentTrigger
Nombre | Tipo | Description |
---|---|---|
definitionEnvironmentId |
integer |
Identificador de entorno de definición en el que se aplica este desencadenador. |
releaseDefinitionId |
integer |
ReleaseDefinition ID en el que se aplica este desencadenador. |
triggerContent |
string |
Obtiene o establece el contenido del desencadenador. |
triggerType |
Obtiene o establece el tipo de desencadenador. |
EnvironmentTriggerType
Obtiene o establece el tipo de desencadenador.
Nombre | Tipo | Description |
---|---|---|
deploymentGroupRedeploy |
string |
El tipo de desencadenador de entorno es la reimplementación del grupo de implementación. |
rollbackRedeploy |
string |
El tipo de desencadenador de entorno es Rollback. |
undefined |
string |
Tipo de desencadenador de entorno no definido. |
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 al 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. |
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 ) 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 una cadena. 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 se va a representar una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
ReleaseDefinition
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene los vínculos a recursos, API y vistas relacionados para la definición de 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ó. |
|
createdOn |
string |
Obtiene la fecha en la que se creó. |
description |
string |
Obtiene o establece la descripción. |
environments |
Obtiene o establece la lista de entornos. |
|
id |
integer |
Obtiene el identificador único de la definición de versión. |
isDeleted |
boolean |
Si se elimina la definición de versión. |
lastRelease |
Obtiene la referencia de la última versión. |
|
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 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. |
|
properties |
Obtiene o establece propiedades. |
|
releaseNameFormat |
string |
Obtiene o establece el formato de nombre de versión. |
revision |
integer |
Obtiene el número de revisión. |
source |
Obtiene o establece el origen de la definición de versión. |
|
tags |
string[] |
Obtiene o establece la lista de etiquetas. |
triggers |
Obtiene o establece la lista de desencadenadores. |
|
url |
string |
Obtiene la dirección URL de la API REST para acceder a la definición de versión. |
variableGroups |
integer[] |
Obtiene o establece la lista de grupos de variables. |
variables |
<string,
Configuration |
Obtiene o establece el diccionario de variables. |
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. |
ReleaseDefinitionDeployStep
Nombre | Tipo | Description |
---|---|---|
id |
integer |
Identificador del paso de aprobación o implementación. |
tasks |
Lista de pasos para esta definición. |
ReleaseDefinitionEnvironment
Nombre | Tipo | Description |
---|---|---|
badgeUrl |
string |
Obtiene o establece badgeUrl. BadgeUrl se usará cuando se habilite El distintivo en el entorno de definición de versión. |
conditions |
Obtiene o establece las condiciones del entorno. |
|
currentRelease |
Obtiene o establece la referencia de versión actual. |
|
demands |
Demand[] |
Obtiene o establece las demandas. |
deployPhases |
Obtiene o establece las fases de implementación del entorno. |
|
deployStep |
Obtiene o establece el elemento deploystep. |
|
environmentOptions |
Obtiene o establece las opciones de entorno. |
|
environmentTriggers |
Obtiene o establece los desencadenadores en el entorno. |
|
executionPolicy |
Obtiene o establece la directiva de ejecución del entorno. |
|
id |
integer |
Obtiene y establece el identificador del entorno ReleaseDefinitionEnvironment. |
name |
string |
Obtiene y establece el nombre del entorno ReleaseDefinitionEnvironment. |
owner |
Obtiene y establece el propietario del entorno ReleaseDefinitionEnvironment. |
|
postDeployApprovals |
Obtiene o establece las aprobaciones posteriores a la implementación. |
|
postDeploymentGates |
Obtiene o establece las puertas posteriores a la implementación. |
|
preDeployApprovals |
Obtiene o establece las aprobaciones previas a la implementación. |
|
preDeploymentGates |
Obtiene o establece las puertas de implementación previas. |
|
processParameters |
Obtiene o establece los parámetros del proceso de entorno. |
|
properties |
Obtiene o establece las propiedades del entorno. |
|
queueId |
integer |
Obtiene o establece el identificador de cola. |
rank |
integer |
Obtiene y establece el rango de ReleaseDefinitionEnvironment. |
retentionPolicy |
Obtiene o establece la directiva de retención del entorno. |
|
schedules |
Obtiene o establece las programaciones. |
|
variableGroups |
integer[] |
Obtiene o establece los grupos de variables. |
variables |
<string,
Configuration |
Obtiene y establece las variables. |
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 estables 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. |
ReleaseDefinitionSource
Obtiene o establece el origen de la definición de versión.
Nombre | Tipo | Description |
---|---|---|
ibiza |
string |
Indica ReleaseDefinition creado a partir de Ibiza. |
portalExtensionApi |
string |
Indica ReleaseDefinition creado a partir de PortalExtension API. |
restApi |
string |
Indica ReleaseDefinition creado mediante la API REST. |
undefined |
string |
Indica el origen ReleaseDefinition no definido. |
userInterface |
string |
Indica ReleaseDefinition creado mediante la interfaz de usuario. |
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. |
ReleaseReference
Nombre | Tipo | Description |
---|---|---|
_links |
Obtiene vínculos para acceder a la versión. |
|
artifacts |
Artifact[] |
Obtiene la lista de artefactos. |
createdBy |
Obtiene la identidad que creó la versión. |
|
createdOn |
string |
Obtiene la fecha en la que se creó esta versión. |
description |
string |
Obtiene la descripción. |
id |
integer |
Identificador de la versión. |
modifiedBy |
Obtiene la identidad que modificó la versión. |
|
name |
string |
Obtiene el nombre de la versión. |
reason |
Obtiene el motivo de la versión. |
|
releaseDefinition |
Obtiene una referencia superficial de definición de versió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. |
ReleaseTriggerBase
Nombre | Tipo | Description |
---|---|---|
triggerType |
Tipo de desencadenador de versión. |
ReleaseTriggerType
Tipo de desencadenador de versión.
Nombre | Tipo | Description |
---|---|---|
artifactSource |
string |
Desencadenador de versión basado en artefactos. |
containerImage |
string |
Desencadenador de versión basado en imágenes de contenedor. |
package |
string |
Desencadenador de versión basado en paquetes. |
pullRequest |
string |
Desencadenador de versión basado en solicitudes de incorporación de cambios. |
schedule |
string |
Desencadenador de versión basado en programación. |
sourceRepo |
string |
Desencadenador de versión basado en el repositorio de origen. |
undefined |
string |
Tipo de desencadenador de versión no establecido. |
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 |
Día programado no establecido. |
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 |
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. |
Comentarios
https://aka.ms/ContentUserFeedback.
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:Enviar y ver comentarios de