Definitions - Create

Referenz

Dienst:: Release

API-Version:: 7.1

Erstellen einer Releasedefinition

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

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 "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

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 den Kommentar ab oder legt den Kommentar fest.
createdBy	IdentityRef	Ruft die Identität ab, die erstellt wurde, oder legt sie fest.
createdOn	string (date-time)	Ruft das Datum ab, an dem es 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 (int32)	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	Dient zum Abrufen oder Festlegen der Identität, die geändert wurde.
modifiedOn	string (date-time)	Ruft das Datum ab, an dem es geändert wurde.
name	string	Dient zum Abrufen oder Festlegen des Namens der Releasedefinition.
path	string	Dient zum Abrufen oder Festlegen des Pfads der Releasedefinition.
projectReference	ProjectReference	Ruft den Projektverweis ab oder legt den Projektverweis fest.
properties	PropertiesCollection	Dient zum Abrufen oder Festlegen von Eigenschaften.
releaseNameFormat	string	Ruft das Versionsnamenformat ab oder legt dieses fest.
revision	integer (int32)	Ruft die Revisionsnummer ab.
source	ReleaseDefinitionSource	Ruft die Quelle der Releasedefinition ab oder legt sie fest.
tags	string[]	Ruft die Liste der 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[] (int32)	Ruft die Liste der Variablengruppen ab oder legt sie fest.
variables	<string, ConfigurationVariableValue>	Dient zum Abrufen oder Festlegen des Wörterbuchs von Variablen.

Antworten

Name	Typ	Beschreibung
200 OK	ReleaseDefinition	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.release_execute	Gewährt die Möglichkeit zum Lesen und Aktualisieren von Releaseartefakten, einschließlich Ordnern, Versionen, Releasedefinitionen und Releaseumgebung sowie der Möglichkeit, eine neue Version in die Warteschlange zu stellen.

Beispiele

Create release definition

Beispielanforderung

HTTP

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

{
  "source": "undefined",
  "revision": 1,
  "description": null,
  "createdBy": null,
  "createdOn": "0001-01-01T00:00:00",
  "modifiedBy": null,
  "modifiedOn": "0001-01-01T00:00:00",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 0,
      "name": "PROD",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": null,
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97"
            },
            "id": 0
          }
        ]
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {},
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": []
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": null,
  "tags": [],
  "properties": {},
  "id": 0,
  "name": "Fabrikam-web",
  "projectReference": null,
  "_links": {}
}

Beispiel für eine Antwort

Statuscode:: 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:56:42.237Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T04:56:42.237Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 42,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 124
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 125
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 126
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/42/42"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 42,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=42"
    }
  }
}

Definitionen

Name	Beschreibung
ApprovalExecutionOrder	Genehmigungsausführungsreihenfolge.
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Dient zum Abrufen oder Festlegen des Bedingungstyps.
ConfigurationVariableValue
DataSourceBindingBase	Stellt die Bindung der Datenquelle für die Serviceendpunktanforderung dar.
Demand
DeployPhase
DeployPhaseTypes	Gibt den Bereitstellungsphasentyp an.
EnvironmentExecutionPolicy	Definiert die Richtlinie für die Umgebungswarteschlange in der Warteschlange für die Versionsverwaltung. Wir senden an Environment Runner [Erstellen vor der Bereitstellung und andere Schritte] nur, wenn die genannten Richtlinien erfüllt sind.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Ruft den Triggertyp ab oder legt den Triggertyp fest.
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks 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 Veröffentlichung ab.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Typ des Releasetriggers.
ScheduleDays	Tage der Woche, die veröffentlicht werden sollen.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Enumeration

Genehmigungsausführungsreihenfolge.

Wert	Beschreibung
afterGatesAlways	Genehmigungen, die immer nach der Ausführung von Toren angezeigt werden.
afterSuccessfulGates	Genehmigungen nach erfolgreicher Ausführung von Toren gezeigt.
beforeGates	Genehmigungen vor Toren.

ApprovalOptions

Objekt

