Deploymentgroups - Update

Service:

Task Agent

API Version:

5.0-preview.1

Aktualizowanie grupy wdrożenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deploymentGroupId	path	True	integer int32	Identyfikator grupy wdrożenia.
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "5.0-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
description	string	Opis grupy wdrożenia.
name	string	Nazwa grupy wdrożenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DeploymentGroup	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.machinegroup_manage	Umożliwia zarządzanie grupami wdrożeń i pulami agentów

Przykłady

Update a deployment group

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-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
  }
}

Definicje

Nazwa	Opis
Demand
DeploymentGroup	Grupa wdrożenia.
DeploymentGroupUpdateParameter	Parametr aktualizacji grupy wdrożenia.
DeploymentMachine	Cel wdrożenia.
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
TaskAgent
TaskAgentAuthorization	Udostępnia dane niezbędne do autoryzowania agenta przy użyciu przepływów uwierzytelniania OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Pobiera lub ustawia typ puli
TaskAgentPublicKey	Reprezentuje część klucza publicznego klucza asymetrycznego RSA.
TaskAgentReference
TaskAgentStatus	Pobiera bieżący stan łączności agenta.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Nazwa	Typ	Opis
name	string
value	string

DeploymentGroup

Grupa wdrożenia.

Nazwa	Typ	Opis
description	string	Opis grupy wdrożenia.
id	integer	Identyfikator grupy wdrożenia.
machineCount	integer	Liczba obiektów docelowych wdrożenia w grupie wdrożenia.
machineTags	string[]	Lista unikatowych tagów we wszystkich miejscach docelowych wdrożenia w grupie wdrożenia.
machines	DeploymentMachine[]	Lista obiektów docelowych wdrożenia w grupie wdrażania.
name	string	Nazwa grupy wdrożenia.
pool	TaskAgentPoolReference	Pula wdrożeń, w której są zarejestrowani agenci wdrażania.
project	ProjectReference	Projekt, do którego należy grupa wdrożenia.

DeploymentGroupUpdateParameter

Parametr aktualizacji grupy wdrożenia.

Nazwa	Typ	Opis
description	string	Opis grupy wdrożenia.
name	string	Nazwa grupy wdrożenia.

DeploymentMachine

Cel wdrożenia.

Nazwa	Typ	Opis
agent	TaskAgent	Agent wdrażania.
id	integer	Identyfikator docelowy wdrożenia.
tags	string[]	Tagi docelowego wdrożenia.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

JObject

Nazwa	Typ	Opis
item	JToken
type	string

JToken

Nazwa	Typ	Opis
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Nazwa	Typ	Opis
major	integer
minor	integer
patch	integer

ProjectReference

Nazwa	Typ	Opis
id	string
name	string

PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

Nazwa	Typ	Opis
count	integer	Liczba właściwości w kolekcji.
item	object
keys	string[]	Zestaw kluczy w kolekcji.
values	string[]	Zestaw wartości w kolekcji.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

TaskAgent

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
accessPoint	string	Pobiera punkt dostępu agenta.
assignedAgentCloudRequest	TaskAgentCloudRequest	Pobiera żądanie w chmurze agenta, które jest obecnie skojarzone z tym agentem
assignedRequest	TaskAgentJobRequest	Pobiera żądanie, które jest obecnie przypisane do tego agenta.
authorization	TaskAgentAuthorization	Pobiera lub ustawia informacje autoryzacji dla tego agenta.
createdOn	string	Pobiera datę utworzenia tego agenta.
enabled	boolean	Pobiera lub ustawia wartość wskazującą, czy ten agent powinien być włączony na potrzeby wykonywania zadania.
id	integer	Pobiera identyfikator agenta.
lastCompletedRequest	TaskAgentJobRequest	Pobiera ostatnie żądanie, które zostało ukończone przez tego agenta.
maxParallelism	integer	Pobiera lub ustawia maksymalny równoległość zadań dozwolonych na tym hoście.
name	string	Pobiera nazwę agenta.
oSDescription	string	Pobiera system operacyjny agenta.
pendingUpdate	TaskAgentUpdate	Pobiera oczekującą aktualizację dla tego agenta.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
provisioningState	string	Pobiera lub ustawia bieżący stan aprowizacji tego agenta
status	TaskAgentStatus	Pobiera bieżący stan łączności agenta.
statusChangedOn	string	Pobiera datę wystąpienia ostatniej zmiany stanu łączności.
systemCapabilities	object
userCapabilities	object
version	string	Pobiera wersję agenta.

TaskAgentAuthorization

Udostępnia dane niezbędne do autoryzowania agenta przy użyciu przepływów uwierzytelniania OAuth 2.0.

Nazwa	Typ	Opis
authorizationUrl	string	Pobiera lub ustawia punkt końcowy używany do uzyskiwania tokenów dostępu ze skonfigurowanej usługi tokenu.
clientId	string	Pobiera lub ustawia identyfikator klienta dla tego agenta.
publicKey	TaskAgentPublicKey	Pobiera lub ustawia klucz publiczny używany do weryfikowania tożsamości tego agenta.

TaskAgentCloudRequest

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

TaskAgentDelaySource

Nazwa	Typ	Opis
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
id	integer
isHosted	boolean	Pobiera lub ustawia wartość wskazującą, czy ta pula jest zarządzana przez usługę.
name	string
poolType	TaskAgentPoolType	Pobiera lub ustawia typ puli
scope	string
size	integer	Pobiera bieżący rozmiar puli.

TaskAgentPoolType

Pobiera lub ustawia typ puli

Nazwa	Typ	Opis
automation	string
deployment	string

TaskAgentPublicKey

Reprezentuje część klucza publicznego klucza asymetrycznego RSA.

Nazwa	Typ	Opis
exponent	string[]	Pobiera lub ustawia wykładnik klucza publicznego.
modulus	string[]	Pobiera lub ustawia modulo dla klucza publicznego.

TaskAgentReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
accessPoint	string	Pobiera punkt dostępu agenta.
enabled	boolean	Pobiera lub ustawia wartość wskazującą, czy ten agent powinien być włączony na potrzeby wykonywania zadania.
id	integer	Pobiera identyfikator agenta.
name	string	Pobiera nazwę agenta.
oSDescription	string	Pobiera system operacyjny agenta.
provisioningState	string	Pobiera lub ustawia bieżący stan aprowizacji tego agenta
status	TaskAgentStatus	Pobiera bieżący stan łączności agenta.
version	string	Pobiera wersję agenta.

TaskAgentStatus

Pobiera bieżący stan łączności agenta.

Nazwa	Typ	Opis
offline	string
online	string

TaskAgentUpdate

Nazwa	Typ	Opis
currentState	string	Bieżący stan tej aktualizacji agenta
reason	TaskAgentUpdateReason	Przyczyna tej aktualizacji agenta
requestTime	string	Pobiera datę, w której zażądano tej aktualizacji agenta.
requestedBy	IdentityRef	Tożsamość, która żąda aktualizacji agenta
sourceVersion	PackageVersion	Pobiera lub ustawia wersję agenta źródłowego aktualizacji agenta
targetVersion	PackageVersion	Pobiera lub ustawia docelową wersję agenta aktualizacji agenta

TaskAgentUpdateReason

Nazwa	Typ	Opis
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nazwa	Typ	Opis
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
id	integer
name	string

TaskResult

Nazwa	Typ	Opis
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string