Deploymentgroups - Add

Referenz

Dienst:: Distributed Task

API-Version:: 7.1

Erstellen Sie eine Bereitstellungsgruppe.

POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?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
description	string	Beschreibung der Bereitstellungsgruppe.
name	string	Name der Bereitstellungsgruppe.
poolId	integer (int32)	Bezeichner des Bereitstellungspools, in dem Bereitstellungs-Agents registriert sind.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentGroup	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.machinegroup_manage	Bietet die Möglichkeit zum Verwalten von Bereitstellungsgruppen- und Agentpools

Beispiele

Create a deployment group

Beispielanforderung

HTTP

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "machineCount": 0,
  "description": "This deployment group is created to demnostrate the client usage",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1",
  "pool": {
    "id": 6,
    "scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
    "name": "DeploymentGroupRESTSample-MyDeploymentGroup1",
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

Definitionen

Name	Beschreibung
Demand
DeploymentGroup	Bereitstellungsgruppe.
DeploymentGroupCreateParameter	Eigenschaften zum Erstellen einer 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ü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.
TaskAgent	Ein Task-Agent.
TaskAgentAuthorization	Stellt Daten bereit, die zum Autorisieren des Agents mithilfe von OAuth 2.0-Authentifizierungsflüssen erforderlich sind.
TaskAgentCloudRequest
TaskAgentJobRequest	Eine Auftragsanfrage für einen Agenten.
TaskAgentPoolOptions	Zusätzliche Pooleinstellungen und Details
TaskAgentPoolReference
TaskAgentPoolType	Dient zum Abrufen oder Festlegen des Typs des Pools.
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

Objekt

Name	Typ	Beschreibung
name	string
value	string

DeploymentGroup

Objekt

Bereitstellungsgruppe.

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungsgruppe.
id	integer (int32)	Bereitstellungsgruppenbezeichner.
machineCount	integer (int32)	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.

DeploymentGroupCreateParameter

Objekt

Eigenschaften zum Erstellen einer Bereitstellungsgruppe.

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungsgruppe.
name	string	Name der Bereitstellungsgruppe.
poolId	integer (int32)	Bezeichner des Bereitstellungspools, in dem Bereitstellungs-Agents registriert sind.

DeploymentMachine

Objekt

Bereitstellungsziel.

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

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.

JObject

Objekt

Stellt ein JSON-Objekt dar.

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

JToken

Objekt

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 (JContainer)	Dient zum Abrufen oder Festlegen des übergeordneten Elements.
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 (JTokenType)	Ruft den Knotentyp für dieses JToken ab.

PackageVersion

Objekt

Name	Typ	Beschreibung
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

ProjectReference

Objekt

Name	Typ	Beschreibung
id	string (uuid)
name	string

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.

TaskAgent

Objekt

Ein Task-Agent.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
accessPoint	string	Der Zugriffspunkt dieses Agents.
assignedAgentCloudRequest	TaskAgentCloudRequest	Die Agent-Cloudanforderung, die derzeit diesem Agent zugeordnet ist.
assignedRequest	TaskAgentJobRequest	Die Anforderung, die derzeit diesem Agent zugewiesen ist.
authorization	TaskAgentAuthorization	Autorisierungsinformationen für diesen Agent.
createdOn	string (date-time)	Datum, an dem dieser Agent erstellt wurde.
enabled	boolean	Gibt an, ob dieser Agent Aufträge ausführen soll.
id	integer (int32)	Bezeichner des Agents.
lastCompletedRequest	TaskAgentJobRequest	Die letzte Anforderung, die von diesem Agent abgeschlossen wurde.
maxParallelism	integer (int32)	Maximale Auftragsparallelität für diesen Agent zulässig.
name	string	Name des Agents.
osDescription	string	Agentbetriebssystem.
pendingUpdate	TaskAgentUpdate	Ausstehendes Update für diesen Agent.
properties	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.
provisioningState	string	Bereitstellungsstatus dieses Agents.
status	TaskAgentStatus	Gibt an, ob der Agent online ist.
statusChangedOn	string (date-time)	Datum, an dem die letzte Änderung des Verbindungsstatus aufgetreten ist.
systemCapabilities	object	Vom Host dieses Agents unterstützte systemdefinierte Funktionen. Warnung: Zum Festlegen von Funktionen, die die PUT-Methode verwenden, überschreibt PUT die vorhandenen Funktionen vollständig.
userCapabilities	object	Benutzerdefinierte Funktionen, die vom Host dieses Agents unterstützt werden. Warnung: Zum Festlegen von Funktionen, die die PUT-Methode verwenden, überschreibt PUT die vorhandenen Funktionen vollständig.
version	string	Agentversion.

TaskAgentAuthorization

Objekt

Stellt Daten bereit, die zum Autorisieren des Agents mithilfe von OAuth 2.0-Authentifizierungsflüssen erforderlich sind.

Name	Typ	Beschreibung
authorizationUrl	string	Endpunkt, der zum Abrufen von Zugriffstoken vom konfigurierten Tokendienst verwendet wird.
clientId	string (uuid)	Client-ID für diesen Agent.
publicKey	TaskAgentPublicKey	Öffentlicher Schlüssel, der verwendet wird, um die Identität dieses Agents zu überprüfen.

TaskAgentCloudRequest

Objekt

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

TaskAgentJobRequest

Objekt

Eine Auftragsanfrage für einen Agenten.

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

TaskAgentPoolOptions

Enumeration

Zusätzliche Pooleinstellungen und Details

Wert	Beschreibung
elasticPool	TaskAgentPool unterstützt durch den Elastic Pool-Dienst
none
preserveAgentOnJobFailure	Auf "true" festgelegt, wenn Agents nach einem TaskAgentJobRequest-Fehler zur Untersuchung gehalten werden
singleUseAgents	Auf "true" festgelegt, wenn Agents nach jedem TaskAgentJobRequest neu imageiert werden

TaskAgentPoolReference

Objekt

Name	Typ	Beschreibung
id	integer (int32)
isHosted	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieser Pool vom Dienst verwaltet wird.
isLegacy	boolean	Bestimmt, ob der Pool legacy ist.
name	string
options	TaskAgentPoolOptions	Zusätzliche Pooleinstellungen und Details
poolType	TaskAgentPoolType	Dient zum Abrufen oder Festlegen des Typs des Pools.
scope	string (uuid)
size	integer (int32)	Ruft die aktuelle Größe des Pools ab.

TaskAgentPoolType

Enumeration

Dient zum Abrufen oder Festlegen des Typs des Pools.

Wert	Beschreibung
automation	Ein typischer Pool von Aufgaben-Agents
deployment	Ein Bereitstellungspool

TaskAgentPublicKey

Objekt

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

Name	Typ	Beschreibung
exponent	string[] (byte)	Dient zum Abrufen oder Festlegen des Exponenten für den öffentlichen Schlüssel.
modulus	string[] (byte)	Dient zum Abrufen oder Festlegen des Moduls für den öffentlichen Schlüssel.

TaskAgentReference

Objekt

Ein Verweis auf einen Agent.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
accessPoint	string	Der Zugriffspunkt dieses Agents.
enabled	boolean	Gibt an, ob dieser Agent Aufträge ausführen soll.
id	integer (int32)	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

Enumeration

Gibt an, ob der Agent online ist.

Wert	Beschreibung
offline
online

TaskAgentUpdate

Objekt

Details zu einem Agent-Update.

Name	Typ	Beschreibung
currentState	string	Aktueller Status dieses Agentupdates.
reason	TaskAgentUpdateReason	Grund für dieses Update.
requestTime	string (date-time)	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

Objekt

Name	Typ	Beschreibung
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration

Wert	Beschreibung
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
id	integer (int32)
name	string

TaskResult

Enumeration

Das Ergebnis dieser Anforderung.

Wert	Beschreibung
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

Freigeben über

Deploymentgroups - Add

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Create a deployment group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Demand

DeploymentGroup

DeploymentGroupCreateParameter

DeploymentMachine

IdentityRef

JObject

JToken

PackageVersion

ProjectReference

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentJobRequest

TaskAgentPoolOptions

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult