Partager via

Definitions - Create

  • Référence
Service:
Release
API Version:
5.0

Création d’une définition de version

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=5.0

Paramètres URI

Nom Dans Obligatoire Type Description
organization
 path True

string

Nom de l’organisation Azure DevOps.
project
 path True

string

ID de projet ou nom du projet
api-version
 query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 5.0 » pour utiliser cette version de l’API.

Corps de la demande

Nom Type Description
_links

ReferenceLinks

Obtient les liens vers les ressources, LES API et les vues associées pour la définition de mise en production.
artifacts

Artifact[]

Obtient ou définit la liste des artefacts.
comment

string

Obtient ou définit un commentaire.
createdBy

IdentityRef

Obtient ou définit l’identité qui a créé.
createdOn

string

Obtient la date à laquelle il a été créé.
description

string

Obtient ou définit la description.
environments

ReleaseDefinitionEnvironment[]

Obtient ou définit la liste des environnements.
id

integer

Obtient l’identificateur unique de la définition de mise en production.
isDeleted

boolean

Indique si la définition de mise en production est supprimée.
lastRelease

ReleaseReference

Obtient la référence de la dernière version.
modifiedBy

IdentityRef

Obtient ou définit l’identité qui a été modifiée.
modifiedOn

string

Obtient la date à laquelle il a été modifié.
name

string

Obtient ou définit le nom de la définition de mise en production.
path

string

Obtient ou définit le chemin d’accès de la définition de mise en production.
projectReference

ProjectReference

Obtient ou définit une référence de projet.
properties

PropertiesCollection

Obtient ou définit les propriétés.
releaseNameFormat

string

Obtient ou définit le format de nom de mise en production.
revision

integer

Obtient le numéro de révision.
source

ReleaseDefinitionSource

Obtient ou définit la source de définition de mise en production.
tags

string[]

Obtient ou définit la liste des balises.
triggers

ReleaseTriggerBase[]

Obtient ou définit la liste des déclencheurs.
url

string

Obtient l’URL de l’API REST pour accéder à la définition de mise en production.
variableGroups

integer[]

Obtient ou définit la liste des groupes de variables.
variables

<string,  ConfigurationVariableValue>

Obtient ou définit le dictionnaire des variables.

Réponses

Nom Type Description
200 OK

ReleaseDefinition

opération réussie

Sécurité

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

Nom Description
vso.release_execute Accorde la possibilité de lire et de mettre à jour les artefacts de mise en production, notamment les versions, les définitions de mise en production et l’envrion de mise en production, ainsi que la possibilité de mettre en file d’attente une nouvelle version.

Définitions

Nom Description
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType

Obtient ou définit le type de condition.
ConfigurationVariableValue
DataSourceBindingBase

Représente la liaison de la source de données pour la demande de point de terminaison de service.
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy

Définit la stratégie de mise en file d’attente de l’environnement sur Release Management file d’attente côté. Nous enverrons à l’Exécuteur d’environnement [création de prédéployer et d’autres étapes] uniquement lorsque les stratégies mentionnées sont satisfaites.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
ReferenceLinks

Classe pour représenter une collection de liens de référence REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource

Obtient ou définit la source de définition de mise en production.
ReleaseReason

Obtient le motif de la mise en production.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays

Jours de la semaine à publier
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Nom Type Description
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalOptions

Nom Type Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

Artifact

Nom Type Description
alias

string

Obtient ou définit l’alias.
definitionReference

<string,  ArtifactSourceReference>

Obtient ou définit une référence de définition. Par exemple, {"project »:{"id »:"fed755ea-49c5-4399-acea-fd5b5aa90a6c »,"name »:"myProject"},"definition »:{"id »:"1 »,"name »:"mybuildDefinition"},"connection »:{"id »:"1 »,"name »:"myConnection"}}
isPrimary

boolean

Obtient ou définit en tant qu’artefact principal ou non.
isRetained

boolean

type

string

Obtient ou définit le type. Il peut avoir la valeur « Build », « Jenkins », « GitHub », « Nuget », « Team Build (externe) », « ExternalTFSBuild », « Git », « TFVC », « ExternalTfsXamlBuild ».

ArtifactSourceReference

Nom Type Description
id

string

name

string

AuthorizationHeader

Nom Type Description
name

string

value

string

Condition

Nom Type Description
conditionType

ConditionType

Obtient ou définit le type de condition.
name

string

Obtient ou définit le nom de la condition. Par exemple, « ReleaseStarted ».
value

string

Obtient ou définit la valeur de la condition.

ConditionType

Obtient ou définit le type de condition.

Nom Type Description
artifact

string

Le type de condition est artefact.
environmentState

string

Le type de condition est l’état de l’environnement.
event

string

Le type de condition est event.
undefined

string

Le type de condition n’est pas défini.

ConfigurationVariableValue

Nom Type Description
allowOverride

boolean

Obtient ou définit si une variable peut être remplacée au moment du déploiement ou non.
isSecret

boolean

Obtient ou définit en tant que variable secrète ou non.
value

string

Obtient ou définit la valeur de la variable de configuration.

DataSourceBindingBase

Représente la liaison de la source de données pour la demande de point de terminaison de service.

Nom Type Description
callbackContextTemplate

string

Format de pagination pris en charge par cette source de données (ContinuationToken/SkipTop).
callbackRequiredTemplate

string

Appels suivants nécessaires ?
dataSourceName

string

Obtient ou définit le nom de la source de données.
endpointId

string

Obtient ou définit l’ID de point de terminaison.
endpointUrl

string

Obtient ou définit l’URL du point de terminaison de service.
headers

AuthorizationHeader[]

Obtient ou définit les en-têtes d’autorisation.
initialContextTemplate

string

Définit la valeur initiale des analyseurs de requête
parameters

object

Obtient ou définit les paramètres de la source de données.
resultSelector

string

Obtient ou définit le sélecteur de résultats.
resultTemplate

string

Obtient ou définit le modèle de résultat.
target

string

Obtient ou définit la cible de la source de données.

Demand

Nom Type Description
name

string

value

string

DeployPhase

Nom Type Description
name

string

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseTypes

Nom Type Description
agentBasedDeployment

string

deploymentGates

string

Type de phase qui contient des tâches qui jouent le rôle de portes pour le déploiement.
machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentExecutionPolicy

Définit la stratégie de mise en file d’attente de l’environnement sur Release Management file d’attente côté. Nous enverrons à l’Exécuteur d’environnement [création de prédéployer et d’autres étapes] uniquement lorsque les stratégies mentionnées sont satisfaites.

Nom Type Description
concurrencyCount

integer

Cette stratégie détermine le nombre d’environnements avec l’Exécuteur d’environnement.
queueDepthCount

integer

Profondeur de la file d’attente dans la table EnvironmentQueue, cette table conserve les entrées d’environnement jusqu’à ce que l’Exécuteur d’environnement soit libre [conformément à sa stratégie] d’utiliser un autre environnement pour l’exécution.

EnvironmentOptions

Nom Type Description
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentRetentionPolicy

Nom Type Description
daysToKeep

integer

releasesToKeep

integer

retainBuild

boolean

EnvironmentTrigger

Nom Type Description
definitionEnvironmentId

integer

releaseDefinitionId

integer

triggerContent

string

triggerType

EnvironmentTriggerType

EnvironmentTriggerType

Nom Type Description
deploymentGroupRedeploy

string

rollbackRedeploy

string

undefined

string

IdentityRef

Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor

string

Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias

string

displayName

string

Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ProcessParameters

Nom Type Description
dataSourceBindings

DataSourceBindingBase[]

Représente la liaison de la source de données pour la demande de point de terminaison de service.
inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Nom Type Description
id

string

Obtient l’identificateur unique de ce champ.
name

string

Obtient le nom du projet.

PropertiesCollection

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.

Nom Type Description
count

integer

Nombre de propriétés dans la collection.
item

object

keys

string[]

Ensemble de clés dans la collection.
values

string[]

Ensemble de valeurs dans la collection.

Classe pour représenter une collection de liens de référence REST.

Nom Type Description
links

object

Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ReleaseDefinition

Nom Type Description
_links

ReferenceLinks

Obtient les liens vers les ressources, LES API et les vues associées pour la définition de mise en production.
artifacts

Artifact[]

Obtient ou définit la liste des artefacts.
comment

string

Obtient ou définit un commentaire.
createdBy

IdentityRef

Obtient ou définit l’identité créée.
createdOn

string

Obtient la date à laquelle il a été créé.
description

string

Obtient ou définit la description.
environments

ReleaseDefinitionEnvironment[]

Obtient ou définit la liste des environnements.
id

integer

Obtient l’identificateur unique de la définition de mise en production.
isDeleted

boolean

Indique si la définition de mise en production est supprimée.
lastRelease

ReleaseReference

Obtient la référence de la dernière version.
modifiedBy

IdentityRef

Obtient ou définit l’identité qui a été modifiée.
modifiedOn

string

Obtient la date à laquelle il a été modifié.
name

string

Obtient ou définit le nom de la définition de mise en production.
path

string

Obtient ou définit le chemin d’accès de la définition de mise en production.
projectReference

ProjectReference

Obtient ou définit une référence de projet.
properties

PropertiesCollection

Obtient ou définit des propriétés.
releaseNameFormat

string

Obtient ou définit le format de nom de mise en production.
revision

integer

Obtient le numéro de révision.
source

ReleaseDefinitionSource

Obtient ou définit la source de définition de mise en production.
tags

string[]

Obtient ou définit la liste des balises.
triggers

ReleaseTriggerBase[]

Obtient ou définit la liste des déclencheurs.
url

string

Obtient l’URL de l’API REST pour accéder à la définition de mise en production.
variableGroups

integer[]

Obtient ou définit la liste des groupes de variables.
variables

<string,  ConfigurationVariableValue>

Obtient ou définit le dictionnaire de variables.

ReleaseDefinitionApprovals

Nom Type Description
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Nom Type Description
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionDeployStep

Nom Type Description
id

integer

tasks

WorkflowTask[]

Liste des étapes de cette définition.

ReleaseDefinitionEnvironment

Nom Type Description
badgeUrl

string

conditions

Condition[]

currentRelease

ReleaseShallowReference

demands

Demand[]

deployPhases

DeployPhase[]

deployStep

ReleaseDefinitionDeployStep

environmentOptions

EnvironmentOptions

environmentTriggers

EnvironmentTrigger[]

executionPolicy

EnvironmentExecutionPolicy

Définit la stratégie de mise en file d’attente de l’environnement sur Release Management file d’attente côté. Nous enverrons à l’Exécuteur d’environnement [création de prédéployer et d’autres étapes] uniquement lorsque les stratégies mentionnées sont satisfaites.
id

integer

name

string

owner

IdentityRef

postDeployApprovals

ReleaseDefinitionApprovals

postDeploymentGates

ReleaseDefinitionGatesStep

preDeployApprovals

ReleaseDefinitionApprovals

preDeploymentGates

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

properties

PropertiesCollection

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
queueId

integer

rank

integer

retentionPolicy

EnvironmentRetentionPolicy

schedules

ReleaseSchedule[]

variableGroups

integer[]

variables

<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

Nom Type Description
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

Nom Type Description
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

Nom Type Description
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

ReleaseDefinitionShallowReference

Nom Type Description
_links

ReferenceLinks

Obtient les liens vers les ressources, LES API et les vues associées pour la définition de mise en production.
id

integer

Obtient l’identificateur unique de la définition de mise en production.
name

string

Obtient ou définit le nom de la définition de mise en production.
path

string

Obtient ou définit le chemin d’accès de la définition de mise en production.
projectReference

ProjectReference

Obtient ou définit une référence de projet.
url

string

Obtient l’URL de l’API REST pour accéder à la définition de mise en production.

ReleaseDefinitionSource

Obtient ou définit la source de définition de mise en production.

Nom Type Description
ibiza

string

portalExtensionApi

string

restApi

string

undefined

string

userInterface

string

ReleaseReason

Obtient le motif de la mise en production.

Nom Type Description
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseReference

Nom Type Description
_links

ReferenceLinks

Obtient des liens pour accéder à la version.
artifacts

Artifact[]

Obtient la liste des artefacts.
createdBy

IdentityRef

Obtient l’identité qui a créé.
createdOn

string

Obtient la date à laquelle il a été créé.
description

string

Obtient une description.
id

integer

Obtient l’identificateur unique de ce champ.
modifiedBy

IdentityRef

Obtient l’identité qui a modifié.
name

string

Obtient le nom de la mise en production.
reason

ReleaseReason

Obtient le motif de la mise en production.
releaseDefinition

ReleaseDefinitionShallowReference

Obtient une référence superficielle de définition de mise en production.

ReleaseSchedule

Nom Type Description
daysToRelease

ScheduleDays

Jours de la semaine à publier
jobId

string

Id de travail de définition de travail Team Foundation
startHours

integer

Heure de début du fuseau horaire local
startMinutes

integer

Minute de fuseau horaire local pour démarrer
timeZoneId

string

ID de fuseau horaire de la planification de publication, par exemple « UTC »

ReleaseShallowReference

Nom Type Description
_links

ReferenceLinks

Obtient les liens vers les ressources, LES API et les vues associées pour la version.
id

integer

Obtient l’identificateur unique de la mise en production.
name

string

Obtient ou définit le nom de la mise en production.
url

string

Obtient l’URL de l’API REST pour accéder à la mise en production.

ReleaseTriggerBase

Nom Type Description
triggerType

ReleaseTriggerType

ReleaseTriggerType

Nom Type Description
artifactSource

string

containerImage

string

package

string

pullRequest

string

schedule

string

sourceRepo

string

undefined

string

ScheduleDays

Jours de la semaine à publier

Nom Type Description
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

TaskInputDefinitionBase

Nom Type Description
aliases

string[]

defaultValue

string

groupName

string

helpMarkDown

string

label

string

name

string

options

object

properties

object

required

boolean

type

string

validation

TaskInputValidation

visibleRule

string

TaskInputValidation

Nom Type Description
expression

string

Expression conditionnelle
message

string

Message expliquant comment l’utilisateur peut corriger si la validation échoue

TaskSourceDefinitionBase

Nom Type Description
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

WorkflowTask

Nom Type Description
alwaysRun

boolean

condition

string

continueOnError

boolean

definitionType

string

enabled

boolean

environment

object

inputs

object

name

string

overrideInputs

object

refName

string

taskId

string

timeoutInMinutes

integer

version

string