Udostępnij przez

Deploymentgroups - Add

  • Odwołanie
Usługa:
Task Agent
Wersja interfejsu API:
5.0-preview.1

Utwórz grupę wdrażania.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
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. Powinno to być ustawione na wartość "5.0-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa Typ Opis
description

string

Opis grupy wdrażania.
name

string

Nazwa grupy wdrażania.
poolId

integer

Identyfikator puli wdrożenia, w której są zarejestrowani agenci wdrożenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

DeploymentGroup

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa Opis
vso.machinegroup_manage Zapewnia możliwość zarządzania grupami wdrożeń i pulami agentów

Przykłady

Create a deployment group

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
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
  }
}

Definicje

Nazwa Opis
Demand
DeploymentGroup

Grupa wdrażania.
DeploymentGroupCreateParameter

Właściwości do utworzenia 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 (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull 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

Object
Nazwa Typ Opis
name

string

value

string

DeploymentGroup

Object

Grupa wdrażania.

Nazwa Typ Opis
description

string

Opis grupy wdrażania.
id

integer

Identyfikator grupy wdrożenia.
machineCount

integer

Liczba obiektów docelowych wdrożenia w grupie wdrażania.
machineTags

string[]

Lista unikatowych tagów we wszystkich miejscach docelowych wdrożenia w grupie wdrażania.
machines

DeploymentMachine[]

Lista obiektów docelowych wdrożenia w grupie wdrażania.
name

string

Nazwa grupy wdrażania.
pool

TaskAgentPoolReference

Pula wdrożeń, w której są zarejestrowani agenci wdrożenia.
project

ProjectReference

Projekt, do którego należy grupa wdrażania.

DeploymentGroupCreateParameter

Object

Właściwości do utworzenia grupy wdrożenia.

Nazwa Typ Opis
description

string

Opis grupy wdrażania.
name

string

Nazwa grupy wdrażania.
poolId

integer

Identyfikator puli wdrożenia, w której są zarejestrowani agenci wdrożenia.

DeploymentMachine

Object

Cel wdrożenia.

Nazwa Typ Opis
agent

TaskAgent

Agent wdrażania.
id

integer

Identyfikator docelowy wdrożenia.
tags

string[]

Tagi elementu docelowego wdrożenia.

IdentityRef

Object
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łowania 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 unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz 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

Object
Nazwa Typ Opis
item

JToken

type

string

JToken

Object
Nazwa Typ Opis
first

JToken

hasValues

boolean

item

JToken

last

JToken

next

JToken

parent

string

path

string

previous

JToken

root

JToken

type

string

PackageVersion

Object
Nazwa Typ Opis
major

integer

minor

integer

patch

integer

ProjectReference

Object
Nazwa Typ Opis
id

string

name

string

PropertiesCollection

Object

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull 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.
Object

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

Nazwa Typ Opis
links

object

Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

TaskAgent

Object
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 o 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 do 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 (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull 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

Object

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

Object
Nazwa Typ Opis
agent

TaskAgentReference

agentCloudId

integer

agentConnectedTime

string

agentData

JObject

agentSpecification

JObject

pool

TaskAgentPoolReference

provisionRequestTime

string

provisionedTime

string

releaseRequestTime

string

requestId

string

TaskAgentDelaySource

Object
Nazwa Typ Opis
delays

string[]

taskAgent

TaskAgentReference

TaskAgentJobRequest

Object
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

Object
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

Enumeration

Pobiera lub ustawia typ puli

Wartość Opis
automation
deployment

TaskAgentPublicKey

Object

Reprezentuje część klucza publicznego klucza asymetrycznego RSA.

Nazwa Typ Opis
exponent

string[]

Pobiera lub ustawia wykładnik klucza publicznego.
modulus

string[]

Pobiera lub ustawia modulu dla klucza publicznego.

TaskAgentReference

Object
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 do 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

Enumeration

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

Wartość Opis
offline
online

TaskAgentUpdate

Object
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

Object
Nazwa Typ Opis
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration
Wartość Opis
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object
Nazwa Typ Opis
_links

ReferenceLinks

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

integer

name

string

TaskResult

Enumeration
Wartość Opis
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues