Releases - Update Release Environment

Service:

Release

API Version:

7.1-preview.7

Aktualisieren des status einer Releaseumgebung

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	integer int32	Id der Releaseumgebung.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
releaseId	path	True	integer int32	Id der Version.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.7" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
comment	string	Ruft einen Kommentar ab oder legt diese fest.
scheduledDeploymentTime	string	Ruft die geplante Bereitstellungszeit ab oder legt diese fest.
status	EnvironmentStatus	Ruft status der Umgebung ab oder legt sie fest.
variables	<string,  ConfigurationVariableValue>	Legt die Liste der Umgebungsvariablen fest, die zur Bereitstellungszeit überschrieben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ReleaseEnvironment	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 Ordnern, Releases, Releasedefinitionen und Releaseumgebung sowie die Möglichkeit, eine neue Version in die Warteschlange zu stellen.

Beispiele

Start deployment on an environment

Sample Request

HTTP

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7

{
  "status": "inProgress",
  "scheduledDeploymentTime": null,
  "comment": null,
  "variables": {}
}

Sample Response

Status code:

200

{
  "id": 45,
  "releaseId": 45,
  "name": "PROD",
  "status": "queued",
  "variables": {},
  "variableGroups": [],
  "preDeployApprovals": [],
  "postDeployApprovals": [],
  "preApprovalsSnapshot": {
    "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": 0
      }
    ],
    "approvalOptions": {
      "requiredApproverCount": 0,
      "releaseCreatorCanBeApprover": true,
      "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
      "enforceIdentityRevalidation": false,
      "timeoutInMinutes": 0,
      "executionOrder": "beforeGates"
    }
  },
  "postApprovalsSnapshot": {
    "approvals": [
      {
        "rank": 1,
        "isAutomated": true,
        "isNotificationOn": false,
        "id": 0
      }
    ]
  },
  "deploySteps": [],
  "rank": 1,
  "definitionEnvironmentId": 23,
  "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": [],
  "workflowTasks": [],
  "deployPhasesSnapshot": [
    {
      "deploymentInput": {
        "parallelExecution": {
          "parallelExecutionType": "none"
        },
        "skipArtifactsDownload": false,
        "artifactsDownloadInput": {
          "downloadInputs": []
        },
        "queueId": 0,
        "demands": [],
        "enableAccessToken": false,
        "timeoutInMinutes": 0,
        "jobCancelTimeoutInMinutes": 1,
        "condition": "succeeded()",
        "overrideInputs": {}
      },
      "rank": 1,
      "phaseType": "agentBasedDeployment",
      "name": "Run on agent",
      "refName": null,
      "workflowTasks": []
    }
  ],
  "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"
  },
  "schedules": [],
  "release": {
    "id": 45,
    "name": "Release-2",
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=45&_a=release-summary"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45"
      }
    }
  },
  "releaseDefinition": {
    "id": 23,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=23"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23"
      }
    }
  },
  "releaseCreatedBy": {
    "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"
  },
  "triggerReason": "Manual",
  "preDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  },
  "postDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  }
}

Definitionen

Name	Beschreibung
ApprovalExecutionOrder	Ausführungsreihenfolge der Genehmigungen.
ApprovalOptions
ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
AuthorizationHeader
ConditionType	Ruft den Bedingungstyp ab oder legt den Bedingungstyp fest.
ConfigurationVariableValue
DataSourceBindingBase	Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung dar.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Ruft den Vorgang status der Bereitstellung ab.
DeploymentReason	Ruft den Grund der Bereitstellung ab.
DeploymentStatus	Ruft status der Bereitstellung ab.
DeployPhase
DeployPhaseStatus	Status der Phase.
DeployPhaseTypes	Gibt den Typ der Bereitstellungsphase an.
EnvironmentOptions
EnvironmentStatus	Ruft umgebungs-status ab.
GateStatus	Status der Releasegates.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Ruft den status des manuellen Eingriffs ab oder legt diese fest.
ProcessParameters
ProjectReference
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	Tage der Woche, die veröffentlicht werden sollen.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	Status der Freigabeaufgabe.
VariableGroup
VariableGroupProjectReference	Ein Variablengruppenverweis ist ein flacher Verweis auf die Variablengruppe.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

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 an, ob die Identität der genehmigenden Person vor Abschluss der Genehmigung erneut überprüft wird.
executionOrder	ApprovalExecutionOrder	Ausführungsreihenfolge für 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 erforderlich sind, um die Freigabe vorwärts zu verschieben. "0" alle erforderlichen Genehmigungen.
timeoutInMinutes	integer	Genehmigungstimeout. Das Standardtimeout für die Genehmigung beträgt 30 Tage. Das maximal zulässige Timeout beträgt 365 Tage. "0" bedeutet ein Standardtimeout, d. h. 30 Tage.

ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

Name	Typ	Beschreibung
approved	string	Gibt an, dass die Genehmigung genehmigt wurde.
canceled	string	Gibt an, dass die Genehmigung abgebrochen wurde.
pending	string	Gibt an, dass die Genehmigung aussteht.
reassigned	string	Gibt an, dass die Genehmigung neu zugewiesen wurde.
rejected	string	Gibt an, dass die Genehmigung abgelehnt wird.
skipped	string	Gibt an, dass die Genehmigung übersprungen wurde.
undefined	string	Gibt an, dass die status für die Genehmigung nicht festgelegt ist.

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

Name	Typ	Beschreibung
all	string	Gibt alle Genehmigungen an.
postDeploy	string	Gibt die Genehmigungen an, die nach der Bereitstellung ausgeführt wurden.
preDeploy	string	Gibt die Genehmigungen an, die vor der Bereitstellung ausgeführt wurden.
undefined	string	Gibt an, dass der Genehmigungstyp nicht festgelegt wird.

AuthorizationHeader

Name	Typ	Beschreibung
name	string
value	string

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 fest, da variable geheimnis ist oder nicht.
value	string	Ruft den Wert der Konfigurationsvariablen ab und legt den Wert fest.

DataSourceBindingBase

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

Name	Typ	Beschreibung
callbackContextTemplate	string	Von dieser Datenquelle unterstütztes Paginierungsformat (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Nachfolgende Aufrufe erforderlich?
dataSourceName	string	Ruft den Namen der Datenquelle ab oder legt den Namen der Datenquelle fest.
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	Ruft den HTTP-Anforderungstext ab oder legt den Http-Anforderungstext fest.
requestVerb	string	Ruft das HTTP-Anforderungsverb ab oder legt es fest.
resultSelector	string	Ruft die Ergebnisauswahl 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.

DeploymentAttempt

Name	Typ	Beschreibung
attempt	integer	Bereitstellungsversuch.
deploymentId	integer	ID der Bereitstellung.
hasStarted	boolean	Gibt an, ob die Bereitstellung gestartet wurde.
id	integer	ID der Bereitstellung.
issues	Issue[]	Alle Probleme im Zusammenhang mit der Bereitstellung.
lastModifiedBy	IdentityRef	Identität, die diese Bereitstellung zuletzt geändert hat.
lastModifiedOn	string	Zeitpunkt der letzten Änderung dieser Bereitstellung.
operationStatus	DeploymentOperationStatus	Bereitstellungsvorgang status.
postDeploymentGates	ReleaseGates	Post-Bereitstellungsgates, die in dieser Bereitstellung ausgeführt wurden.
preDeploymentGates	ReleaseGates	Vorabbereitstellungsgates, die in dieser Bereitstellung ausgeführt wurden.
queuedOn	string	Wenn diese Bereitstellung in die Warteschlange eingereiht wurde.
reason	DeploymentReason	Grund für die Bereitstellung.
releaseDeployPhases	ReleaseDeployPhase[]	Liste der Releasebereitstellungsphase, die in dieser Bereitstellung ausgeführt werden.
requestedBy	IdentityRef	Identität, die diese Bereitstellung angefordert hat.
requestedFor	IdentityRef	Die Identität für diese Bereitstellung wurde angefordert.
status	DeploymentStatus	status der Bereitstellung.

DeploymentJob

Name	Typ	Beschreibung
job	ReleaseTask	Übergeordnete Aufgabe aller ausgeführten Aufgaben.
tasks	ReleaseTask[]	Liste der ausgeführten Aufgaben mit in Auftrag.

DeploymentOperationStatus

Ruft den Vorgang status der Bereitstellung ab.

Name	Typ	Beschreibung
all	string	Der Bereitstellungsvorgang status ist alles.
approved	string	Der Bereitstellungsvorgang status genehmigt wurde.
canceled	string	Der Bereitstellungsvorgang status wird abgebrochen.
cancelling	string	Der Bereitstellungsvorgang status wird abgebrochen.
deferred	string	Der Bereitstellungsvorgang status wird verzögert.
evaluatingGates	string	Der bereitstellungsvorgang status ist EvaluatingGates.
gateFailed	string	Der Bereitstellungsvorgang status ist GateFailed.
manualInterventionPending	string	Der Bereitstellungsvorgang status ist manuell ausstehend.
pending	string	Der Bereitstellungsvorgang status steht aus.
phaseCanceled	string	Der Bereitstellungsvorgang status wird phasenweise abgebrochen.
phaseFailed	string	Der Bereitstellungsvorgang status ist in der Phase fehlgeschlagen.
phaseInProgress	string	Der Bereitstellungsvorgang status wird in einer Phase ausgeführt.
phasePartiallySucceeded	string	Der Bereitstellungsvorgang status phase teilweise erfolgreich ist.
phaseSucceeded	string	Der Bereitstellungsvorgang status Phase erfolgreich ist.
queued	string	Der Bereitstellungsvorgang status in die Warteschlange eingereiht wird.
queuedForAgent	string	Der Bereitstellungsvorgang status wird für den Agent in die Warteschlange eingereiht.
queuedForPipeline	string	Der Bereitstellungsvorgang status für die Pipeline in die Warteschlange eingereiht wird.
rejected	string	Der Bereitstellungsvorgang status wird abgelehnt.
scheduled	string	Der Bereitstellungsvorgang status ist geplant.
undefined	string	Der Bereitstellungsvorgang status ist nicht definiert.

DeploymentReason

Ruft den Grund der Bereitstellung ab.

Name	Typ	Beschreibung
automated	string	Der Bereitstellungsgrund ist automatisiert.
manual	string	Der Grund für die Bereitstellung ist manuell.
none	string	Der Grund für die Bereitstellung ist keiner.
redeployTrigger	string	Der Bereitstellungsgrund ist RedeployTrigger.
scheduled	string	Der Bereitstellungsgrund ist geplant.

DeploymentStatus

Ruft status der Bereitstellung ab.

Name	Typ	Beschreibung
all	string	Die bereitstellungs status ist alles.
failed	string	Fehler bei der Bereitstellung status.
inProgress	string	Die Bereitstellung status wird ausgeführt.
notDeployed	string	Die Bereitstellung status wird nicht bereitgestellt.
partiallySucceeded	string	Die Bereitstellung status wird teilweise ausgeführt.
succeeded	string	Die Bereitstellung status erfolgreich.
undefined	string	Die Bereitstellung status ist nicht definiert.

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.

DeployPhaseStatus

Status der Phase.

Name	Typ	Beschreibung
canceled	string	Die Phasenausführung wurde abgebrochen.
cancelling	string	Die Phase befindet sich im Abbruchzustand.
failed	string	Fehler bei der Phasenausführung.
inProgress	string	Die Phasenausführung wird ausgeführt.
notStarted	string	Die Phasenausführung wurde nicht gestartet.
partiallySucceeded	string	Die Phasenausführung war teilweise erfolgreich.
skipped	string	Die Phasenausführung wurde übersprungen.
succeeded	string	Die Phasenausführung war erfolgreich.
undefined	string	Phase status nicht festgelegt.

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.

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.

EnvironmentStatus

Ruft umgebungs-status ab.

Name	Typ	Beschreibung
canceled	string	Die Umgebung befindet sich im Abgebrochenen Zustand.
inProgress	string	Die Umgebung befindet sich im Status "In Bearbeitung".
notStarted	string	Die Umgebung befindet sich im Zustand nicht gestartet.
partiallySucceeded	string	Die Umgebung ist teilweise erfolgreich.
queued	string	Die Umgebung befindet sich in der Warteschlange.
rejected	string	Die Umgebung befindet sich im abgelehnten Zustand.
scheduled	string	Die Umgebung befindet sich im geplanten Zustand.
succeeded	string	Die Umgebung befindet sich im Status "Erfolgreich".
undefined	string	Umgebung status nicht festgelegt.

GateStatus

Status der Releasegates.

Name	Typ	Beschreibung
canceled	string	Die Gateausführung wurde abgebrochen.
failed	string	Fehler bei der Gateausführung.
inProgress	string	Das Gate wird derzeit ausgeführt.
none	string	Für das Gate ist die status nicht festgelegt.
pending	string	Das Gate befindet sich im Ausstehenden Zustand.
succeeded	string	Das Gate wurde erfolgreich abgeschlossen.

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	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
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	Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
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– wird in den meisten 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.

IgnoredGate

Name	Typ	Beschreibung
lastModifiedOn	string	Ruft das Datum ab, an dem das Gate zuletzt ignoriert wurde.
name	string	Name des Gates wurde ignoriert.

Issue

Name	Typ	Beschreibung
data	object	Geben Sie Daten aus.
issueType	string	Problemtyp, z. B. Fehler, Warnung oder Informationen.
message	string	Problemmeldung.

ManualIntervention

Name	Typ	Beschreibung
approver	IdentityRef	Ruft die Identität ab, die genehmigen soll, oder legt sie fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Datum ab, an dem sie erstellt wurde.
id	integer	Ruft den eindeutigen Bezeichner für den manuellen Eingriff ab.
instructions	string	Ruft Anweisungen für die Genehmigung ab oder legt diese fest.
modifiedOn	string	Ruft das Datum ab, an dem sie geändert wurde.
name	string	Ruft den Namen ab oder legt diesen fest.
release	ReleaseShallowReference	Ruft releaseReference für den manuellen Eingriff ab.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft releaseDefinitionReference für den manuellen Eingriff ab.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ruft releaseEnvironmentReference für den manuellen Eingriff ab.
status	ManualInterventionStatus	Ruft den status des manuellen Eingriffs ab oder legt diese fest.
taskInstanceId	string	Task instance Bezeichner abrufen.
url	string	Ruft die URL ab, um auf den manuellen Eingriff zuzugreifen.

ManualInterventionStatus

Ruft den status des manuellen Eingriffs ab oder legt diese fest.

Name	Typ	Beschreibung
approved	string	Der manuelle Eingriff wird genehmigt.
canceled	string	Der manuelle Eingriff wird abgebrochen.
pending	string	Der manuelle Eingriff steht aus.
rejected	string	Der manuelle Eingriff wird abgelehnt.
unknown	string	Für den manuellen Eingriff ist die status nicht festgelegt.

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.

ReferenceLinks

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.

ReleaseApproval

Name	Typ	Beschreibung
approvalType	ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
approvedBy	IdentityRef	Ruft die Identität ab, die genehmigt hat.
approver	IdentityRef	Ruft die Identität ab, die genehmigen soll, oder legt sie fest.
attempt	integer	Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch er gehört, oder legt ihn fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Erstellungsdatum ab.
history	ReleaseApprovalHistory[]	Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.
id	integer	Ruft den eindeutigen Bezeichner dieses Felds ab.
isAutomated	boolean	Ruft ab oder legt fest, ob die Genehmigung automatisiert ist oder nicht.
modifiedOn	string	Ruft das Datum ab, an dem er geändert wurde.
rank	integer	Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. bezeichnet die gleiche Rangfolge die parallele Genehmigung.
release	ReleaseShallowReference	Ruft releaseReference ab, das den Verweis auf das Release angibt, dem diese Genehmigung zugeordnet ist.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Genehmigung zugeordnet ist.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ruft releaseEnvironmentReference ab, das den Verweis auf die Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.
revision	integer	Ruft die Revisionsnummer ab.
status	ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
url	string	Ruft die URL für den Zugriff auf die Genehmigung ab.

ReleaseApprovalHistory

Name	Typ	Beschreibung
approver	IdentityRef	Identität der genehmigenden Person.
changedBy	IdentityRef	Identität des Objekts, das die Genehmigung geändert hat.
comments	string	Genehmigungsverlaufskommentare.
createdOn	string	Zeitpunkt, zu dem diese Genehmigung erstellt wurde.
modifiedOn	string	Zeitpunkt, zu dem diese Genehmigung geändert wurde.
revision	integer	Überarbeitung des Genehmigungsverlaufs.

ReleaseCondition

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".
result	boolean	Das Ergebnis der Releasebedingung.
value	string	Ruft den Wert der Bedingung ab oder legt den Wert 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 die Genehmigungsbenachrichtigung festgelegt ist.
rank	integer	Ruft den Rang des Genehmigungsschritts ab oder legt diese fest.

ReleaseDefinitionGate

Name	Typ	Beschreibung
tasks	WorkflowTask[]	Ruft den Gates-Workflow ab oder legt den Workflow 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.

ReleaseDeployPhase

Name	Typ	Beschreibung
deploymentJobs	DeploymentJob[]	Bereitstellungsaufträge der Phase.
errorLog	string	Fehlerprotokolle für die Phasenausführung.
manualInterventions	ManualIntervention[]	Liste der Ausführungsinformationen für manuelle Interventionsaufgaben in der Phase.
name	string	Name der Phase.
phaseId	string	ID der Phase.
phaseType	DeployPhaseTypes	Typ der Phase.
rank	integer	Rang der Phase.
runPlanId	string	Führen Sie die Plan-ID der Phase aus.
startedOn	string	Startzeit der Phase.
status	DeployPhaseStatus	Status der Phase.

ReleaseEnvironment

Name	Typ	Beschreibung
conditions	ReleaseCondition[]	Ruft eine Liste der Bedingungen ab.
createdOn	string	Ruft das Erstellungsdatum ab.
definitionEnvironmentId	integer	Ruft die ID der Definitionsumgebung ab.
deployPhasesSnapshot	DeployPhase[]	Ruft eine Liste der Bereitstellungsphasen Momentaufnahme ab.
deploySteps	DeploymentAttempt[]	Ruft Bereitstellungsschritte ab.
environmentOptions	EnvironmentOptions	Ruft Umgebungsoptionen ab.
id	integer	Ruft den eindeutigen Bezeichner dieses Felds ab.
modifiedOn	string	Ruft das Datum ab, an dem er geändert wurde.
name	string	Ruft den Namen ab.
nextScheduledUtcTime	string	Ruft die nächste geplante UTC-Zeit ab.
owner	IdentityRef	Ruft die Identität ab, die Besitzer der Releaseumgebung ist.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Ruft die Liste der Genehmigungen nach der Bereitstellung Momentaufnahme ab.
postDeployApprovals	ReleaseApproval[]	Ruft eine Liste der Genehmigungen nach der Bereitstellung ab.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Nach der Bereitstellung Momentaufnahme Daten.
preApprovalsSnapshot	ReleaseDefinitionApprovals	Ruft eine Liste der Vorabbereitstellungsgenehmigungen Momentaufnahme ab.
preDeployApprovals	ReleaseApproval[]	Ruft eine Liste der Vorabbereitstellungsgenehmigungen ab.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Vor der Bereitstellung Momentaufnahme Daten.
processParameters	ProcessParameters	Ruft Prozessparameter ab.
rank	integer	Ruft den Rang ab.
release	ReleaseShallowReference	Ruft einen Releaseverweis ab, der den Verweis auf das Release angibt, dem diese Releaseumgebung zugeordnet ist.
releaseCreatedBy	IdentityRef	Ruft die Identität ab, die das Release erstellt hat.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Releaseumgebung zugeordnet ist.
releaseId	integer	Ruft die Release-ID ab.
scheduledDeploymentTime	string	Ruft die Geplante Bereitstellungszeit der Releaseumgebung ab.
schedules	ReleaseSchedule[]	Ruft eine Liste der Zeitpläne ab.
status	EnvironmentStatus	Ruft umgebungs-status ab.
timeToDeploy	number	Ruft die Bereitstellungszeit ab.
triggerReason	string	Ruft den Triggergrund ab.
variableGroups	VariableGroup[]	Ruft die Liste der Variablengruppen ab.
variables	<string,  ConfigurationVariableValue>	Ruft das Wörterbuch der Variablen ab.

ReleaseEnvironmentShallowReference

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

ReleaseEnvironmentUpdateMetadata

Name	Typ	Beschreibung
comment	string	Ruft einen Kommentar ab oder legt diese fest.
scheduledDeploymentTime	string	Ruft die geplante Bereitstellungszeit ab oder legt sie fest.
status	EnvironmentStatus	Ruft status der Umgebung ab oder legt sie fest.
variables	<string,  ConfigurationVariableValue>	Legt die Liste der Umgebungsvariablen fest, die zum Zeitpunkt der Bereitstellung überschrieben werden sollen.

ReleaseGates

Name	Typ	Beschreibung
deploymentJobs	DeploymentJob[]	Enthält die Gates-Auftragsdetails jeder Auswertung.
id	integer	ID der Releasegates.
ignoredGates	IgnoredGate[]	Liste der ignorierten Gates.
lastModifiedOn	string	Zeitpunkt der letzten Änderung von Gates.
runPlanId	string	Führen Sie die Plan-ID der Gates aus.
stabilizationCompletedOn	string	Datum und Uhrzeit der Gates-Stabilisierung abgeschlossen.
startedOn	string	Startzeit der Gates-Auswertung.
status	GateStatus	Status der Releasegates.
succeedingSince	string	Datum und Uhrzeit der erfolgreichen Ausführung aller Gates.

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.

ReleaseTask

Name	Typ	Beschreibung
agentName	string	Agentname, für den der Task ausgeführt wurde.
finishTime	string	Endzeit der Freigabeaufgabe.
id	integer	ID des Freigabetasks.
issues	Issue[]	Liste der Probleme, die während der Ausführung der Aufgabe aufgetreten sind.
lineCount	integer	Die Anzahl der Zeilen, die der Protokollfreigabetask aufweist.
logUrl	string	Protokoll-URL der Aufgabe.
name	string	Der Name der Aufgabe.
percentComplete	integer	Vorgangsausführung abgeschlossen.
rank	integer	Rang der Freigabeaufgabe.
resultCode	string	Ergebniscode der Aufgabe.
startTime	string	ID des Freigabetasks.
status	TaskStatus	Status der Freigabeaufgabe.
task	WorkflowTaskReference	Workflowaufgabenreferenz.
timelineRecordId	string	Zeitachsendatensatz-ID des Freigabetasks.

ScheduleDays

Tage der Woche, 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

TaskStatus

Status der Freigabeaufgabe.

Name	Typ	Beschreibung
canceled	string	Die Aufgabenausführung wurde abgebrochen.
failed	string	Fehler bei der Ausführung der Aufgabe.
failure	string	Fehler bei der Ausführung der Aufgabe.
inProgress	string	Die Aufgabe wird derzeit ausgeführt.
partiallySucceeded	string	Die Aufgabenausführung war teilweise erfolgreich.
pending	string	Die Aufgabe steht status aus.
skipped	string	Die Aufgabenausführung wurde übersprungen.
succeeded	string	Die Aufgabe wurde erfolgreich abgeschlossen.
success	string	Die Aufgabe wurde erfolgreich abgeschlossen.
unknown	string	Für die Aufgabe ist die status nicht festgelegt.

VariableGroup

Name	Typ	Beschreibung
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.
id	integer	Ruft den eindeutigen Bezeichner dieses Felds ab.
isShared	boolean	Gibt an, ob eine Variablengruppe für ein anderes Projekt freigegeben wird oder nicht.
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 ab oder legt den Namen fest.
providerData	VariableGroupProviderData	Ruft Anbieterdaten ab oder legt diese fest.
type	string	Ruft den Typ ab oder legt den Typ fest.
variableGroupProjectReferences	VariableGroupProjectReference[]	alle Projektverweise, bei denen die Variablengruppe für andere Projekte freigegeben ist.
variables	<string,  VariableValue>	Ruft das Wörterbuch der Variablen ab und legt es fest.

VariableGroupProjectReference

Ein Variablengruppenverweis ist ein flacher Verweis auf die Variablengruppe.

Name	Typ	Beschreibung
description	string	Ruft die Beschreibung der Variablengruppe ab oder legt diese fest.
name	string	Ruft den Namen der Variablengruppe ab oder legt den Namen fest.
projectReference	ProjectReference	Ruft den Projektverweis der Variablengruppe ab oder legt diese fest.

VariableGroupProviderData

VariableValue

Name	Typ	Beschreibung
isReadOnly	boolean	Ruft ab oder legt fest, ob die Variable schreibgeschützt ist oder nicht.
isSecret	boolean	Ruft ab oder legt sie fest, da die Variable geheim ist oder nicht.
value	string	Ruft den Wert ab oder legt den Wert fest.

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.

WorkflowTaskReference

Name	Typ	Beschreibung
id	string	Aufgabenbezeichner.
name	string	Der Name der Aufgabe.
version	string	Version der Aufgabe.