Deploymentgroups - Update

Referenz

Service:: Distributed Task

API Version:: 7.1-preview.1

Aktualisieren sie eine Bereitstellungsgruppe.

PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentGroupId	path	True	integer int32	ID der Bereitstellungsgruppe.
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.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungsgruppe.
name	string	Name der Bereitstellungsgruppe.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentGroup	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.machinegroup_manage	Ermöglicht die Verwaltung von Bereitstellungsgruppen und Agentpools

Beispiele

Update a deployment group

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1-preview.1

{
  "name": "MyDeploymentGroup1-Update1",
  "description": "Description of this deployment group is updated"
}

Sample Response

Status code:: 200

{
  "machineCount": 0,
  "description": "Description of this deployment group is updated",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1-Update1",
  "pool": {
    "id": 6,
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

Definitionen

Name	Beschreibung
Demand
DeploymentGroup	Bereitstellungsgruppe.
DeploymentGroupUpdateParameter	Updateparameter der Bereitstellungsgruppe.
DeploymentMachine	Bereitstellungsziel.
IdentityRef
JObject	Stellt ein JSON-Objekt dar.
JToken	Stellt ein abstraktes JSON-Token dar.
PackageVersion
ProjectReference
PropertiesCollection	Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem `TypeCode != TypeCode.Object`) außer für `DBNull` werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
TaskAgent	Ein Task-Agent.
TaskAgentAuthorization	Stellt Daten bereit, die für die Autorisierung des Agents mithilfe von OAuth 2.0-Authentifizierungsflows erforderlich sind.
TaskAgentCloudRequest
TaskAgentJobRequest	Eine Auftragsanforderung für einen Agent.
TaskAgentPoolOptions	Zusätzliche Pooleinstellungen und Details
TaskAgentPoolReference
TaskAgentPoolType	Ruft den Typ des Pools ab oder legt den Typ des Pools fest.
TaskAgentPublicKey	Stellt den öffentlichen Schlüsselteil eines asymmetrischen RSA-Schlüssels dar.
TaskAgentReference	Ein Verweis auf einen Agent.
TaskAgentStatus	Gibt an, ob der Agent online ist.
TaskAgentUpdate	Details zu einem Agent-Update.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Das Ergebnis dieser Anforderung.

Demand

Name	Typ	Beschreibung
name	string
value	string

DeploymentGroup

Bereitstellungsgruppe.

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungsgruppe.
id	integer	Bezeichner der Bereitstellungsgruppe.
machineCount	integer	Anzahl der Bereitstellungsziele in der Bereitstellungsgruppe.
machineTags	string[]	Liste der eindeutigen Tags für alle Bereitstellungsziele in der Bereitstellungsgruppe.
machines	DeploymentMachine[]	Liste der Bereitstellungsziele in der Bereitstellungsgruppe.
name	string	Name der Bereitstellungsgruppe.
pool	TaskAgentPoolReference	Bereitstellungspool, in dem Bereitstellungs-Agents registriert sind.
project	ProjectReference	Projekt, zu dem die Bereitstellungsgruppe gehört.

DeploymentGroupUpdateParameter

Updateparameter der Bereitstellungsgruppe.

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungsgruppe.
name	string	Name der Bereitstellungsgruppe.

DeploymentMachine

Bereitstellungsziel.

Name	Typ	Beschreibung
agent	TaskAgent	Bereitstellungs-Agent.
id	integer	Bezeichner des Bereitstellungsziels.
properties	PropertiesCollection	Eigenschaften des Bereitstellungsziels.
tags	string[]	Tags des Bereitstellungsziels.

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.

JObject

Stellt ein JSON-Objekt dar.

Name	Typ	Beschreibung
item	JToken	Stellt ein abstraktes JSON-Token dar.
type	string	Ruft den Knotentyp für dieses JToken ab.

JToken

Stellt ein abstraktes JSON-Token dar.

Name	Typ	Beschreibung
first	JToken	Rufen Sie das erste untergeordnete Token dieses Tokens ab.
hasValues	boolean	Ruft einen Wert ab, der angibt, ob dieses Token über untergeordnete Token verfügt.
item	JToken	Stellt ein abstraktes JSON-Token dar.
last	JToken	Rufen Sie das letzte untergeordnete Token dieses Tokens ab.
next	JToken	Ruft das nächste gleichgeordnete Token dieses Knotens ab.
parent	string	Ruft das übergeordnete Element ab oder legt es fest.
path	string	Ruft den Pfad des JSON-Tokens ab.
previous	JToken	Ruft das vorherige gleichgeordnete Token dieses Knotens ab.
root	JToken	Ruft das Stamm-JToken dieses JToken ab.
type	string	Ruft den Knotentyp für dieses JToken ab.

PackageVersion

Name	Typ	Beschreibung
major	integer
minor	integer
patch	integer

ProjectReference

Name	Typ	Beschreibung
id	string
name	string

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

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

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.

TaskAgent

Ein Task-Agent.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint	string	Der Zugriffspunkt dieses Agents.
assignedAgentCloudRequest	TaskAgentCloudRequest	Die Agent-Cloudanforderung, die derzeit diesem Agent zugeordnet ist.
assignedRequest	TaskAgentJobRequest	Die Anforderung, die diesem Agent derzeit zugewiesen ist.
authorization	TaskAgentAuthorization	Autorisierungsinformationen für diesen Agent.
createdOn	string	Datum, an dem dieser Agent erstellt wurde.
enabled	boolean	Gibt an, ob dieser Agent Aufträge ausführen soll.
id	integer	Bezeichner des Agents.
lastCompletedRequest	TaskAgentJobRequest	Die letzte Anforderung, die von diesem Agent abgeschlossen wurde.
maxParallelism	integer	Maximal zulässige Auftragsparallelität für diesen Agent.
name	string	Name des Agents.
osDescription	string	Agentbetriebssystem.
pendingUpdate	TaskAgentUpdate	Das Update für diesen Agent steht aus.
properties	PropertiesCollection	Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem `TypeCode != TypeCode.Object`) außer für `DBNull` werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
provisioningState	string	Bereitstellungsstatus dieses Agents.
status	TaskAgentStatus	Gibt an, ob der Agent online ist.
statusChangedOn	string	Datum, an dem die letzte Verbindungsänderung status erfolgt ist.
systemCapabilities	object	Systemdefinierte Funktionen, die vom Host dieses Agents unterstützt werden. Warnung: Um Funktionen mithilfe der PUT-Methode festzulegen, überschreibt PUT vorhandene Funktionen vollständig.
userCapabilities	object	Benutzerdefinierte Funktionen, die vom Host dieses Agents unterstützt werden. Warnung: Um Funktionen mithilfe der PUT-Methode festzulegen, überschreibt PUT vorhandene Funktionen vollständig.
version	string	Agent-Version.

TaskAgentAuthorization

Stellt Daten bereit, die für die Autorisierung des Agents mithilfe von OAuth 2.0-Authentifizierungsflows erforderlich sind.

Name	Typ	Beschreibung
authorizationUrl	string	Endpunkt, der zum Abrufen von Zugriffstoken vom konfigurierten Tokendienst verwendet wird.
clientId	string	Clientbezeichner für diesen Agent.
publicKey	TaskAgentPublicKey	Öffentlicher Schlüssel, der zum Überprüfen der Identität dieses Agents verwendet wird.

TaskAgentCloudRequest

Name	Typ	Beschreibung
agent	TaskAgentReference	Ein Verweis auf einen Agent.
agentCloudId	integer
agentConnectedTime	string
agentData	JObject	Stellt ein JSON-Objekt dar.
agentSpecification	JObject	Stellt ein JSON-Objekt dar.
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

Eine Auftragsanforderung für einen Agent.

Name	Typ	Beschreibung
agentSpecification	JObject	Stellt ein JSON-Objekt dar.
assignTime	string	Das Datum/die Uhrzeit der Zuweisung dieser Anforderung.
data	object	Zusätzliche Daten zur Anforderung.
definition	TaskOrchestrationOwner	Die dieser Anforderung zugeordnete Pipelinedefinition
demands	Demand[]	Eine Liste der Anforderungen, die zur Erfüllung dieser Anforderung erforderlich sind.
finishTime	string	Das Datum/die Uhrzeit, an dem diese Anforderung abgeschlossen wurde.
hostId	string	Der Host, der diese Anforderung ausgelöst hat.
jobId	string	ID des Auftrags, der sich aus dieser Anforderung ergibt.
jobName	string	Der Name des Auftrags, der sich aus dieser Anforderung ergibt.
lockedUntil	string	Die Frist für die Verlängerung der Sperre durch den Agent.
matchedAgents	TaskAgentReference[]	Ein Verweis auf einen Agent.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	Die pipeline, die dieser Anforderung zugeordnet ist
planGroup	string
planId	string	Interne ID für den Orchestrierungsplan, der mit dieser Anforderung verbunden ist.
planType	string	Interne Details, die den Typ des Orchestrierungsplans darstellen.
poolId	integer	Die ID des Pools, auf den diese Anforderung abzielt
priority	integer
queueId	integer	Die ID der Warteschlange, auf die diese Anforderung abzielt.
queueTime	string	Datum/Uhrzeit der Anforderung in der Warteschlange.
receiveTime	string	Das Datum/die Uhrzeit, zu der diese Anforderung von einem Agent zurückgegeben wurde.
requestId	integer	ID der Anforderung.
reservedAgent	TaskAgentReference	Der für diese Anforderung zugeordnete Agent.
result	TaskResult	Das Ergebnis dieser Anforderung.
scopeId	string	Umfang der Pipeline; entspricht der Projekt-ID.
serviceOwner	string	Der Dienst, der diese Anforderung besitzt.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Zusätzliche Pooleinstellungen und Details

