Deploymentgroups - Get

Odwołanie

Usługa:: Distributed Task

Wersja interfejsu API:: 7.1

Pobierz grupę wdrożenia według jej identyfikatora.

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1

Z parametrami opcjonalnymi:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=7.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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
$expand	query		DeploymentGroupExpands	Uwzględnij te dodatkowe szczegóły w zwróconym obiekcie.
actionFilter	query		DeploymentGroupActionFilter	Pobierz grupę wdrożenia tylko wtedy, gdy można wykonać tę akcję.

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	Umożliwia zarządzanie grupami wdrożeń i pulami agentów

Przykłady

Get a deployment group by its ID

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "machines": [],
  "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 wdrożeń.
DeploymentGroupActionFilter	Pobierz grupę wdrożenia tylko wtedy, gdy można wykonać tę akcję.
DeploymentGroupExpands	Uwzględnij te dodatkowe szczegóły w zwróconym obiekcie.
DeploymentMachine	Cel wdrożenia.
IdentityRef
JObject	Reprezentuje obiekt JSON.
JToken	Reprezentuje abstrakcyjny token JSON.
PackageVersion
ProjectReference
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z `TypeCode != TypeCode.Object`), z wyjątkiem `DBNull`. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
TaskAgent	Agent zadań.
TaskAgentAuthorization	Udostępnia dane niezbędne do autoryzowania agenta przy użyciu przepływów uwierzytelniania OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest	Żądanie zadania dla agenta.
TaskAgentPoolOptions	Dodatkowe ustawienia i szczegóły puli
TaskAgentPoolReference
TaskAgentPoolType	Pobiera lub ustawia typ puli
TaskAgentPublicKey	Reprezentuje część klucza publicznego klucza asymetrycznego RSA.
TaskAgentReference	Odwołanie do agenta.
TaskAgentStatus	Niezależnie od tego, czy agent jest w trybie online.
TaskAgentUpdate	Szczegółowe informacje o aktualizacji agenta.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Wynik tego żądania.

Demand

Objekt

Nazwa	Typ	Opis
name	string
value	string

DeploymentGroup

Objekt

Grupa wdrożeń.

Nazwa	Typ	Opis
description	string	Opis grupy wdrożenia.
id	integer (int32)	Identyfikator grupy wdrożenia.
machineCount	integer (int32)	Liczba obiektów docelowych wdrożenia w grupie wdrożenia.
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 wdrożenia.
pool	TaskAgentPoolReference	Pula wdrożeń, w której są zarejestrowani agenci wdrażania.
project	ProjectReference	Projekt, do którego należy grupa wdrażania.

DeploymentGroupActionFilter

Wyliczanie

Pobierz grupę wdrożenia tylko wtedy, gdy można wykonać tę akcję.

Wartość	Opis
manage	Tylko grupy wdrożeń, dla których obiekt wywołujący ma zarządzać uprawnieniami.
none	Wszystkie grupy wdrożeń.
use	Tylko grupy wdrożeń, dla których obiekt wywołujący ma używać uprawnień.

DeploymentGroupExpands

Wyliczanie

Uwzględnij te dodatkowe szczegóły w zwróconym obiekcie.

Wartość	Opis
machines	Przestarzałe: uwzględnij wszystkie cele wdrożenia.
none	Brak dodatkowych właściwości.
tags	Uwzględnij unikatową listę tagów we wszystkich miejscach docelowych wdrożenia.

DeploymentMachine

Objekt

Cel wdrożenia.

Nazwa	Typ	Opis
agent	TaskAgent	Agent wdrażania.
id	integer (int32)	Identyfikator docelowy wdrożenia.
properties	PropertiesCollection	Właściwości docelowego wdrożenia.
tags	string[]	Tagi docelowego wdrożenia.

IdentityRef

Objekt

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	Przestarzałe — można go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

JObject

Objekt

Reprezentuje obiekt JSON.

Nazwa	Typ	Opis
item	JToken	Reprezentuje abstrakcyjny token JSON.
type	string (JTokenType)	Pobiera typ węzła dla tego tokenu JToken.

JToken

Objekt

Reprezentuje abstrakcyjny token JSON.

Nazwa	Typ	Opis
first	JToken	Pobierz pierwszy podrzędny token tego tokenu.
hasValues	boolean	Pobiera wartość wskazującą, czy ten token ma tokeny podrzędne.
item	JToken	Reprezentuje abstrakcyjny token JSON.
last	JToken	Pobierz ostatni podrzędny token tego tokenu.
next	JToken	Pobiera następny token równorzędny tego węzła.
parent	string (JContainer)	Pobiera lub ustawia element nadrzędny.
path	string	Pobiera ścieżkę tokenu JSON.
previous	JToken	Pobiera poprzedni token równorzędny tego węzła.
root	JToken	Pobiera główny element JToken tego tokenu JToken.
type	string (JTokenType)	Pobiera typ węzła dla tego tokenu JToken.

PackageVersion

Objekt

Nazwa	Typ	Opis
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

ProjectReference

Objekt

Nazwa	Typ	Opis
id	string (uuid)
name	string

PropertiesCollection

Objekt

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

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

ReferenceLinks

Objekt

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

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

TaskAgent

Objekt

Agent zadań.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
accessPoint	string	Punkt dostępu tego agenta.
assignedAgentCloudRequest	TaskAgentCloudRequest	Żądanie w chmurze agenta, które jest obecnie skojarzone z tym agentem.
assignedRequest	TaskAgentJobRequest	Żądanie, które jest obecnie przypisane do tego agenta.
authorization	TaskAgentAuthorization	Informacje o autoryzacji dla tego agenta.
createdOn	string (date-time)	Data utworzenia tego agenta.
enabled	boolean	Określa, czy ten agent powinien uruchamiać zadania.
id	integer (int32)	Identyfikator agenta.
lastCompletedRequest	TaskAgentJobRequest	Ostatnie żądanie, które zostało ukończone przez tego agenta.
maxParallelism	integer (int32)	Maksymalna równoległość zadań dozwolona dla tego agenta.
name	string	Nazwa agenta.
osDescription	string	System operacyjny agenta.
pendingUpdate	TaskAgentUpdate	Oczekiwanie na aktualizację dla tego agenta.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z `TypeCode != TypeCode.Object`), z wyjątkiem `DBNull`. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
provisioningState	string	Stan aprowizacji tego agenta.
status	TaskAgentStatus	Niezależnie od tego, czy agent jest w trybie online.
statusChangedOn	string (date-time)	Data wystąpienia ostatniej zmiany stanu łączności.
systemCapabilities	object	Funkcje zdefiniowane przez system obsługiwane przez hosta tego agenta. Ostrzeżenie: Aby ustawić możliwości, użyj metody PUT, funkcja PUT całkowicie zastąpi istniejące możliwości.
userCapabilities	object	Możliwości zdefiniowane przez użytkownika obsługiwane przez hosta tego agenta. Ostrzeżenie: Aby ustawić możliwości, użyj metody PUT, funkcja PUT całkowicie zastąpi istniejące możliwości.
version	string	Wersja agenta.

TaskAgentAuthorization

Objekt

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

Nazwa	Typ	Opis
authorizationUrl	string	Punkt końcowy używany do uzyskiwania tokenów dostępu z skonfigurowanej usługi tokenu.
clientId	string (uuid)	Identyfikator klienta dla tego agenta.
publicKey	TaskAgentPublicKey	Klucz publiczny używany do weryfikowania tożsamości tego agenta.

TaskAgentCloudRequest

Objekt

Nazwa	Typ	Opis
agent	TaskAgentReference	Odwołanie do agenta.
agentCloudId	integer (int32)
agentConnectedTime	string (date-time)
agentData	JObject	Reprezentuje obiekt JSON.
agentSpecification	JObject	Reprezentuje obiekt JSON.
pool	TaskAgentPoolReference
provisionRequestTime	string (date-time)
provisionedTime	string (date-time)
releaseRequestTime	string (date-time)
requestId	string (uuid)

TaskAgentJobRequest

Objekt

Żądanie zadania dla agenta.

