Targets - Update

Referenz

Dienst:: Task Agent

API-Version:: 5.0-preview.1

Aktualisieren sie Tags einer Liste von Bereitstellungszielen in einer Bereitstellungsgruppe.

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

URI-Parameter

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

Anforderungstext

Name	Typ	Beschreibung
body	DeploymentTargetUpdateParameter[]	Bereitstellungsziele mit Tags für udpdate.

Antworten

Name	Typ	Beschreibung
200 OK	DeploymentMachine[]	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	Ermöglicht die Verwaltung von Bereitstellungsgruppen und Agentpools

Beispiele

Update tags of a deployment target

Beispielanforderung

HTTP

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

[
  {
    "tags": [
      "db",
      "web",
      "newTag5248232320667898861"
    ],
    "id": 7
  },
  {
    "tags": [
      "db",
      "newTag5248232320667898861"
    ],
    "id": 6
  }
]

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 2,
  "value": [
    {
      "tags": [
        "db",
        "newTag5248232320667898861"
      ],
      "id": 6,
      "agent": {
        "_links": {
          "self": {
            "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/6"
          },
          "web": {
            "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=6"
          }
        },
        "maxParallelism": 1,
        "createdOn": "2018-02-19T09:23:58.267Z",
        "id": 6,
        "name": "demoTarget2",
        "version": "2.127.0",
        "osDescription": "Microsoft Windows 10.0.14393 ",
        "enabled": true,
        "status": "offline"
      }
    },
    {
      "tags": [
        "db",
        "newTag5248232320667898861",
        "web"
      ],
      "id": 7,
      "agent": {
        "_links": {
          "self": {
            "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7"
          },
          "web": {
            "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7"
          }
        },
        "maxParallelism": 1,
        "createdOn": "2018-02-19T09:26:48.11Z",
        "id": 7,
        "name": "demoTarget11",
        "version": "2.127.0",
        "osDescription": "Microsoft Windows 10.0.14393 ",
        "enabled": true,
        "status": "offline"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Demand
DeploymentMachine	Bereitstellungsziel.
DeploymentTargetUpdateParameter	Updateparameter für das Bereitstellungsziel.
IdentityRef
JObject
JToken
PackageVersion
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`) mit Ausnahme von `DBNull` werden akzeptiert. Werte vom Typ 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
TaskAgentAuthorization	Stellt Daten bereit, die für die Autorisierung des Agents mithilfe von OAuth 2.0-Authentifizierungsflows erforderlich sind.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
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
TaskAgentStatus	Ruft die aktuelle Konnektivität status des Agents ab.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Objekt

Name	Typ	Beschreibung
name	string
value	string

DeploymentMachine

Objekt

Bereitstellungsziel.

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

DeploymentTargetUpdateParameter

Objekt

Updateparameter für das Bereitstellungsziel.

Name	Typ	Beschreibung
id	integer	Bezeichner des Bereitstellungsziels.
tags	string[]

IdentityRef

Objekt

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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

JObject

Objekt

Name	Typ	Beschreibung
item	JToken
type	string

JToken

Objekt

Name	Typ	Beschreibung
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Objekt

Name	Typ	Beschreibung
major	integer
minor	integer
patch	integer

PropertiesCollection

Objekt

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) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ 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 Schlüsselsatz in der Auflistung.
values	string[]	Der Wertsatz in der Auflistung.

ReferenceLinks

Objekt

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

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint	string	Ruft den Zugriffspunkt des Agents ab.
assignedAgentCloudRequest	TaskAgentCloudRequest	Ruft die Agent-Cloudanforderung ab, die derzeit diesem Agent zugeordnet ist.
assignedRequest	TaskAgentJobRequest	Ruft die Anforderung ab, die diesem Agent derzeit zugewiesen ist.
authorization	TaskAgentAuthorization	Ruft die Autorisierungsinformationen für diesen Agent ab oder legt sie fest.
createdOn	string	Ruft das Datum ab, an dem dieser Agent erstellt wurde.
enabled	boolean	Ruft einen Wert ab, der angibt, ob dieser Agent für die Auftragsausführung aktiviert werden soll, oder legt diesen fest.
id	integer	Ruft den Bezeichner des Agents ab.
lastCompletedRequest	TaskAgentJobRequest	Ruft die letzte Anforderung ab, die von diesem Agent abgeschlossen wurde.
maxParallelism	integer	Ruft die maximale Auftragsparallelität ab, die auf diesem Host zulässig ist, oder legt diese fest.
name	string	Ruft den Namen des Agents ab.
oSDescription	string	Ruft das Betriebssystem des Agents ab.
pendingUpdate	TaskAgentUpdate	Ruft das ausstehende Update für diesen Agent ab.
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`) mit Ausnahme von `DBNull` werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
provisioningState	string	Ruft den aktuellen Bereitstellungsstatus dieses Agents ab oder legt diesen fest.
status	TaskAgentStatus	Ruft die aktuelle Konnektivität status des Agents ab.
statusChangedOn	string	Ruft das Datum ab, an dem die letzte Konnektivität status Änderung aufgetreten ist.
systemCapabilities	object
userCapabilities	object
version	string	Ruft die Version des Agents ab.

TaskAgentAuthorization

Objekt

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

Name	Typ	Beschreibung
authorizationUrl	string	Ruft den Endpunkt ab, der zum Abrufen von Zugriffstoken vom konfigurierten Tokendienst verwendet wird, oder legt diesen fest.
clientId	string	Ruft den Clientbezeichner für diesen Agent ab oder legt diesen fest.
publicKey	TaskAgentPublicKey	Ruft den öffentlichen Schlüssel ab, der zum Überprüfen der Identität dieses Agents verwendet wird, oder legt diesen fest.

TaskAgentCloudRequest

Objekt

Name	Typ	Beschreibung
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Objekt

Name	Typ	Beschreibung
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Objekt

Name	Typ	Beschreibung
agentDelays	TaskAgentDelaySource[]
agentSpecification	JObject
assignTime	string
data	object
definition	TaskOrchestrationOwner
demands	Demand[]
expectedDuration	string
finishTime	string
hostId	string
jobId	string
jobName	string
lockedUntil	string
matchedAgents	TaskAgentReference[]
orchestrationId	string
owner	TaskOrchestrationOwner
planGroup	string
planId	string
planType	string
poolId	integer
queueId	integer
queueTime	string
receiveTime	string
requestId	integer
reservedAgent	TaskAgentReference
result	TaskResult
scopeId	string
serviceOwner	string

TaskAgentPoolReference

Objekt

Name	Typ	Beschreibung
id	integer
isHosted	boolean	Ruft einen Wert ab, der angibt, ob dieser Pool vom Dienst verwaltet wird, oder legt diesen fest.
name	string
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

Enumeration

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

Wert	Beschreibung
automation
deployment

TaskAgentPublicKey

Objekt

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

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
accessPoint	string	Ruft den Zugriffspunkt des Agents ab.
enabled	boolean	Ruft einen Wert ab, der angibt, ob dieser Agent für die Auftragsausführung aktiviert werden soll, oder legt diesen fest.
id	integer	Ruft den Bezeichner des Agents ab.
name	string	Ruft den Namen des Agents ab.
oSDescription	string	Ruft das Betriebssystem des Agents ab.
provisioningState	string	Ruft den aktuellen Bereitstellungsstatus dieses Agents ab oder legt diesen fest.
status	TaskAgentStatus	Ruft die aktuelle Konnektivität status des Agents ab.
version	string	Ruft die Version des Agents ab.

TaskAgentStatus

Enumeration

Ruft die aktuelle Konnektivität status des Agents ab.

Wert	Beschreibung
offline
online

TaskAgentUpdate

Objekt

Name	Typ	Beschreibung
currentState	string	Der aktuelle Status dieses Agentupdates
reason	TaskAgentUpdateReason	Der Grund für dieses Agent-Update
requestTime	string	Ruft das Datum ab, an dem dieses Agent-Update angefordert wurde.
requestedBy	IdentityRef	Die Identität, die das Agentupdate anfordern
sourceVersion	PackageVersion	Ruft die Quell-Agent-Version des Agent-Updates ab oder legt sie fest.
targetVersion	PackageVersion	Ruft die Ziel-Agent-Version des Agentupdates ab oder legt sie fest.

TaskAgentUpdateReason

Objekt

Name	Typ	Beschreibung
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration

Wert	Beschreibung
manual
minAgentVersionRequired

TaskOrchestrationOwner

Objekt

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

TaskResult

Enumeration

Wert	Beschreibung
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

Freigeben über

Targets - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Update tags of a deployment target

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Demand

DeploymentMachine

DeploymentTargetUpdateParameter

IdentityRef

JObject

JToken

PackageVersion

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentDelaySource

TaskAgentJobRequest

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult