Freigeben über

Definitions - Update

  • Referenz
Service:
Release
API Version:
5.0

Aktualisieren Sie eine Releasedefinition.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
project
 path True

string

Projekt-ID oder Projektname
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu zugehörigen Ressourcen, APIs und Ansichten für die Releasedefinition ab.
artifacts

Artifact[]

Ruft die Liste der Artefakte ab oder legt sie fest.
comment

string

Ruft einen Kommentar ab oder legt diese fest.
createdBy

IdentityRef

Ruft die Identität ab, die erstellt wurde, oder legt sie fest.
createdOn

string

Ruft das Datum ab, an dem sie erstellt wurde.
description

string

Ruft die Beschreibung ab oder legt sie fest.
environments

ReleaseDefinitionEnvironment[]

Ruft die Liste der Umgebungen ab oder legt sie fest.
id

integer

Ruft den eindeutigen Bezeichner der Releasedefinition ab.
isDeleted

boolean

Gibt an, ob die Releasedefinition gelöscht wird.
lastRelease

ReleaseReference

Ruft den Verweis auf die letzte Version ab.
modifiedBy

IdentityRef

Ruft die Identität ab, die geändert wurde, oder legt sie fest.
modifiedOn

string

Ruft das Datum ab, an dem sie geändert wurde.
name

string

Ruft den Namen der Releasedefinition ab oder legt den Namen fest.
path

string

Ruft den Pfad der Releasedefinition ab oder legt diese fest.
projectReference

ProjectReference

Ruft den Projektverweis ab oder legt diese fest.
properties

PropertiesCollection

Ruft Eigenschaften ab oder legt sie fest.
releaseNameFormat

string

Ruft das Format des Releasenamens ab oder legt es fest.
revision

integer

Ruft die Revisionsnummer ab.
source

ReleaseDefinitionSource

Ruft die Quelle der Releasedefinition ab oder legt diese fest.
tags

string[]

Ruft die Liste der Tags ab oder legt diese fest.
triggers

ReleaseTriggerBase[]

Ruft die Liste der Trigger ab oder legt sie fest.
url

string

Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.
variableGroups

integer[]

Ruft die Liste der Variablengruppen ab oder legt sie fest.
variables

<string,  ConfigurationVariableValue>

Ruft das Wörterbuch der Variablen ab oder legt es fest.

Antworten

Name Typ Beschreibung
200 OK

ReleaseDefinition

Erfolgreicher Vorgang

Sicherheit

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

Name Beschreibung
vso.release_execute Ermöglicht das Lesen und Aktualisieren von Releaseartefakten, einschließlich Releases, Releasedefinitionen und Release-Envrionment, sowie die Möglichkeit, eine neue Version in die Warteschlange zu stellen.

Definitionen

Name Beschreibung
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType

Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.
ConfigurationVariableValue
DataSourceBindingBase

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy

Definiert die Richtlinie für die Umgebungswarteschlange in Release Management Warteschlange. Wir senden nur dann an Environment Runner [erstellen vor der Bereitstellung und andere Schritte], wenn die genannten Richtlinien erfüllt sind.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource

Ruft die Quelle der Releasedefinition ab oder legt sie fest.
ReleaseReason

Ruft den Grund für die Freigabe ab.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays

Wochentage für die Veröffentlichung
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Name Typ Beschreibung
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalOptions

Name Typ Beschreibung
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

Artifact

Name Typ Beschreibung
alias

string

Ruft den Alias ab oder legt den Alias fest.
definitionReference

<string,  ArtifactSourceReference>

Ruft den Definitionsverweis ab oder legt diese fest. z.B. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary

boolean

Ruft ab oder legt fest, wenn das Artefakt primär ist oder nicht.
isRetained

boolean

type

string

Ruft den Typ ab oder legt den Typ fest. Der Wert kann als "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild" angegeben werden.

ArtifactSourceReference

Name Typ Beschreibung
id

string

name

string

AuthorizationHeader

Name Typ Beschreibung
name

string

value

string

Condition

Name Typ Beschreibung
conditionType

ConditionType

Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.
name

string

Ruft den Namen der Bedingung ab oder legt den Namen der Bedingung fest. z.B. "ReleaseStarted".
value

string

Ruft den Wert der Bedingung ab oder legt den Wert fest.

ConditionType

Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.

Name Typ Beschreibung
artifact

string

Der Bedingungstyp ist artefakt.
environmentState

string

Der Bedingungstyp ist der Umgebungszustand.
event

string

Der Bedingungstyp ist "event".
undefined

string

Der Bedingungstyp ist nicht definiert.

ConfigurationVariableValue

Name Typ Beschreibung
allowOverride

boolean

Ruft ab oder legt fest, ob eine Variable zur Bereitstellungszeit überschrieben werden kann oder nicht.
isSecret

boolean

Ruft ab oder legt fest, da variable geheimnis ist oder nicht.
value