Name	Typ	Beschreibung
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Geben Sie an, ob die Genehmigung übersprungen werden kann, wenn derselbe Genehmigende die vorherige Stufe genehmigt hat.
enforceIdentityRevalidation	boolean	Geben Sie an, ob die Identität der Genehmigende vor Abschluss der Genehmigung erneut überprüft wird.
executionOrder	ApprovalExecutionOrder	Genehmigungsausführungsreihenfolge.
releaseCreatorCanBeApprover	boolean	Geben Sie an, ob der Benutzer, der eine Freigabe oder Bereitstellung anfordert, genehmigende Personen zulassen soll.
requiredApproverCount	integer (int32)	Die Anzahl der Genehmigungen, die erforderlich sind, um die Freigabe vorwärts zu verschieben. "0" bezeichnet alle erforderlichen Genehmigungen.
timeoutInMinutes	integer (int32)	Genehmigungstimeout. Das Standardtimeout für die Genehmigung beträgt 30 Tage. Der maximal zulässige Timeout beträgt 365 Tage. "0" bedeutet Standardtimeout, d. h. 30 Tage.

Artifact

Objekt

Name	Typ	Beschreibung
alias	string	Dient zum Abrufen oder Festlegen des Alias.
definitionReference	<string, ArtifactSourceReference>	Dient zum Abrufen oder Festlegen des Definitionsverweises. 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 das Artefakt primär ist oder nicht.
isRetained	boolean	Gibt an, ob das Artefakt durch Freigabe beibehalten wird oder nicht.
type	string	Dient zum Abrufen oder Festlegen des Typs. Der Wert kann als 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (extern)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild' verwendet werden.

ArtifactSourceReference

Objekt

Name	Typ	Beschreibung
id	string	ID der Artefaktquelle.
name	string	Name der Artefaktquelle.

AuthorizationHeader

Objekt

Name	Typ	Beschreibung
name	string
value	string

Condition

Objekt

Name	Typ	Beschreibung
conditionType	ConditionType	Dient zum Abrufen oder Festlegen des Bedingungstyps.
name	string	Dient zum Abrufen oder Festlegen des Namens der Bedingung. z. B. "ReleaseStarted".
value	string	Dient zum Abrufen oder Festlegen des Werts der Bedingung.

ConditionType

Enumeration

Dient zum Abrufen oder Festlegen des Bedingungstyps.

Wert	Beschreibung
artifact	Der Bedingungstyp ist Artefakt.
environmentState	Der Bedingungstyp ist der Umgebungszustand.
event	Der Bedingungstyp ist ereignis.
undefined	Der Bedingungstyp ist nicht definiert.

ConfigurationVariableValue

Objekt

Name	Typ	Beschreibung
allowOverride	boolean	Ruft ab und legt fest, ob eine Variable zur Bereitstellungszeit außer Kraft gesetzt werden kann.
isSecret	boolean	Dient zum Abrufen oder Festlegen als Variable ist geheim oder nicht.
value	string	Ruft den Wert der Konfigurationsvariablen ab und legt den Wert fest.

DataSourceBindingBase

Objekt

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

Name	Typ	Beschreibung
callbackContextTemplate	string	Paginierungsformat, das von dieser Datenquelle unterstützt wird(Fortsetzungstoken/SkipTop).
callbackRequiredTemplate	string	Nachfolgende Aufrufe sind erforderlich?
dataSourceName	string	Dient zum Abrufen oder Festlegen des Namens der Datenquelle.
endpointId	string	Ruft die Endpunkt-ID ab oder legt sie fest.
endpointUrl	string	Ruft die URL des Dienstendpunkts ab oder legt sie fest.
headers	AuthorizationHeader[]	Ruft die Autorisierungsheader ab oder legt sie fest.
initialContextTemplate	string	Definiert den Anfangswert der Abfrageparameter.
parameters	object	Ruft die Parameter für die Datenquelle ab oder legt sie fest.
requestContent	string	Dient zum Abrufen oder Festlegen des HTTP-Anforderungstexts.
requestVerb	string	Ruft das Http-Anforderungsverb ab oder legt es fest.
resultSelector	string	Ruft die Ergebnisauswahl ab oder legt sie fest.
resultTemplate	string	Ruft die Ergebnisvorlage ab oder legt sie fest.
target	string	Ruft ab oder legt das Ziel der Datenquelle fest.

Demand

Objekt

Name	Typ	Beschreibung
name	string	Ruft den Namen der Anforderung ab und legt sie fest.
value	string	Ruft den Wert der Anforderung ab und legt den Wert fest.

DeployPhase

Objekt

Name	Typ	Beschreibung
name	string	Ruft den Namen der Bereitstellungsphase ab und legt den Namen fest.
phaseType	DeployPhaseTypes	Gibt den Bereitstellungsphasentyp an.
rank	integer (int32)	Ruft den Rang der Bereitstellungsphase ab und legt sie fest.
refName	string	Ruft den Referenznamen der Bereitstellungsphase ab und legt sie fest.
workflowTasks	WorkflowTask[]	Ruft die Workflowaufgaben für die Bereitstellungsphase ab und legt sie fest.

DeployPhaseTypes

Enumeration

Gibt den Bereitstellungsphasentyp an.

Wert	Beschreibung
agentBasedDeployment	Phasentyp, der Aufgaben enthält, die für den Agent ausgeführt werden.
deploymentGates	Phasentyp, der Aufgaben enthält, die als Gates fungieren, damit die Bereitstellung ausgeführt wird.
machineGroupBasedDeployment	Phasentyp, der Aufgaben enthält, die auf Bereitstellungsgruppencomputern ausgeführt werden.
runOnServer	Phasentyp, der Aufgaben enthält, die vom Server ausgeführt werden.
undefined	Phasentyp nicht definiert. Verwenden Sie dies nicht.

EnvironmentExecutionPolicy

Objekt

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

Name	Typ	Beschreibung
concurrencyCount	integer (int32)	Diese Richtlinie entscheidet, wie viele Umgebungen mit Environment Runner sein würden.
queueDepthCount	integer (int32)	Die Warteschlangentiefe in der Tabelle "EnvironmentQueue" behält die Umgebungseinträge bei, bis "Environment Runner" [gemäß der Richtlinie] frei ist, um eine andere Umgebung für die Ausführung zu verwenden.

EnvironmentOptions

Objekt

Name	Typ	Beschreibung
autoLinkWorkItems	boolean	Ruft die Arbeitselemente für die automatische Verknüpfung ab und legt sie fest.
badgeEnabled	boolean	Ruft ab und legt dieses fest, wenn das Signal aktiviert ist oder nicht.
publishDeploymentStatus	boolean	Ruft den Veröffentlichungsbereitstellungsstatus ab und legt diesen fest.
pullRequestDeploymentEnabled	boolean	Ruft ab und legt diese fest, da die Bereitstellung der Pull-Anforderung aktiviert ist oder nicht.

EnvironmentRetentionPolicy

Objekt

Name	Typ	Beschreibung
daysToKeep	integer (int32)	Ruft die Anzahl der Tage ab, um die Umgebung beizubehalten, und legt sie fest.
releasesToKeep	integer (int32)	Ruft die Anzahl der beizubehaltenden Versionen ab und legt sie fest.
retainBuild	boolean	Ruft den Build ab und legt diesen fest, der beibehalten werden soll oder nicht.

EnvironmentTrigger

Objekt

Name	Typ	Beschreibung
definitionEnvironmentId	integer (int32)	Definitionsumgebungs-ID, für die dieser Auslöser anwendbar ist.
releaseDefinitionId	integer (int32)	ReleaseDefinition-ID, für die dieser Trigger anwendbar ist.
triggerContent	string	Dient zum Abrufen oder Festlegen des Triggerinhalts.
triggerType	EnvironmentTriggerType	Ruft den Triggertyp ab oder legt den Triggertyp fest.

EnvironmentTriggerType

Enumeration

Ruft den Triggertyp ab oder legt den Triggertyp fest.

Wert	Beschreibung
deploymentGroupRedeploy	Der Umgebungstriggertyp ist die erneute Bereitstellungsgruppe.
rollbackRedeploy	Der Umgebungstriggertyp ist "Rollback".
undefined	Der Umgebungstriggertyp ist nicht definiert.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, 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 – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProcessParameters

Objekt

Name	Typ	Beschreibung
dataSourceBindings	DataSourceBindingBase[]	Stellt die Bindung der Datenquelle für die Serviceendpunktanforderung dar.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Objekt

