Targets - Update

Reference

Service:: Task Agent

API Version:: 5.0-preview.1

Aktualizujte značky seznamu cílů nasazení ve skupině nasazení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deploymentGroupId	path	True	integer int32	ID skupiny nasazení, ve které se cíle nasazení aktualizují.
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 5.0-preview.1.

Text požadavku

Name	Typ	Description
body	DeploymentTargetUpdateParameter[]	Cíle nasazení se značkami pro udpdate.

Odpovědi

Name	Typ	Description
200 OK	DeploymentMachine[]	úspěšná operace

Zabezpečení

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	Description
vso.machinegroup_manage	Umožňuje spravovat skupiny nasazení a fondy agentů.

Příklady

Update tags of a deployment target

Sample Request

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
  }
]

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definice

Name	Description
Demand
DeploymentMachine	Cíl nasazení.
DeploymentTargetUpdateParameter	Parametr aktualizace cíle nasazení
IdentityRef
JObject
JToken
PackageVersion
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`výjimkou `DBNull` ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
ReferenceLinks	Třída představující kolekci odkazů REST.
TaskAgent
TaskAgentAuthorization	Poskytuje data potřebná pro autorizaci agenta pomocí toků ověřování OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Získá nebo nastaví typ fondu.
TaskAgentPublicKey	Představuje část veřejného klíče asymetrického klíče RSA.
TaskAgentReference
TaskAgentStatus	Získá aktuální stav připojení agenta.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Name	Typ	Description
name	string
value	string

DeploymentMachine

Cíl nasazení.

Name	Typ	Description
agent	TaskAgent	Agent nasazení.
id	integer	Identifikátor cíle nasazení.
tags	string[]	Značky cíle nasazení.

DeploymentTargetUpdateParameter

Parametr aktualizace cíle nasazení

Name	Typ	Description
id	integer	Identifikátor cíle nasazení.
tags	string[]

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

JObject

Name	Typ	Description
item	JToken
type	string

JToken

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

PackageVersion

Name	Typ	Description
major	integer
minor	integer
patch	integer

PropertiesCollection

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

Name	Typ	Description
count	integer	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

TaskAgent

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
accessPoint	string	Získá přístupový bod agenta.
assignedAgentCloudRequest	TaskAgentCloudRequest	Získá požadavek na cloud agenta, který je aktuálně přidružený k tomuto agentovi.
assignedRequest	TaskAgentJobRequest	Získá požadavek, který je aktuálně přiřazen tomuto agentovi.
authorization	TaskAgentAuthorization	Získá nebo nastaví informace o autorizaci pro tohoto agenta.
createdOn	string	Získá datum, kdy byl tento agent vytvořen.
enabled	boolean	Získá nebo nastaví hodnotu označující, zda by tento agent měl být povolen pro provádění úlohy.
id	integer	Získá identifikátor agenta.
lastCompletedRequest	TaskAgentJobRequest	Získá poslední požadavek, který byl dokončen tímto agentem.
maxParallelism	integer	Získá nebo nastaví maximální paralelismus úloh povolený na tomto hostiteli.
name	string	Získá název agenta.
oSDescription	string	Získá operační systém agenta.
pendingUpdate	TaskAgentUpdate	Získá čekající aktualizaci pro tohoto agenta.
properties	PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`výjimkou `DBNull` ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
provisioningState	string	Získá nebo nastaví aktuální stav zřizování tohoto agenta.
status	TaskAgentStatus	Získá aktuální stav připojení agenta.
statusChangedOn	string	Získá datum, kdy došlo k poslední změně stavu připojení.
systemCapabilities	object
userCapabilities	object
version	string	Získá verzi agenta.

TaskAgentAuthorization

Poskytuje data potřebná pro autorizaci agenta pomocí toků ověřování OAuth 2.0.

Name	Typ	Description
authorizationUrl	string	Získá nebo nastaví koncový bod použitý k získání přístupových tokenů z nakonfigurované služby tokenů.
clientId	string	Získá nebo nastaví identifikátor klienta pro tohoto agenta.
publicKey	TaskAgentPublicKey	Získá nebo nastaví veřejný klíč použitý k ověření identity tohoto agenta.

TaskAgentCloudRequest

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

TaskAgentDelaySource

Name	Typ	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Name	Typ	Description
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

Name	Typ	Description
id	integer
isHosted	boolean	Získá nebo nastaví hodnotu označující, zda je tento fond spravován službou.
name	string
poolType	TaskAgentPoolType	Získá nebo nastaví typ fondu.
scope	string
size	integer	Získá aktuální velikost fondu.

TaskAgentPoolType

Získá nebo nastaví typ fondu.

Name	Typ	Description
automation	string
deployment	string

TaskAgentPublicKey

Představuje část veřejného klíče asymetrického klíče RSA.

Name	Typ	Description
exponent	string[]	Získá nebo nastaví exponent pro veřejný klíč.
modulus	string[]	Získá nebo nastaví modul pro veřejný klíč.

TaskAgentReference

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
accessPoint	string	Získá přístupový bod agenta.
enabled	boolean	Získá nebo nastaví hodnotu označující, zda by tento agent měl být povolen pro provádění úlohy.
id	integer	Získá identifikátor agenta.
name	string	Získá název agenta.
oSDescription	string	Získá operační systém agenta.
provisioningState	string	Získá nebo nastaví aktuální stav zřizování tohoto agenta.
status	TaskAgentStatus	Získá aktuální stav připojení agenta.
version	string	Získá verzi agenta.

TaskAgentStatus

Získá aktuální stav připojení agenta.

Name	Typ	Description
offline	string
online	string

TaskAgentUpdate

Name	Typ	Description
currentState	string	Aktuální stav této aktualizace agenta
reason	TaskAgentUpdateReason	Důvod této aktualizace agenta
requestTime	string	Získá datum, kdy byla tato aktualizace agenta požadována.
requestedBy	IdentityRef	Identita, která vyžaduje aktualizaci agenta
sourceVersion	PackageVersion	Získá nebo nastaví verzi zdrojového agenta aktualizace agenta.
targetVersion	PackageVersion	Získá nebo nastaví cílovou verzi agenta aktualizace agenta.

TaskAgentUpdateReason

Name	Typ	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Name	Typ	Description
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
id	integer
name	string

TaskResult

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

Sdílet prostřednictvím