string

Ruft den Wert der Konfigurationsvariablen ab oder legt den Wert fest.

DataSourceBindingBase

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.

Name Typ Beschreibung
callbackContextTemplate

string

Paginierungsformat, das von dieser Datenquelle unterstützt wird (ContinuationToken/SkipTop).
callbackRequiredTemplate

string

Nachfolgende Aufrufe erforderlich?
dataSourceName

string

Ruft den Namen der Datenquelle ab oder legt den Namen fest.
endpointId

string

Ruft die Endpunkt-ID ab oder legt diese fest.
endpointUrl

string

Ruft die URL des Dienstendpunkts ab oder legt sie fest.
headers

AuthorizationHeader[]

Ruft die Autorisierungsheader ab oder legt diese fest.
initialContextTemplate

string

Definiert den Anfangswert der Abfrageparameter
parameters

object

Ruft die Parameter für die Datenquelle ab oder legt sie fest.
resultSelector

string

Ruft den Ergebnisauswahlor ab oder legt diese fest.
resultTemplate

string

Ruft die Ergebnisvorlage ab oder legt sie fest.
target

string

Ruft das Ziel der Datenquelle ab oder legt es fest.

Demand

Name Typ Beschreibung
name

string

value

string

DeployPhase

Name Typ Beschreibung
name

string

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseTypes

Name Typ Beschreibung
agentBasedDeployment

string

deploymentGates

string

Phasentyp, der Aufgaben enthält, die als Gates für die Bereitstellung fungieren.
machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentExecutionPolicy

Definiert die Richtlinie für die Umgebungswarteschlange in Release Management Warteschlange. Wir senden nur dann an Environment Runner [erstellen vor der Bereitstellung und andere Schritte], wenn die genannten Richtlinien erfüllt sind.

Name Typ Beschreibung
concurrencyCount

integer

Diese Richtlinie entscheidet, wie viele Umgebungen mit Environment Runner verwendet werden sollen.
queueDepthCount

integer

Warteschlangentiefe in der EnvironmentQueue-Tabelle. In dieser Tabelle werden die Umgebungseinträge beibehalten, bis Environment Runner [gemäß seiner Richtlinie] kostenlos ist, um eine andere Umgebung für die Ausführung zu verwenden.

EnvironmentOptions

Name Typ Beschreibung
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentRetentionPolicy

Name Typ Beschreibung
daysToKeep

integer

releasesToKeep

integer

retainBuild

boolean

EnvironmentTrigger

Name Typ Beschreibung
definitionEnvironmentId

integer

releaseDefinitionId

integer

triggerContent

string

triggerType

EnvironmentTriggerType

EnvironmentTriggerType

Name Typ Beschreibung
deploymentGroupRedeploy

string

rollbackRedeploy

string

undefined

string

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor

string

Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias

string

displayName

string

Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProcessParameters

Name Typ Beschreibung
dataSourceBindings

DataSourceBindingBase[]

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.
inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Name Typ Beschreibung
id

string

Ruft den eindeutigen Bezeichner dieses Felds ab.
name

string

Ruft den Namen des Projekts ab.

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer

Die Anzahl der Eigenschaften in der Auflistung.
item

object

keys

string[]

Der Satz von Schlüsseln in der Auflistung.
values

string[]

Der Satz von Werten in der Auflistung.

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

ReleaseDefinition

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab.
artifacts

Artifact[]

Ruft die Liste der Artefakte ab oder legt sie fest.
comment

string

Ruft einen Kommentar ab oder legt diese fest.
createdBy

IdentityRef

Ruft die Identität ab, die erstellt wurde, oder legt sie fest.
createdOn

string

Ruft das Erstellungsdatum ab.
description

string

Ruft die Beschreibung ab oder legt sie fest.
environments

ReleaseDefinitionEnvironment[]

Ruft die Liste der Umgebungen ab oder legt sie fest.
id

integer

Ruft den eindeutigen Bezeichner der Releasedefinition ab.
isDeleted

boolean

Gibt an, ob die Releasedefinition gelöscht wird.
lastRelease

ReleaseReference

Ruft den Verweis auf die letzte Version ab.
modifiedBy

IdentityRef

Ruft die Identität ab, die geändert wurde, oder legt sie fest.
modifiedOn

string

Ruft das Datum ab, an dem er geändert wurde.
name

string

Ruft den Namen der Releasedefinition ab oder legt den Namen fest.
path

string

Ruft den Pfad der Releasedefinition ab oder legt den Pfad fest.
projectReference

ProjectReference

Ruft den Projektverweis ab oder legt diese fest.
properties

PropertiesCollection

Ruft Eigenschaften ab oder legt sie fest.
releaseNameFormat

string

Ruft das Format des Releasenamens ab oder legt es fest.
revision

integer

Ruft die Revisionsnummer ab.
source

ReleaseDefinitionSource

