Freigeben über

Approvals - Update

  • Referenz
Dienst:
Release
API-Version:
7.1

Aktualisierungsstatus einer Genehmigung

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

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

Anforderungstext

Name Typ Beschreibung
approvalType

ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.
approvedBy

IdentityRef

Ruft die Identität ab, die genehmigt wurde.
approver

IdentityRef

Ruft die Identität ab, die genehmigt werden soll, oder legt sie fest.
attempt

integer (int32)

Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch es gehört, oder legt den Versuch fest.
comments

string

Ruft Kommentare zur Genehmigung ab oder legt sie fest.
createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.
history

ReleaseApprovalHistory[]

Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.
id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.
isAutomated

boolean

Ruft ab oder legt diese fest, da die Genehmigung automatisiert ist oder nicht.
modifiedOn

string (date-time)

Ruft das Datum ab, an dem es geändert wurde.
rank

integer (int32)

Dient zum Abrufen oder Festlegen des Rangs, der die Reihenfolge der Genehmigung angibt. z. B. die gleiche Rangfolge kennzeichnet die parallele Genehmigung.
release

ReleaseShallowReference

Ruft releaseReference ab, das den Verweis auf die Version angibt, der diese Genehmigung zugeordnet ist.
releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, das den Verweis der Releasedefinition angibt, der diese Genehmigung zugeordnet ist.
releaseEnvironment

ReleaseEnvironmentShallowReference

Ruft releaseEnvironmentReference, das den Verweis der Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.
revision

integer (int32)

Ruft die Revisionsnummer ab.
status

ApprovalStatus

Dient zum Abrufen oder Festlegen des Status der Genehmigung.
url

string

Ruft die URL für den Zugriff auf die Genehmigung ab.

Antworten

Name Typ Beschreibung
200 OK

ReleaseApproval

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_manage Gewährt die Möglichkeit zum Lesen, Aktualisieren und Löschen von Releaseartefakten, einschließlich Ordnern, Versionen, Releasedefinitionen und Releaseumgebung sowie der Möglichkeit, eine neue Version in die Warteschlange zu stellen und zu genehmigen.

Beispiele

Approve a release

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
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

Dient zum Abrufen oder Festlegen des Status der Genehmigung.
ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.
IdentityRef
ProjectReference
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Enumeration

Dient zum Abrufen oder Festlegen des Status der Genehmigung.

Wert Beschreibung
approved

Gibt an, dass die Genehmigung genehmigt wurde.
canceled

Gibt an, dass die Genehmigung abgebrochen wird.
pending

Gibt an, dass die Genehmigung aussteht.
reassigned

Gibt an, dass die Genehmigung neu zugewiesen wird.
rejected

Gibt an, dass die Genehmigung abgelehnt wird.
skipped

Gibt an, dass die Genehmigung übersprungen wird.
undefined

Gibt an, dass die Genehmigung nicht über den Statussatz verfügt.

ApprovalType

Enumeration

Dient zum Abrufen oder Festlegen des Genehmigungstyps.

Wert Beschreibung
all

Gibt alle Genehmigungen an.
postDeploy

Gibt die Genehmigungen an, die nach der Bereitstellung ausgeführt wurden.
preDeploy

Gibt die Genehmigungen an, die vor der Bereitstellung ausgeführt wurden.
undefined

Gibt an, dass der Genehmigungstyp nicht festgelegt ist.

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.

ProjectReference

Objekt
Name Typ Beschreibung
id

string (uuid)

Ruft den eindeutigen Bezeichner dieses Felds ab.
name

string

Ruft den Namen des Projekts ab.
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.

ReleaseApproval

Objekt
Name Typ Beschreibung
approvalType

ApprovalType

Dient zum Abrufen oder Festlegen des Genehmigungstyps.
approvedBy

IdentityRef

Ruft die Identität ab, die genehmigt wurde.
approver

IdentityRef

Ruft die Identität ab, die genehmigt werden soll, oder legt sie fest.
attempt

integer (int32)

Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch es gehört, oder legt den Versuch fest.
comments

string

Ruft Kommentare zur Genehmigung ab oder legt sie fest.
createdOn

string (date-time)

Ruft das Datum ab, an dem es erstellt wurde.
history

ReleaseApprovalHistory[]

Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.
id

integer (int32)

Ruft den eindeutigen Bezeichner dieses Felds ab.
isAutomated

boolean

Ruft ab oder legt diese fest, da die Genehmigung automatisiert ist oder nicht.
modifiedOn

string (date-time)

Ruft das Datum ab, an dem es geändert wurde.
rank

integer (int32)

Dient zum Abrufen oder Festlegen des Rangs, der die Reihenfolge der Genehmigung angibt. z. B. die gleiche Rangfolge kennzeichnet die parallele Genehmigung.
release

ReleaseShallowReference

Ruft releaseReference ab, das den Verweis auf die Version angibt, der diese Genehmigung zugeordnet ist.
releaseDefinition

ReleaseDefinitionShallowReference

Ruft releaseDefinitionReference ab, das den Verweis der Releasedefinition angibt, der diese Genehmigung zugeordnet ist.
releaseEnvironment

ReleaseEnvironmentShallowReference

Ruft releaseEnvironmentReference, das den Verweis der Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.
revision

integer (int32)

Ruft die Revisionsnummer ab.
status

ApprovalStatus

Dient zum Abrufen oder Festlegen des Status der Genehmigung.
url

string

Ruft die URL für den Zugriff auf die Genehmigung ab.

ReleaseApprovalHistory

Objekt
Name Typ Beschreibung
approver

IdentityRef

Identität der genehmigende Person.
changedBy

IdentityRef

Die Identität des Objekts, das die Genehmigung geändert hat.
comments

string

Genehmigungsverlaufskommentare.
createdOn

string (date-time)

Zeitpunkt, zu dem diese Genehmigung erstellt wurde.
modifiedOn

string (date-time)

Zeitpunkt, zu dem diese Genehmigung geändert wurde.
revision

integer (int32)

Überarbeitung des Genehmigungsverlaufs.

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.

ReleaseEnvironmentShallowReference

Objekt
Name Typ Beschreibung
_links

ReferenceLinks

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

integer (int32)

Ruft den eindeutigen Bezeichner der Releaseumgebung ab.
name

string

Dient zum Abrufen oder Festlegen des Namens der Releaseumgebung.
url

string

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

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.