Definitions - Update

Référence

Service:: Release

Version d'API:: 7.1

Mettez à jour une définition de mise en production.

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

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 « 7.1 » 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 été créée.
createdOn	string (date-time)	Obtient la date à laquelle elle a été créée.
description	string	Obtient ou définit la description.
environments	ReleaseDefinitionEnvironment[]	Obtient ou définit la liste des environnements.
id	integer (int32)	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 (date-time)	Obtient la date à laquelle elle a été modifiée.
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 la référence du projet.
properties	PropertiesCollection	Obtient ou définit des propriétés.
releaseNameFormat	string	Obtient ou définit le format du nom de mise en production.
revision	integer (int32)	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[] (int32)	Obtient ou définit la liste des groupes de variables.
variables	<string, ConfigurationVariableValue>	Obtient ou définit le dictionnaire de variables.

Réponses

Nom	Type	Description
200 OK	ReleaseDefinition	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

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

Exemples

Update the release definition

Exemple de requête

HTTP

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

{
  "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-11T05:33:56.573Z",
  "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-11T05:33:56.573Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "tasks": [],
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "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",
          "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/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Exemple de réponse

Code d’état:: 200

{
  "source": "restApi",
  "revision": 2,
  "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-11T05:33:56.573Z",
  "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-11T05:33:58.433Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "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/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Définitions

Nom	Description
ApprovalExecutionOrder	Ordre d’exécution des approbations.
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	Indique le type de phase de déploiement.
EnvironmentExecutionPolicy	Définit la stratégie sur la mise en file d’attente côté environnement dans la file d’attente côté Gestion des mises en production. Nous allons envoyer à Environment Runner [création d’une prédéployation et d’autres étapes] uniquement lorsque les stratégies mentionnées sont satisfaites.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Obtient ou définit le type de déclencheur.
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 (n’importe quel 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, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.
ReferenceLinks	Classe à 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 la raison de la mise en production.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Type de déclencheur de mise en production.
ScheduleDays	Jours de la semaine à libérer.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Énumération

Ordre d’exécution des approbations.

Valeur	Description
afterGatesAlways	Approbations affichées toujours après l’exécution de portes.
afterSuccessfulGates	Approbations affichées après l’exécution réussie des portes.
beforeGates	Approbations affichées avant les portes.

ApprovalOptions

Object

Nom	Type	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Spécifiez si l’approbation peut être ignorée si le même approbateur a approuvé l’étape précédente.
enforceIdentityRevalidation	boolean	Spécifiez si l’identité de revalidation de l’approbateur avant d’effectuer l’approbation.
executionOrder	ApprovalExecutionOrder	Ordre d’exécution des approbations.
releaseCreatorCanBeApprover	boolean	Spécifiez si l’utilisateur demandant une version ou un déploiement doit autoriser l’approbateur.
requiredApproverCount	integer (int32)	Nombre d’approbations requises pour avancer la mise en production. '0' signifie toutes les approbations requises.
timeoutInMinutes	integer (int32)	Délai d’expiration de l’approbation. Le délai d’expiration par défaut de l’approbation est de 30 jours. Le délai d’expiration maximal autorisé est de 365 jours. '0' signifie le délai d’expiration par défaut, c’est-à-dire 30 jours.

Artifact

Object

Nom	Type	Description
alias	string	Obtient ou définit l’alias.
definitionReference	<string, ArtifactSourceReference>	Obtient ou définit la 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	Indique si l’artefact est principal ou non.
isRetained	boolean	Indique si l’artefact est conservé par version ou non.
type	string	Obtient ou définit le type. Elle peut avoir la valeur « Build », « Jenkins », « GitHub », « Nuget », « Team Build (externe) », « ExternalTFSBuild », « Git », « TFVC », « ExternalTfsXamlBuild ».

ArtifactSourceReference

Object

Nom	Type	Description
id	string	ID de la source de l’artefact.
name	string	Nom de la source de l’artefact.

AuthorizationHeader

Object

Nom	Type	Description
name	string
value	string

Condition

Object

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

Énumération

Obtient ou définit le type de condition.

Valeur	Description
artifact	Le type de condition est artefact.
environmentState	Le type de condition est l’état de l’environnement.
event	Le type de condition est événement.
undefined	Le type de condition n’est pas défini.

ConfigurationVariableValue

Object

Nom	Type	Description
allowOverride	boolean	Obtient et 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 est secret ou non.
value	string	Obtient et définit la valeur de la variable de configuration.

DataSourceBindingBase

Object

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	Les appels suivants sont 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 de l’analyseur de requête
parameters	object	Obtient ou définit les paramètres de la source de données.
requestContent	string	Obtient ou définit le corps de la requête http
requestVerb	string	Obtient ou définit le verbe de requête http
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

Object

Nom	Type	Description
name	string	Obtient et définit le nom de la demande.
value	string	Obtient et définit la valeur de la demande.

DeployPhase

Object

Nom	Type	Description
name	string	Obtient et définit le nom de la phase de déploiement.
phaseType	DeployPhaseTypes	Indique le type de phase de déploiement.
rank	integer (int32)	Obtient et définit le rang de la phase de déploiement.
refName	string	Obtient et définit le nom de référence de la phase de déploiement.
workflowTasks	WorkflowTask[]	Obtient et définit les tâches de flux de travail pour la phase de déploiement.

DeployPhaseTypes

Énumération

Indique le type de phase de déploiement.

Valeur	Description
agentBasedDeployment	Type de phase qui contient des tâches exécutées sur l’agent.
deploymentGates	Type de phase qui contient des tâches qui agissent comme Gates pour le déploiement à avancer.
machineGroupBasedDeployment	Type de phase qui contient des tâches exécutées sur des machines de groupe de déploiement.
runOnServer	Type de phase qui contient les tâches exécutées par le serveur.
undefined	Type de phase non défini. N’utilisez pas cela.

EnvironmentExecutionPolicy

Object

Définit la stratégie sur la mise en file d’attente côté environnement dans la file d’attente côté Gestion des mises en production. Nous allons envoyer à Environment Runner [création d’une prédéployation et d’autres étapes] uniquement lorsque les stratégies mentionnées sont satisfaites.

Nom	Type	Description
concurrencyCount	integer (int32)	Cette stratégie décide du nombre d’environnements avec Environment Runner.
queueDepthCount	integer (int32)	Profondeur de 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] pour qu’il prenne un autre environnement pour l’exécution.

EnvironmentOptions

Object

Nom	Type	Description
autoLinkWorkItems	boolean	Obtient et définit en tant qu’éléments de travail de liaison automatique ou non.
badgeEnabled	boolean	Obtient et définit le badge activé ou non.
publishDeploymentStatus	boolean	Obtient et définit l’état du déploiement de publication ou non.
pullRequestDeploymentEnabled	boolean	Obtient et définit le déploiement de la demande .pull activé ou non.

EnvironmentRetentionPolicy

Object

Nom	Type	Description
daysToKeep	integer (int32)	Obtient et définit le nombre de jours pour conserver l’environnement.
releasesToKeep	integer (int32)	Obtient et définit le nombre de mises en production à conserver.
retainBuild	boolean	Obtient et définit la build à conserver ou non.

EnvironmentTrigger

Object

Nom	Type	Description
definitionEnvironmentId	integer (int32)	ID d’environnement de définition sur lequel ce déclencheur s’applique.
releaseDefinitionId	integer (int32)	ID ReleaseDefinition sur lequel ce déclencheur s’applique.
triggerContent	string	Obtient ou définit le contenu du déclencheur.
triggerType	EnvironmentTriggerType	Obtient ou définit le type de déclencheur.

EnvironmentTriggerType

Énumération

Obtient ou définit le type de déclencheur.

Valeur	Description
deploymentGroupRedeploy	Le type de déclencheur d’environnement est le redéploiement du groupe de déploiement.
rollbackRedeploy	Le type de déclencheur d’environnement est Rollback.
undefined	Type de déclencheur d’environnement non défini.

IdentityRef

Object

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. 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 sur les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déconseillé - Disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utiliser Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

ProcessParameters

Object

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

Object

Nom	Type	Description
id	string (uuid)	Obtient l’identificateur unique de ce champ.
name	string	Obtient le nom du projet.

PropertiesCollection

Object

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 (n’importe quel 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, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.

Nom	Type	Description
count	integer (int32)	Nombre de propriétés dans la collection.
item	object
keys	string[]	Jeu de clés dans la collection.
values	string[]	Ensemble de valeurs dans la collection.

ReferenceLinks

Object

Classe à 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 de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ReleaseDefinition

Object

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 été créée.
createdOn	string (date-time)	Obtient la date à laquelle elle a été créée.
description	string	Obtient ou définit la description.
environments	ReleaseDefinitionEnvironment[]	Obtient ou définit la liste des environnements.
id	integer (int32)	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 (date-time)	Obtient la date à laquelle elle a été modifiée.
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 la référence du projet.
properties	PropertiesCollection	Obtient ou définit des propriétés.
releaseNameFormat	string	Obtient ou définit le format du nom de mise en production.
revision	integer (int32)	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[] (int32)	Obtient ou définit la liste des groupes de variables.
variables	<string, ConfigurationVariableValue>	Obtient ou définit le dictionnaire de variables.

ReleaseDefinitionApprovals

Object

Nom	Type	Description
approvalOptions	ApprovalOptions	Obtient ou définit les options d’approbation.
approvals	ReleaseDefinitionApprovalStep[]	Obtient ou définit les approbations.

ReleaseDefinitionApprovalStep

Object

Nom	Type	Description
approver	IdentityRef	Obtient et définit l’approbateur.
id	integer (int32)	ID de l’étape d’approbation ou de déploiement.
isAutomated	boolean	Indique si l’approbation est automatisée.
isNotificationOn	boolean	Indique si le jeu de notifications d’approbation.
rank	integer (int32)	Obtient ou définit le rang de l’étape d’approbation.

ReleaseDefinitionDeployStep

Object

Nom	Type	Description
id	integer (int32)	ID de l’étape d’approbation ou de déploiement.
tasks	WorkflowTask[]	Liste des étapes de cette définition.

ReleaseDefinitionEnvironment

Object

Nom	Type	Description
badgeUrl	string	Obtient ou définit le BadgeUrl. BadgeUrl sera utilisé lorsque badge sera activé dans l’environnement de définition de mise en production.
conditions	Condition[]	Obtient ou définit les conditions d’environnement.
currentRelease	ReleaseShallowReference	Obtient ou définit la référence de mise en production actuelle.
demands	Demand[]	Obtient ou définit les demandes.
deployPhases	DeployPhase[]	Obtient ou définit les phases de déploiement de l’environnement.
deployStep	ReleaseDefinitionDeployStep	Obtient ou définit le deploystep.
environmentOptions	EnvironmentOptions	Obtient ou définit les options d’environnement.
environmentTriggers	EnvironmentTrigger[]	Obtient ou définit les déclencheurs sur l’environnement.
executionPolicy	EnvironmentExecutionPolicy	Obtient ou définit la stratégie d’exécution de l’environnement.
id	integer (int32)	Obtient et définit l’ID de ReleaseDefinitionEnvironment.
name	string	Obtient et définit le nom de ReleaseDefinitionEnvironment.
owner	IdentityRef	Obtient et définit le propriétaire de ReleaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Obtient ou définit les approbations post-déploiement.
postDeploymentGates	ReleaseDefinitionGatesStep	Obtient ou définit les portes post-déploiement.
preDeployApprovals	ReleaseDefinitionApprovals	Obtient ou définit les approbations de prédéploiement.
preDeploymentGates	ReleaseDefinitionGatesStep	Obtient ou définit les portes de prédéploiement.
processParameters	ProcessParameters	Obtient ou définit les paramètres du processus d’environnement.
properties	PropertiesCollection	Obtient ou définit les propriétés de l’environnement.
queueId	integer (int32)	Obtient ou définit l’ID de file d’attente.
rank	integer (int32)	Obtient et définit le classement de ReleaseDefinitionEnvironment.
retentionPolicy	EnvironmentRetentionPolicy	Obtient ou définit la stratégie de rétention de l’environnement.
schedules	ReleaseSchedule[]	Obtient ou définit les planifications
variableGroups	integer[] (int32)	Obtient ou définit les groupes de variables.
variables	<string, ConfigurationVariableValue>	Obtient et définit les variables.

ReleaseDefinitionGate

Object

Nom	Type	Description
tasks	WorkflowTask[]	Obtient ou définit le flux de travail des portes.

ReleaseDefinitionGatesOptions

Object

Nom	Type	Description
isEnabled	boolean	Obtient ou définit en tant que portes activées ou non.
minimumSuccessDuration	integer (int32)	Obtient ou définit la durée minimale des résultats stables après une évaluation réussie des portes.
samplingInterval	integer (int32)	Obtient ou définit le temps entre la réévaluation des portes.
stabilizationTime	integer (int32)	Obtient ou définit le délai avant l’évaluation.
timeout	integer (int32)	Obtient ou définit le délai d’expiration après lequel les portes échouent.

ReleaseDefinitionGatesStep

Object

Nom	Type	Description
gates	ReleaseDefinitionGate[]	Obtient ou définit les portes.
gatesOptions	ReleaseDefinitionGatesOptions	Obtient ou définit les options de porte.
id	integer (int32)	ID de ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Object

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 (int32)	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 la référence du projet.
url	string	Obtient l’URL de l’API REST pour accéder à la définition de mise en production.

ReleaseDefinitionSource

Énumération

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

Valeur	Description
ibiza	Indique ReleaseDefinition créé à partir d’Ibiza.
portalExtensionApi	Indique ReleaseDefinition créé à partir de l’API PortalExtension.
restApi	Indique ReleaseDefinition créé à l’aide de l’API REST.
undefined	Indique la source ReleaseDefinition non définie.
userInterface	Indique ReleaseDefinition créé à l’aide de l’interface utilisateur.

ReleaseReason

Énumération

Obtient la raison de la mise en production.

Valeur	Description
continuousIntegration	Indique la mise en production déclenchée par l’intégration continue.
manual	Indique la mise en production déclenchée manuellement.
none	Indique la raison déclenchée par la mise en production non définie.
pullRequest	Indique la mise en production déclenchée par PullRequest.
schedule	Indique la mise en production déclenchée par la planification.

ReleaseReference

Object

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éé la mise en production.
createdOn	string (date-time)	Obtient la date à laquelle cette version a été créée.
description	string	Obtient la description.
id	integer (int32)	ID de la version.
modifiedBy	IdentityRef	Obtient l’identité qui a modifié la version.
name	string	Obtient le nom de la mise en production.
reason	ReleaseReason	Obtient la raison de la mise en production.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient une référence superficielle de définition de mise en production.

ReleaseSchedule

Object

Nom	Type	Description
daysToRelease	ScheduleDays	Jours de la semaine à libérer.
jobId	string (uuid)	ID de travail de définition de travail Team Foundation.
scheduleOnlyWithChanges	boolean	Indicateur pour déterminer si cette planification ne doit publier que si l’artefact associé a été modifié ou si la définition de mise en production a été modifiée.
startHours	integer (int32)	Heure du fuseau horaire local pour démarrer.
startMinutes	integer (int32)	Minute de fuseau horaire local à démarrer.
timeZoneId	string	ID de fuseau horaire de la planification de mise en production, tel que « UTC ».

ReleaseShallowReference

Object

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour la version.
id	integer (int32)	Obtient l’identificateur unique de mise en production.
name	string	Obtient ou définit le nom de la version.
url	string	Obtient l’URL de l’API REST pour accéder à la version.

ReleaseTriggerBase

Object

Nom	Type	Description
triggerType	ReleaseTriggerType	Type de déclencheur de mise en production.

ReleaseTriggerType

Énumération

Type de déclencheur de mise en production.

Valeur	Description
artifactSource	Déclencheur de mise en production basé sur des artefacts.
containerImage	Déclencheur de mise en production basé sur une image conteneur.
package	Déclencheur de mise en production basé sur un package.
pullRequest	Déclencheur de mise en production basé sur les demandes de tirage.
schedule	Planifier le déclencheur de mise en production basé sur la planification.
sourceRepo	Déclencheur de mise en production basé sur le référentiel source.
undefined	Type de déclencheur de mise en production non défini.

ScheduleDays

Énumération

Jours de la semaine à libérer.

Valeur	Description
all	Planifié tous les jours en semaine.
friday	Prévu le vendredi.
monday	Prévu le lundi.
none	Jour planifié non défini.
saturday	Prévu le samedi.
sunday	Prévu le dimanche.
thursday	Prévu le jeudi.
tuesday	Prévu le mardi.
wednesday	Prévu le mercredi.

TaskInputDefinitionBase

Object

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

Object

Nom	Type	Description
expression	string	Expression conditionnelle
message	string	Message expliquant comment l’utilisateur peut corriger en cas d’échec de la validation

TaskSourceDefinitionBase

Object

Nom	Type	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

Object

Nom	Type	Description
alwaysRun	boolean	Obtient ou définit en tant que tâche toujours exécutée ou non.
condition	string	Obtient ou définit la condition de tâche.
continueOnError	boolean	Obtient ou définit lorsque la tâche continue à s’exécuter en cas d’erreur ou non.
definitionType	string	Obtient ou définit le type de définition de tâche. Exemple : « Agent », DeploymentGroup », « Server » ou « ServerGate ».
enabled	boolean	Obtient ou définit la tâche activée ou non.
environment	object	Obtient ou définit les variables d’environnement de tâche.
inputs	object	Obtient ou définit les entrées de tâche.
name	string	Obtient ou définit le nom de la tâche.
overrideInputs	object	Obtient ou définit les entrées de remplacement de tâche.
refName	string	Obtient ou définit le nom de référence de la tâche.
retryCountOnTaskFailure	integer (int32)	Obtient ou définit la tâche retryCount.
taskId	string (uuid)	Obtient ou définit l’ID de la tâche.
timeoutInMinutes	integer (int32)	Obtient ou définit le délai d’expiration de la tâche.
version	string	Obtient ou définit la version de la tâche.

Partager via

Definitions - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Exemples

Update the release definition

Exemple de requête

Exemple de réponse

Définitions

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask