Approvals - Update

Referenz

Service:: Release

API Version:: 7.1-preview.3

Aktualisieren status einer Genehmigung

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals/{approvalId}?api-version=7.1-preview.3

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
approvalId	path	True	integer int32	Id der Genehmigung.
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.3" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

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 diesen fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Datum ab, an dem sie erstellt wurde.
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 sie fest, wenn die Genehmigung automatisiert ist oder nicht.
modifiedOn	string	Ruft das Datum ab, an dem sie geändert wurde.
rank	integer	Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. der gleiche Rang bezeichnet 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 ab, um auf die Genehmigung zuzugreifen.

Antworten

Name	Typ	Beschreibung
200 OK	ReleaseApproval	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_manage	Ermöglicht das Lesen, Aktualisieren und Löschen von Releaseartefakten, einschließlich Ordnern, Releases, Releasedefinitionen und Releaseumgebung sowie die Möglichkeit, eine neue Version in eine Warteschlange zu stellen und eine neue Version zu genehmigen.

Beispiele

Approve a release

Sample Request

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1-preview.3

{
  "status": "approved",
  "comments": "Good to go!"
}

Sample Response

Status code:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

Definitionen

Name	Beschreibung
ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
IdentityRef
ProjectReference
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

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 wird.
rejected	string	Gibt an, dass die Genehmigung abgelehnt wird.
skipped	string	Gibt an, dass die Genehmigung übersprungen wird.
undefined	string	Gibt an, dass für die Genehmigung die status 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.

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.

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ützt sind, möchten wir sie nur als schreibgeschützt 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 diesen fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Datum ab, an dem sie erstellt wurde.
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 sie fest, wenn die Genehmigung automatisiert ist oder nicht.
modifiedOn	string	Ruft das Datum ab, an dem sie geändert wurde.
rank	integer	Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. der gleiche Rang bezeichnet 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 ab, um auf die Genehmigung zuzugreifen.

ReleaseApprovalHistory

Name	Typ	Beschreibung
approver	IdentityRef	Identität des genehmigenden Personen.
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	Überprüfung des Genehmigungsverlaufs.

ReleaseDefinitionShallowReference

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu zugehörigen 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 diese 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.

ReleaseEnvironmentShallowReference

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu zugehörigen 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.

ReleaseShallowReference

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

Freigeben über