Freigeben über

Definitions - Get

  • Referenz
Service:
Release
API Version:
7.1-preview.4

Rufen Sie eine Releasedefinition ab.

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=7.1-preview.4
With optional parameters: 
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?propertyFilters={propertyFilters}&api-version=7.1-preview.4

URI-Parameter

Name In Erforderlich Typ Beschreibung
definitionId
 path True

integer

int32

ID der Releasedefinition.
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 "7.1-preview.4" festgelegt werden, um diese Version der API zu verwenden.
propertyFilters
 query

string

array (string)

Eine durch Trennzeichen getrennte Liste mit erweiterten Eigenschaften, die abgerufen werden sollen. Wenn festgelegt, enthält die zurückgegebene Releasedefinition Werte für die angegebenen Eigenschafts-IDs (sofern vorhanden). Wenn nicht festgelegt, werden die Eigenschaften nicht eingeschlossen.

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 Ermöglicht das Lesen von Releaseartefakten, einschließlich Ordnern, Releases, Releasedefinitionen und Releaseumgebung.

Beispiele

Get a release definition

Sample Request

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

Sample Response

Status code:
200 
{
  "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:48:42.657Z",
  "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:48:42.657Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 40,
      "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": 118
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 119
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 120
          }
        ]
      },
      "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/40/40"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 40,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=40"
    }
  }
}

Definitionen

Name Beschreibung
ApprovalExecutionOrder

Ausführungsreihenfolge der Genehmigungen.
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

Gibt den Typ der Bereitstellungsphase an.
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

Ruft den Triggertyp ab oder legt den Typ fest.
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) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ 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 diese fest.
ReleaseReason

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

Typ des Releasetriggers.
ScheduleDays

Wochentage, die veröffentlicht werden sollen.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Ausführungsreihenfolge der Genehmigungen.

Name Typ Beschreibung
afterGatesAlways

string

Genehmigungen, die immer nach der Ausführung von Gates angezeigt werden.
afterSuccessfulGates

string

Genehmigungen, die nach erfolgreicher Ausführung von Gates angezeigt werden.
beforeGates

string

Genehmigungen, die vor Gates angezeigt werden.

ApprovalOptions

Name Typ Beschreibung
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

Geben Sie an, ob die Genehmigung übersprungen werden kann, wenn derselbe genehmigende Benutzer die vorherige Phase genehmigt hat.
enforceIdentityRevalidation

boolean

Geben Sie vor Abschluss der Genehmigung an, ob die Identität des genehmigenden Benutzers überprüft wird.
executionOrder

ApprovalExecutionOrder

Ausführungsreihenfolge der Genehmigungen.
releaseCreatorCanBeApprover

boolean

Geben Sie an, ob der Benutzer, der ein Release oder eine Bereitstellung anfordert, genehmigende Personen zulassen soll.
requiredApproverCount

integer

Die Anzahl der Genehmigungen, die zum Verschieben der Freigabe erforderlich sind. "0" bezeichnet alle erforderlichen Genehmigungen.
timeoutInMinutes

integer

Genehmigungstimeout. Das Standardzeitlimit für die Genehmigung beträgt 30 Tage. Das maximal zulässige Timeout beträgt 365 Tage. "0" bedeutet standardtimeout, d. h. 30 Tage.

Artifact

Name Typ Beschreibung
alias

string

Ruft 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

Gibt an, ob es sich um ein primäres Artefakt handelt oder nicht.
isRetained

boolean

Gibt an, ob das Artefakt nach release beibehalten wird oder nicht.
type

string

Ruft den Typ ab oder legt diese fest. Es kann einen Wert wie "Build", "Jenkins", "GitHub", "Nuget", "Team Build (extern)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild" aufweisen.

ArtifactSourceReference

Name Typ Beschreibung
id

string

ID der Artefaktquelle.
name

string

Name der Artefaktquelle.

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 und legt fest, ob eine Variable zur Bereitstellungszeit überschrieben werden kann oder nicht.
isSecret

boolean

Ruft ab oder legt sie fest, da die Variable geheim ist oder nicht.
value

string

Ruft den Wert der Konfigurationsvariable ab und 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.
requestContent

string

Ruft http-Anforderungstext ab oder legt den Text fest
requestVerb

string

Ruft http-Anforderungsverb ab oder legt es 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

Ruft den Namen der Anforderung ab und legt den Namen der Anforderung fest.
value

string

Ruft den Wert des Bedarfs ab und legt den Wert des Bedarfs fest.