Name	Typ	Beschreibung
elasticPool	string	TaskAgentPool, der vom Pooldienst für elastische Datenbanken unterstützt wird
none	string
preserveAgentOnJobFailure	string	Auf TRUE festgelegt, wenn Agents nach einem TaskAgentJobRequest-Fehler zur Untersuchung gehalten werden
singleUseAgents	string	Auf TRUE festgelegt, wenn Agents nach jedem TaskAgentJobRequest neu imageiert werden

TaskAgentPoolReference

Name	Typ	Beschreibung
id	integer
isHosted	boolean	Ruft einen Wert ab, der angibt, ob dieser Pool vom Dienst verwaltet wird, oder legt diesen fest.
isLegacy	boolean	Bestimmt, ob der Pool legacy ist.
name	string
options	TaskAgentPoolOptions	Zusätzliche Pooleinstellungen und Details
poolType	TaskAgentPoolType	Ruft den Typ des Pools ab oder legt den Typ des Pools fest.
scope	string
size	integer	Ruft die aktuelle Größe des Pools ab.

TaskAgentPoolType

Ruft den Typ des Pools ab oder legt den Typ des Pools fest.

Name	Typ	Beschreibung
automation	string	Ein typischer Pool von Task-Agents
deployment	string	Bereitstellungspool

TaskAgentPublicKey

Stellt den öffentlichen Schlüsselteil eines asymmetrischen RSA-Schlüssels dar.

Name	Typ	Beschreibung
exponent	string[]	Ruft den Exponenten für den öffentlichen Schlüssel ab oder legt diese fest.
modulus	string[]	Ruft das Modul für den öffentlichen Schlüssel ab oder legt dieses fest.

TaskAgentReference

Ein Verweis auf einen Agent.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint	string	Der Zugriffspunkt dieses Agents.
enabled	boolean	Gibt an, ob dieser Agent Aufträge ausführen soll oder nicht.
id	integer	Bezeichner des Agents.
name	string	Name des Agents.
osDescription	string	Agentbetriebssystem.
provisioningState	string	Bereitstellungsstatus dieses Agents.
status	TaskAgentStatus	Gibt an, ob der Agent online ist.
version	string	Agentversion.

TaskAgentStatus

Gibt an, ob der Agent online ist.

Name	Typ	Beschreibung
offline	string
online	string

TaskAgentUpdate

Details zu einem Agent-Update.

Name	Typ	Beschreibung
currentState	string	Aktueller Status dieses Agent-Updates.
reason	TaskAgentUpdateReason	Grund für dieses Update.
requestTime	string	Datum, an dem dieses Update angefordert wurde.
requestedBy	IdentityRef	Identität, die dieses Update angefordert hat.
sourceVersion	PackageVersion	Quell-Agent-Version des Updates.
targetVersion	PackageVersion	Ziel-Agent-Version des Updates.

TaskAgentUpdateReason

Name	Typ	Beschreibung
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name	Typ	Beschreibung
downgrade	string
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
id	integer
name	string

TaskResult

Das Ergebnis dieser Anforderung.

Name	Typ	Beschreibung
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

Share via