Name	Typ	Beschreibung
id	string (uuid)	Ruft den eindeutigen Bezeichner dieses Felds ab.
name	string	Ruft den Namen des Projekts ab.

PropertiesCollection

Objekt

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger 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 Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name	Typ	Beschreibung
count	integer (int32)	Die Anzahl der Eigenschaften in der Auflistung.
item	object
keys	string[]	Der Satz von Schlüsseln in der Auflistung.
values	string[]	Der Wertesatz in der Auflistung.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

ReleaseDefinition

Objekt

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 den Kommentar ab oder legt den Kommentar fest.
createdBy	IdentityRef	Ruft die Identität ab, die erstellt wurde, oder legt sie fest.
createdOn	string (date-time)	Ruft das Datum ab, an dem es 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 (int32)	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	Dient zum Abrufen oder Festlegen der Identität, die geändert wurde.
modifiedOn	string (date-time)	Ruft das Datum ab, an dem es geändert wurde.
name	string	Dient zum Abrufen oder Festlegen des Namens der Releasedefinition.
path	string	Dient zum Abrufen oder Festlegen des Pfads der Releasedefinition.
projectReference	ProjectReference	Ruft den Projektverweis ab oder legt den Projektverweis fest.
properties	PropertiesCollection	Dient zum Abrufen oder Festlegen von Eigenschaften.
releaseNameFormat	string	Ruft das Versionsnamenformat ab oder legt dieses fest.
revision	integer (int32)	Ruft die Revisionsnummer ab.
source	ReleaseDefinitionSource	Ruft die Quelle der Releasedefinition ab oder legt sie fest.
tags	string[]	Ruft die Liste der 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[] (int32)	Ruft die Liste der Variablengruppen ab oder legt sie fest.
variables	<string, ConfigurationVariableValue>	Dient zum Abrufen oder Festlegen des Wörterbuchs von Variablen.

ReleaseDefinitionApprovals

Objekt

Name	Typ	Beschreibung
approvalOptions	ApprovalOptions	Ruft die Genehmigungsoptionen ab oder legt sie fest.
approvals	ReleaseDefinitionApprovalStep[]	Ruft die Genehmigungen ab oder legt sie fest.

ReleaseDefinitionApprovalStep

Objekt

Name	Typ	Beschreibung
approver	IdentityRef	Ruft die genehmigende Person ab und legt sie fest.
id	integer (int32)	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 (int32)	Dient zum Abrufen oder Festlegen des Rangs des Genehmigungsschritts.

ReleaseDefinitionDeployStep

Objekt

Name	Typ	Beschreibung
id	integer (int32)	ID des Genehmigungs- oder Bereitstellungsschritts.
tasks	WorkflowTask[]	Die Liste der Schritte für diese Definition.

ReleaseDefinitionEnvironment

Objekt

Name	Typ	Beschreibung
badgeUrl	string	Dient zum Abrufen oder Festlegen des BadgeUrl-Werts. BadgeUrl wird verwendet, wenn Badge in der Releasedefinitionsumgebung aktiviert wird.
conditions	Condition[]	Ruft die Umgebungsbedingungen ab oder legt sie fest.
currentRelease	ReleaseShallowReference	Dient zum Abrufen oder Festlegen des aktuellen Versionsverweises.
demands	Demand[]	Ruft die Anforderungen ab oder legt sie fest.
deployPhases	DeployPhase[]	Ruft die Bereitstellungsphasen der Umgebung ab oder legt sie fest.
deployStep	ReleaseDefinitionDeployStep	Ruft den Bereitstellungsschritt ab oder legt diesen 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 (int32)	Ruft die ID der ReleaseDefinitionEnvironment ab und legt sie fest.
name	string	Ruft den Namen der ReleaseDefinitionEnvironment ab und legt den Namen fest.
owner	IdentityRef	Dient zum Abrufen und Festlegen des Besitzers der ReleaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Ruft die Genehmigungen nach der Bereitstellung ab oder legt sie fest.
postDeploymentGates	ReleaseDefinitionGatesStep	Ruft die Bereitstellungsgates nach der Bereitstellung ab oder legt sie fest.
preDeployApprovals	ReleaseDefinitionApprovals	Ruft die Vorabbereitstellungsgenehmigungen ab oder legt sie fest.
preDeploymentGates	ReleaseDefinitionGatesStep	Ruft die Vorbereitstellungsgates ab oder legt sie 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 (int32)	Ruft die Warteschlangen-ID ab oder legt sie fest.
rank	integer (int32)	Ruft den Rang der ReleaseDefinitionEnvironment ab und legt sie fest.
retentionPolicy	EnvironmentRetentionPolicy	Dient zum Abrufen oder Festlegen der Umgebungsaufbewahrungsrichtlinie.
schedules	ReleaseSchedule[]	Ruft die Zeitpläne ab oder legt sie fest.
variableGroups	integer[] (int32)	Dient zum Abrufen oder Festlegen der Variablengruppen.
variables	<string, ConfigurationVariableValue>	Ruft die Variablen ab und legt sie fest.

ReleaseDefinitionGate

Objekt

Name	Typ	Beschreibung
tasks	WorkflowTask[]	Dient zum Abrufen oder Festlegen des Gates-Workflows.

ReleaseDefinitionGatesOptions

Objekt

Name	Typ	Beschreibung
isEnabled	boolean	Ruft ab oder legt diese fest, wenn die Tore aktiviert sind oder nicht.
minimumSuccessDuration	integer (int32)	Ruft die Mindestdauer für konstante Ergebnisse nach einer erfolgreichen Bewertung der Tore ab oder legt sie fest.
samplingInterval	integer (int32)	Ruft die Zeit zwischen der erneuten Auswertung von Toren ab oder legt sie fest.
stabilizationTime	integer (int32)	Ruft die Verzögerung vor der Auswertung ab oder legt sie fest.
timeout	integer (int32)	Ruft das Timeout ab, nach dem Tore fehlschlagen, oder legt diesen fest.

ReleaseDefinitionGatesStep

Objekt

Name	Typ	Beschreibung
gates	ReleaseDefinitionGate[]	Ruft die Tore ab oder legt sie fest.
gatesOptions	ReleaseDefinitionGatesOptions	Ruft die Gate-Optionen ab oder legt sie fest.
id	integer (int32)	ID des ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab.
id	integer (int32)	Ruft den eindeutigen Bezeichner der Releasedefinition ab.
name	string	Dient zum Abrufen oder Festlegen des Namens der Releasedefinition.
path	string	Dient zum Abrufen oder Festlegen des Pfads der Releasedefinition.
projectReference	ProjectReference	Ruft den Projektverweis ab oder legt den Projektverweis fest.
url	string	Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.

ReleaseDefinitionSource

Enumeration

Ruft die Quelle der Releasedefinition ab oder legt sie fest.

Wert	Beschreibung
ibiza	Gibt ReleaseDefinition von Ibiza an.
portalExtensionApi	Gibt releaseDefinition an, die von der PortalExtension-API erstellt wurde.
restApi	Gibt ReleaseDefinition an, das mit der REST-API erstellt wurde.
undefined	Gibt an, dass die ReleaseDefinition-Quelle nicht definiert ist.
userInterface	Gibt ReleaseDefinition an, die mithilfe der Benutzeroberfläche erstellt wurde.

ReleaseReason

Enumeration

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

Wert	Beschreibung
continuousIntegration	Gibt die durch kontinuierliche Integration ausgelöste Freigabe an.
manual	Gibt die manuell ausgelöste Freigabe an.
none	Gibt den auslösungsauslösten Grund an, der nicht festgelegt wurde.
pullRequest	Gibt die von PullRequest ausgelöste Version an.
schedule	Gibt die vom Zeitplan ausgelöste Veröffentlichung an.

ReleaseReference

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft Links für den Zugriff auf die Version ab.
artifacts	Artifact[]	Ruft eine Liste der Artefakte ab.
createdBy	IdentityRef	Ruft die Identität ab, die version erstellt hat.
createdOn	string (date-time)	Ruft das Datum ab, an dem diese Version erstellt wurde.
description	string	Ruft eine Beschreibung ab.
id	integer (int32)	ID der Version.
modifiedBy	IdentityRef	Ruft die Identität ab, die die Version geändert hat.
name	string	Ruft den Namen der Veröffentlichung ab.
reason	ReleaseReason	Ruft den Grund für die Veröffentlichung ab.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft den Flachverweis der Releasedefinition ab.