DeployPhase

Name Typ Beschreibung
name

string

Ruft den Namen der Bereitstellungsphase ab und legt den Namen der Bereitstellungsphase fest.
phaseType

DeployPhaseTypes

Gibt den Typ der Bereitstellungsphase an.
rank

integer

Ruft den Rang der Bereitstellungsphase ab und legt diese fest.
refName

string

Ruft den Verweisnamen der Bereitstellungsphase ab und legt diese fest.
workflowTasks

WorkflowTask[]

Ruft die Workflowtasks für die Bereitstellungsphase ab und legt sie fest.

DeployPhaseTypes

Gibt den Typ der Bereitstellungsphase an.

Name Typ Beschreibung
agentBasedDeployment

string

Phasentyp, der Aufgaben enthält, die auf dem Agent ausgeführt werden.
deploymentGates

string

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

string

Phasentyp, der Aufgaben enthält, die auf Bereitstellungsgruppencomputern ausgeführt werden.
runOnServer

string

Phasentyp, der vom Server ausgeführte Aufgaben enthält.
undefined

string

Phasentyp nicht definiert. Bitte nicht verwenden.

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

Ruft ab und legt sie fest, ob die Arbeitselemente für die automatische Verknüpfung verwendet werden oder nicht.
badgeEnabled

boolean

Ruft ab und legt es fest, wenn das Signal aktiviert ist oder nicht.
publishDeploymentStatus

boolean

Ruft ab und legt sie fest, als die Veröffentlichungsbereitstellung status oder nicht.
pullRequestDeploymentEnabled

boolean

Ruft die .pull request-Bereitstellung ab, die aktiviert ist oder nicht, und legt sie fest.

EnvironmentRetentionPolicy

Name Typ Beschreibung
daysToKeep

integer

Ruft die Anzahl der Tage ab, die die Umgebung beibehalten soll, und legt sie fest.
releasesToKeep

integer

Ruft die Anzahl der beizubehaltenden Releases ab und legt sie fest.
retainBuild

boolean

Ruft den Build ab und legt diesen fest, der beibehalten werden soll oder nicht.

EnvironmentTrigger

Name Typ Beschreibung
definitionEnvironmentId

integer

Id der Definitionsumgebung, für die dieser Trigger gilt.
releaseDefinitionId

integer

ReleaseDefinition-ID, für die dieser Trigger gilt.
triggerContent

string

Ruft den Triggerinhalt ab oder legt diese fest.
triggerType

EnvironmentTriggerType

Ruft den Triggertyp ab oder legt den Typ fest.

EnvironmentTriggerType

Ruft den Triggertyp ab oder legt den Typ fest.

Name Typ Beschreibung
deploymentGroupRedeploy

string

Der Umgebungstriggertyp ist die erneute Bereitstellung einer Bereitstellungsgruppe.
rollbackRedeploy

string

Der Umgebungstriggertyp ist Rollback.
undefined

string

Umgebungstriggertyp undefiniert.

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

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

string

Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand 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

Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName

string

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

string

imageUrl

string

Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"
inactive

boolean

Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity

boolean

Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Veraltet: Wird in den meisten bereits vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName

string

Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
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) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ 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 Schlüsselsatz in der Auflistung.
values

string[]

Der Wertsatz 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 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.

ReleaseDefinitionApprovals

Name Typ Beschreibung
approvalOptions

ApprovalOptions

Ruft die Genehmigungsoptionen ab oder legt sie fest.
approvals

ReleaseDefinitionApprovalStep[]

Ruft die Genehmigungen ab oder legt sie fest.

ReleaseDefinitionApprovalStep

Name Typ Beschreibung
approver

IdentityRef

Ruft den genehmigenden Benutzer ab und legt ihn fest.
id

integer

ID des Genehmigungs- oder Bereitstellungsschritts.
isAutomated

boolean

Gibt an, ob die Genehmigung automatisiert ist.
isNotificationOn

boolean

Gibt an, ob der Genehmigungsbenachrichtigungssatz festgelegt ist.
rank

integer

Ruft den Rang des Genehmigungsschritts ab oder legt diese fest.

ReleaseDefinitionDeployStep

Name Typ Beschreibung
id

integer

ID des Genehmigungs- oder Bereitstellungsschritts.
tasks

WorkflowTask[]

Die Liste der Schritte für diese Definition.

ReleaseDefinitionEnvironment

Name Typ Beschreibung
badgeUrl

string

Ruft badgeUrl ab oder legt diese fest. BadgeUrl wird verwendet, wenn Badge in der Releasedefinitionsumgebung aktiviert wird.
conditions

Condition[]

Ruft die Umgebungsbedingungen ab oder legt diese fest.
currentRelease

ReleaseShallowReference

Ruft den aktuellen Releaseverweis ab oder legt sie fest.
demands

Demand[]

Ruft die Anforderungen ab oder legt sie fest.
deployPhases

DeployPhase[]

Ruft die Bereitstellungsphasen der Umgebung ab oder legt diese fest.
deployStep

ReleaseDefinitionDeployStep

Ruft den Bereitstellungsschritt ab oder legt diese fest.
environmentOptions

EnvironmentOptions

Ruft die Umgebungsoptionen ab oder legt sie fest.
environmentTriggers

EnvironmentTrigger[]

Ruft die Trigger für die Umgebung ab oder legt sie fest.
executionPolicy

EnvironmentExecutionPolicy

Ruft die Umgebungsausführungsrichtlinie ab oder legt sie fest.
id

integer

Ruft die ID der ReleaseDefinitionEnvironment ab und legt sie fest.
name

string

Ruft den Namen der ReleaseDefinitionEnvironment ab und legt diese fest.
owner

IdentityRef

Ruft den Besitzer der ReleaseDefinitionEnvironment ab und legt diese fest.
postDeployApprovals

ReleaseDefinitionApprovals

Ruft die Genehmigungen nach der Bereitstellung ab oder legt sie fest.
postDeploymentGates

ReleaseDefinitionGatesStep

Ruft die Gates nach der Bereitstellung ab oder legt diese fest.
preDeployApprovals

ReleaseDefinitionApprovals

Ruft die Vorabbereitstellungsgenehmigungen ab oder legt diese fest.
preDeploymentGates

ReleaseDefinitionGatesStep

Ruft die Vorabbereitstellungsgates ab oder legt diese fest.
processParameters

ProcessParameters

Ruft die Umgebungsprozessparameter ab oder legt sie fest.
properties

PropertiesCollection

Ruft die Eigenschaften für die Umgebung ab oder legt sie fest.
queueId

integer

Ruft die Warteschlangen-ID ab oder legt diese fest.
rank

integer

Ruft den Rang von ReleaseDefinitionEnvironment ab und legt sie fest.
retentionPolicy

EnvironmentRetentionPolicy

Ruft die Umgebungsaufbewahrungsrichtlinie ab oder legt sie fest.
schedules

ReleaseSchedule[]

Ruft die Zeitpläne ab oder legt sie fest.
variableGroups

integer[]

Ruft die Variablengruppen ab oder legt sie fest.
variables

<string,  ConfigurationVariableValue>

Ruft die Variablen ab und legt sie fest.

ReleaseDefinitionGate

Name Typ Beschreibung
tasks

WorkflowTask[]

Ruft den Gates-Workflow ab oder legt diese fest.

ReleaseDefinitionGatesOptions

Name Typ Beschreibung
isEnabled

boolean

Ruft ab oder legt diese fest, wenn die Gates aktiviert sind oder nicht.
minimumSuccessDuration

integer

Ruft die Mindestdauer für stabile Ergebnisse nach einer erfolgreichen Gatesauswertung ab oder legt diese fest.
samplingInterval

integer

Ruft die Zeit zwischen der Neuauswertung von Gates ab oder legt diese fest.
stabilizationTime

integer

Ruft die Verzögerung vor der Auswertung ab oder legt sie fest.
timeout

integer

Ruft das Timeout ab, nach dem Gates fehlschlagen, oder legt dieses fest.

ReleaseDefinitionGatesStep

Name Typ Beschreibung
gates

ReleaseDefinitionGate[]

Ruft die Gates ab oder legt sie fest.
gatesOptions

ReleaseDefinitionGatesOptions

Ruft die Gateoptionen ab oder legt sie fest.
id

integer

ID des ReleaseDefinitionGateStep.

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 diese fest.

Name Typ Beschreibung
ibiza

string

Gibt ReleaseDefinition an, die von Ibiza erstellt wurde.
portalExtensionApi

string

Gibt ReleaseDefinition an, die über die PortalExtension-API erstellt wurde.
restApi

string

Gibt ReleaseDefinition an, die mithilfe der REST-API erstellt wurde.
undefined

string

Gibt an, dass ReleaseDefinition-Quelle nicht definiert ist.
userInterface

string

Gibt ReleaseDefinition an, die mithilfe der Benutzeroberfläche erstellt wurde.

ReleaseReason

Ruft den Grund für die Freigabe ab.

Name Typ Beschreibung
continuousIntegration

string

Gibt das Release an, das durch Continuous Integration ausgelöst wird.
manual

string

Gibt das manuell ausgelöste Release an.
none

string

Gibt an, warum der Releaseauslösungsgrund nicht festgelegt wurde.
pullRequest

string

Gibt das durch PullRequest ausgelöste Release an.
schedule

string

Gibt das Release an, das nach Zeitplan ausgelöst wird.

ReleaseReference

Name Typ Beschreibung
_links

ReferenceLinks

Ruft Links für den Zugriff auf die Version ab.
artifacts

Artifact[]

Ruft die Liste der Artefakte ab.
createdBy

IdentityRef

Ruft die Identität ab, die das Release erstellt hat.
createdOn

string

Ruft das Datum ab, an dem dieses Release erstellt wurde.
description

string

Ruft eine Beschreibung ab.
id

integer

ID der Version.
modifiedBy

IdentityRef

Ruft die Identität ab, die die Version geändert hat.
name

string

Ruft den Namen des Release ab.
reason

ReleaseReason

Ruft den Grund für die Veröffentlichung ab.
releaseDefinition

ReleaseDefinitionShallowReference

Ruft den flachen Verweis auf die Releasedefinition ab.

ReleaseSchedule

Name Typ Beschreibung
daysToRelease

ScheduleDays

Tage der Woche, die veröffentlicht werden sollen.
jobId

string

Auftrags-ID der Team Foundation-Auftragsdefinition.
scheduleOnlyWithChanges

boolean

Flag, um zu bestimmen, ob dieser Zeitplan nur veröffentlicht werden soll, wenn das zugeordnete Artefakt geändert oder die Releasedefinition geändert wurde.
startHours

integer

Lokale Zeitzonenstunde zu beginnen.
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

Typ des Releasetriggers.

ReleaseTriggerType

Typ des Releasetriggers.

Name Typ Beschreibung
artifactSource

string

Artefaktbasierter Releasetrigger.
containerImage

string

Containerimagebasierter Releasetrigger.
package

string

Paketbasierter Releasetrigger.
pullRequest

string

Pull Request-basierter Releasetrigger.
schedule

string

Zeitplanbasierter Releasetrigger.
sourceRepo

string

Quellrepository-basierter Releasetrigger.
undefined

string

Releasetriggertyp nicht festgelegt.

ScheduleDays

Wochentage, die veröffentlicht werden sollen.

Name Typ Beschreibung
all

string

Geplant an allen Tagen in der Woche.
friday

string

Geplant am Freitag.
monday

string

Geplant am Montag.
none

string

Geplanter Tag nicht festgelegt.
saturday

string

Geplant am Samstag.
sunday

string

Geplant am Sonntag.
thursday

string

Geplant am Donnerstag.
tuesday

string

Geplant am Dienstag.
wednesday

string

Geplant am Mittwoch.

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

Ruft ab oder legt fest, da die Aufgabe immer ausgeführt wird oder nicht.
condition

string

Ruft die Vorgangsbedingung ab oder legt sie fest.
continueOnError

boolean

Ruft ab oder legt fest, wenn der Task bei Einem Fehler weiter ausgeführt wird oder nicht.
definitionType

string

Ruft den Aufgabendefinitionstyp ab oder legt diese fest. Beispiel: "Agent", "DeploymentGroup", "Server" oder "ServerGate".
enabled

boolean

Ruft ab oder legt diese fest, wenn die Aufgabe aktiviert ist oder nicht.
environment

object

Ruft die Umgebungsvariablen der Aufgabe ab oder legt sie fest.
inputs

object

Ruft die Aufgabeneingaben ab oder legt sie fest.
name

string

Ruft den Namen des Tasks ab oder legt ihn fest.
overrideInputs

object

Ruft die Task-Außerkraftsetzungseingaben ab oder legt diese fest.
refName

string

Ruft den Verweisnamen des Vorgangs ab oder legt den Verweisnamen fest.
retryCountOnTaskFailure

integer

Ruft den Task retryCount ab oder legt diesen fest.
taskId

string

Ruft die ID des Vorgangs ab oder legt sie fest.
timeoutInMinutes

integer

Ruft das Tasktimeout ab oder legt es fest.
version

string

Ruft die Version des Tasks ab oder legt sie fest.