Ruft die Quelle der Releasedefinition ab oder legt sie fest.
tags

string[]

Ruft eine Liste von Tags ab oder legt sie fest.
triggers

ReleaseTriggerBase[]

Ruft die Liste der Trigger ab oder legt sie fest.
url

string

Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.
variableGroups

integer[]

Ruft die Liste der Variablengruppen ab oder legt sie fest.
variables

<string,  ConfigurationVariableValue>

Ruft das Wörterbuch der Variablen ab oder legt es fest.

ReleaseDefinitionApprovals

Name Typ Beschreibung
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Name Typ Beschreibung
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionDeployStep

Name Typ Beschreibung
id

integer

tasks

WorkflowTask[]

Die Liste der Schritte für diese Definition.

ReleaseDefinitionEnvironment

Name Typ Beschreibung
badgeUrl

string

conditions

Condition[]

currentRelease

ReleaseShallowReference

demands

Demand[]

deployPhases

DeployPhase[]

deployStep

ReleaseDefinitionDeployStep

environmentOptions

EnvironmentOptions

environmentTriggers

EnvironmentTrigger[]

executionPolicy

EnvironmentExecutionPolicy

Definiert die Richtlinie für die Umgebungswarteschlange in Release Management Warteschlange. Wir senden nur dann an Environment Runner [erstellen vor der Bereitstellung und andere Schritte], wenn die genannten Richtlinien erfüllt sind.
id

integer

name

string

owner

IdentityRef

postDeployApprovals

ReleaseDefinitionApprovals

postDeploymentGates

ReleaseDefinitionGatesStep

preDeployApprovals

ReleaseDefinitionApprovals

preDeploymentGates

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

properties

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
queueId

integer

rank

integer

retentionPolicy

EnvironmentRetentionPolicy

schedules

ReleaseSchedule[]

variableGroups

integer[]

variables

<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

Name Typ Beschreibung
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

Name Typ Beschreibung
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

Name Typ Beschreibung
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

ReleaseDefinitionShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab.
id

integer

Ruft den eindeutigen Bezeichner der Releasedefinition ab.
name

string

Ruft den Namen der Releasedefinition ab oder legt den Namen fest.
path

string

Ruft den Pfad der Releasedefinition ab oder legt den Pfad fest.
projectReference

ProjectReference

Ruft den Projektverweis ab oder legt diese fest.
url

string

Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.

ReleaseDefinitionSource

Ruft die Quelle der Releasedefinition ab oder legt sie fest.

Name Typ Beschreibung
ibiza

string

portalExtensionApi

string

restApi

string

undefined

string

userInterface

string

ReleaseReason

Ruft den Grund für die Freigabe ab.

Name Typ Beschreibung
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft Links für den Zugriff auf das Release ab.
artifacts

Artifact[]

Ruft eine Liste der Artefakte ab.
createdBy

IdentityRef

Ruft die Identität ab, die erstellt wurde.
createdOn

string

Ruft das Erstellungsdatum ab.
description

string

Ruft eine Beschreibung ab.
id

integer

Ruft den eindeutigen Bezeichner dieses Felds ab.
modifiedBy

IdentityRef

Ruft die Identität ab, die geändert wurde.
name

string

Ruft den Namen des Release ab.
reason

ReleaseReason

Ruft den Grund für die Freigabe ab.
releaseDefinition

ReleaseDefinitionShallowReference

Ruft einen flachen Verweis auf die Releasedefinition ab.

ReleaseSchedule

Name Typ Beschreibung
daysToRelease

ScheduleDays

Zu veröffentlichende Wochentage
jobId

string

Auftrags-ID der Team Foundation-Auftragsdefinition
startHours

integer

Lokale Zeitzonenstunde zum Starten
startMinutes

integer

Minute für den Start der lokalen Zeitzone
timeZoneId

string

Zeitzonen-ID des Releasezeitplans, z. B. "UTC"

ReleaseShallowReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für das Release ab.
id

integer

Ruft den eindeutigen Bezeichner des Release ab.
name

string

Ruft den Namen des Release ab oder legt den Namen des Release fest.
url

string

Ruft die REST-API-URL für den Zugriff auf das Release ab.

ReleaseTriggerBase

Name Typ Beschreibung
triggerType

ReleaseTriggerType

ReleaseTriggerType

Name Typ Beschreibung
artifactSource

string

containerImage

string

package

string

pullRequest

string

schedule

string

sourceRepo

string

undefined

string

ScheduleDays

Wochentage für die Veröffentlichung

Name Typ Beschreibung
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

TaskInputDefinitionBase

Name Typ Beschreibung
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

Name Typ Beschreibung
expression

string

Bedingter Ausdruck
message

string

Meldung, in der erläutert wird, wie benutzer korrigieren kann, wenn die Überprüfung fehlschlägt

TaskSourceDefinitionBase

Name Typ Beschreibung
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

WorkflowTask

Name Typ Beschreibung
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