ReleaseSchedule

Objekt

Name	Typ	Beschreibung
daysToRelease	ScheduleDays	Tage der Woche, die veröffentlicht werden sollen.
jobId	string (uuid)	Auftrags-ID der Team Foundation-Auftragsdefinition.
scheduleOnlyWithChanges	boolean	Kennzeichnen Sie, um zu ermitteln, ob dieser Zeitplan nur freigegeben werden soll, wenn das zugeordnete Artefakt geändert oder die Releasedefinition geändert wurde.
startHours	integer (int32)	Lokale Zeitzonenstunde, die gestartet werden soll.
startMinutes	integer (int32)	Minute der lokalen Zeitzone, die gestartet werden soll.
timeZoneId	string	Zeitzonen-ID des Veröffentlichungszeitplans, z. B. "UTC".

ReleaseShallowReference

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Version ab.
id	integer (int32)	Ruft den eindeutigen Bezeichner der Version ab.
name	string	Ruft den Namen der Version ab oder legt den Namen fest.
url	string	Ruft die REST-API-URL für den Zugriff auf die Version ab.

ReleaseTriggerBase

Objekt

Name	Typ	Beschreibung
triggerType	ReleaseTriggerType	Typ des Releasetriggers.

ReleaseTriggerType

Enumeration

Typ des Releasetriggers.

Wert	Beschreibung
artifactSource	Artefaktbasierter Releasetrigger.
containerImage	Containerimage-basierter Releasetrigger.
package	Paketbasierter Releasetrigger.
pullRequest	Pullanforderungsbasierter Releasetrigger.
schedule	Planen Sie den basierten Releasetrigger.
sourceRepo	Quell-Repository-basierter Releasetrigger.
undefined	Veröffentlichungstriggertyp nicht festgelegt.

ScheduleDays

Enumeration

Tage der Woche, die veröffentlicht werden sollen.

Wert	Beschreibung
all	Geplant an allen Tagen in der Woche.
friday	Geplant am Freitag.
monday	Geplant am Montag.
none	Geplanter Tag nicht festgelegt.
saturday	Geplant am Samstag.
sunday	Geplant am Sonntag.
thursday	Geplant am Donnerstag.
tuesday	Geplant am Dienstag.
wednesday	Geplant am Mittwoch.

TaskInputDefinitionBase

Objekt

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

Objekt

Name	Typ	Beschreibung
expression	string	Bedingter Ausdruck
message	string	Meldung, in der erläutert wird, wie der Benutzer korrigieren kann, wenn die Überprüfung fehlschlägt

TaskSourceDefinitionBase

Objekt

Name	Typ	Beschreibung
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

Objekt

Name	Typ	Beschreibung
alwaysRun	boolean	Ruft ab oder legt diese fest, wenn 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 die Aufgabe weiterhin auf Fehler ausgeführt wird oder nicht.
definitionType	string	Dient zum Abrufen oder Festlegen des Vorgangsdefinitionstyps. Beispiel:- 'Agent', DeploymentGroup', 'Server' oder 'ServerGate'.
enabled	boolean	Ruft ab oder legt diese fest, wenn die Aufgabe aktiviert ist oder nicht.
environment	object	Dient zum Abrufen oder Festlegen der Vorgangsumgebungsvariablen.
inputs	object	Ruft die Vorgangseingaben ab oder legt sie fest.
name	string	Dient zum Abrufen oder Festlegen des Namens des Vorgangs.
overrideInputs	object	Dient zum Abrufen oder Festlegen der Vorgangsüberschreibungseingaben.
refName	string	Dient zum Abrufen oder Festlegen des Verweisnamens des Vorgangs.
retryCountOnTaskFailure	integer (int32)	Dient zum Abrufen oder Festlegen des Vorgangs retryCount.
taskId	string (uuid)	Dient zum Abrufen oder Festlegen der ID des Vorgangs.
timeoutInMinutes	integer (int32)	Dient zum Abrufen oder Festlegen des Vorgangstimeouts.
version	string	Ruft die Version des Vorgangs ab oder legt sie fest.

Freigeben über

Definitions - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Create release definition

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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