Nazwa	Typ	Opis
agentSpecification	JObject	Reprezentuje obiekt JSON.
assignTime	string (date-time)	Data/godzina przypisania tego żądania.
data	object	Dodatkowe dane dotyczące żądania.
definition	TaskOrchestrationOwner	Definicja potoku skojarzona z tym żądaniem
demands	Demand[]	Lista żądań wymaganych do spełnienia tego żądania.
finishTime	string (date-time)	Data/godzina zakończenia tego żądania.
hostId	string (uuid)	Host, który wyzwolił to żądanie.
jobId	string (uuid)	Identyfikator zadania wynikającego z tego żądania.
jobName	string	Nazwa zadania wynikającego z tego żądania.
lockedUntil	string (date-time)	Termin odnowienia blokady przez agenta.
matchedAgents	TaskAgentReference[]	Odwołanie do agenta.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	Potok skojarzony z tym żądaniem
planGroup	string
planId	string (uuid)	Wewnętrzny identyfikator planu aranżacji połączony z tym żądaniem.
planType	string	Szczegóły wewnętrzne reprezentujące typ planu aranżacji.
poolId	integer (int32)	Identyfikator puli, która jest przeznaczona dla tego żądania
priority	integer (int32)
queueId	integer (int32)	Identyfikator kolejki, która jest przeznaczona dla tego żądania
queueTime	string (date-time)	Data/godzina, w ramach którego to żądanie zostało w kolejce.
receiveTime	string (date-time)	Data/godzina, w ramach którego to żądanie zostało zwrócone przez agenta.
requestId	integer (int64)	Identyfikator żądania.
reservedAgent	TaskAgentReference	Agent przydzielony dla tego żądania.
result	TaskResult	Wynik tego żądania.
scopeId	string (uuid)	Zakres potoku; pasuje do identyfikatora projektu.
serviceOwner	string (uuid)	Usługa będąca właścicielem tego żądania.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Wyliczanie

Dodatkowe ustawienia i szczegóły puli

Wartość	Opis
elasticPool	Pula taskAgentPool wspierana przez usługę elastycznej puli
none
preserveAgentOnJobFailure	Ustaw wartość true, jeśli agenci są przetrzymywani w celu zbadania po niepowodzeniu taskAgentJobRequest
singleUseAgents	Ustaw wartość true, jeśli agenci są ponownie obrazowane po każdym zadaniu TaskAgentJobRequest

TaskAgentPoolReference

Objekt

Nazwa	Typ	Opis
id	integer (int32)
isHosted	boolean	Pobiera lub ustawia wartość wskazującą, czy ta pula jest zarządzana przez usługę.
isLegacy	boolean	Określa, czy pula jest starsza.
name	string
options	TaskAgentPoolOptions	Dodatkowe ustawienia i szczegóły puli
poolType	TaskAgentPoolType	Pobiera lub ustawia typ puli
scope	string (uuid)
size	integer (int32)	Pobiera bieżący rozmiar puli.

TaskAgentPoolType

Wyliczanie

Pobiera lub ustawia typ puli

Wartość	Opis
automation	Typowa pula agentów zadań
deployment	Pula wdrożeń

TaskAgentPublicKey

Objekt

Reprezentuje część klucza publicznego klucza asymetrycznego RSA.

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

TaskAgentReference

Objekt

Odwołanie do agenta.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
accessPoint	string	Punkt dostępu tego agenta.
enabled	boolean	Określa, czy ten agent powinien uruchamiać zadania.
id	integer (int32)	Identyfikator agenta.
name	string	Nazwa agenta.
osDescription	string	System operacyjny agenta.
provisioningState	string	Stan aprowizacji tego agenta.
status	TaskAgentStatus	Niezależnie od tego, czy agent jest w trybie online.
version	string	Wersja agenta.

TaskAgentStatus

Wyliczanie

Niezależnie od tego, czy agent jest w trybie online.

Wartość	Opis
offline
online

TaskAgentUpdate

Objekt

Szczegółowe informacje o aktualizacji agenta.

Nazwa	Typ	Opis
currentState	string	Bieżący stan tej aktualizacji agenta.
reason	TaskAgentUpdateReason	Przyczyna tej aktualizacji.
requestTime	string (date-time)	Data żądania tej aktualizacji.
requestedBy	IdentityRef	Tożsamość, która zażądała tej aktualizacji.
sourceVersion	PackageVersion	Wersja agenta źródłowego aktualizacji.
targetVersion	PackageVersion	Wersja agenta docelowego aktualizacji.

TaskAgentUpdateReason

Objekt

Nazwa	Typ	Opis
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Wyliczanie

Wartość	Opis
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Objekt

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

TaskResult

Wyliczanie

Wynik tego żądania.

Wartość	Opis
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

Udostępnij przez

Deploymentgroups - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Get a deployment group by its ID

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Demand

DeploymentGroup

DeploymentGroupActionFilter

DeploymentGroupExpands

DeploymentMachine

IdentityRef

JObject

JToken

PackageVersion

ProjectReference

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentJobRequest

TaskAgentPoolOptions

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult